Cedar Partners API
  1. Onboarding
Cedar Partners API
  • Introduction
  • Getting Started
    • Data Model
    • Transaction Lifecycle
    • Authentication
    • API Environments
    • Webhooks Configuration
  • Development Tools
    • API Debugging
    • Error Codes
    • File URLs
  • API Documentation
    • Information
      • Get Countries
      • Get Currencies
    • Merchants
      • Create Merchant
      • Update Merchant
      • Get Merchant by ID
      • Get Merchants with Pagination
    • Onboarding
      • Onboarding Lifecycle
      • Get Legal Agreements
        GET
      • Accept Legal Agreements
        POST
      • Submit Merchant Onboarding
        POST
    • Receiver Accounts
      • Create Receiver Account
      • Update Receiver Account
      • Get Receiver Account by ID
      • Get Receiver Accounts with Pagination
    • Transactions
      • Payout (Crypto-to-Fiat)
        • Calculate FX Rate
        • Create Payout Transaction
        • Get Payout Transaction by ID
        • Get Payout Transactions with Pagination
        • Approve Payout Transaction Quote
        • Approve Payout Transaction Deposit
        • Cancel Payout Transaction
      • End to End (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create End to End Transaction
        • Get End to End Transaction by ID
        • Get End to End Transactions with Pagination
        • Approve End to End Transaction Quote
        • Approve End to End Transaction Deposit
        • Cancel End to End Transaction
      • Collections (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create Collections Transaction
        • Get Collections Transaction by ID
        • Get Collections Transactions with Pagination
        • Approve Collections Transaction Quote
        • Approve Collections Transaction Deposit
        • Cancel Collections Transaction
      • Get Payout Confirmation by Transaction ID
        GET
    • Utilities
      • Upload File
  1. Onboarding

Submit Merchant Onboarding

Live Partners API
https://partners-api.service.cedar.money/bpapi
Live Partners API
https://partners-api.service.cedar.money/bpapi
POST
https://partners-api.service.cedar.money/bpapi
/v1/business/submitOnboarding
Submit the full onboarding details and documents for a single merchant.
Once the onboarding details have been submitted successfully, the details cannot be updated until the compliance team has verified them and either approved them or requested for changes/additional details.

Request

Header Params

Body Params application/json

Example
{
    "businessId": 1,
    "businessData": {
        "companyType": "CORPORATION",
        "tradingName": "Example Trading Ltd.",
        "industry": "TECHNOLOGY",
        "service": "SOFTWARE_DEVELOPMENT",
        "numberOfEmployees": "FROM_10_TO_50",
        "description": "We provide digital payment infrastructure for SMEs.",
        "websiteUrl": "https://www.example.com",
        "sectorOfActivity": "TRADING_COMPANY",
        "countryIso": "US",
        "state": "California",
        "city": "San Francisco",
        "address": "Market St",
        "streetNumber": "123",
        "zipcode": "94103",
        "localRegNumber": "REG123456",
        "taxId": "TAX987654",
        "businessEstablishmentDate": 953891647000,
        "requestedCurrencySymbols": [
            "USD",
            "EUR"
        ],
        "destinationCountries": [
            "US",
            "GB",
            "DE"
        ],
        "totalExpectedMonthlyVolumeUsd": "5000000.0",
        "averageTransactionAmount": "FROM_20K_TO_50K",
        "expectedRecipients": [
            "Company A",
            "Company B",
            "Company B"
        ],
        "keyRecipientName": "Global Supplies Ltd.",
        "keyRecipientCountry": "GB",
        "keyRecipientIndustry": "MANUFACTURING"
    },
    "businessDocuments": {
        "legalFormationDocumentsUrl": "https://docs.example.com/legal-formation.pdf",
        "proofOfCompanyAddressUrl": "https://docs.example.com/address-proof.pdf",
        "memorandumAndArticlesOfAssociationUrl": "https://docs.example.com/memo-articles.pdf",
        "corporateCharterAndBylawsUrl": "https://docs.example.com/charter-bylaws.pdf",
        "ownershipStructureChartUrl": "https://docs.example.com/ownership-chart.pdf",
        "proofOfFundsUrl": "https://docs.example.com/proof-of-funds.pdf",
        "licensesAndPermitsUrl": "https://docs.example.com/licenses.pdf",
        "supportingDocumentsUrls": [
            "https://docs.example.com/supp1.pdf",
            "https://docs.example.com/supp2.pdf"
        ]
    },
    "businessPersons": [
        {
            "firstName": "Alice",
            "lastName": "Smith",
            "idNumber": "ID123456",
            "nationality": "US",
            "dateOfBirth": 953891647000,
            "address": "456 Elm St, New York, NY",
            "phoneNumberPrefix": "+1",
            "phoneNumber": "5551234567",
            "email": "alice.smith@example.com",
            "ownershipPercentage": "40",
            "socialMediaUrl": "https://linkedin.com/in/alicesmith",
            "bvn": "12345678901",
            "proofOfAddressUrl": "https://docs.example.com/alice-address.pdf",
            "driversLicenseUrl": "https://docs.example.com/alice-license.pdf",
            "passportUrl": "https://docs.example.com/alice-passport.pdf",
            "nationalIdUrl": "https://docs.example.com/alice-id.pdf",
            "supportingDocumentsUrls": [
                "https://docs.example.com/alice-extra1.pdf"
            ]
        }
    ],
    "businessDirectors": [
        {
            "firstName": "Bob",
            "lastName": "Johnson",
            "idNumber": "ID654321",
            "nationality": "US",
            "dateOfBirth": 953891647000,
            "address": "789 Pine St, Chicago, IL",
            "bvn": "10987654321",
            "proofOfAddressUrl": "https://docs.example.com/bob-address.pdf",
            "driversLicenseUrl": "https://docs.example.com/bob-license.pdf",
            "passportUrl": "https://docs.example.com/bob-passport.pdf",
            "nationalIdUrl": "https://docs.example.com/bob-id.pdf",
            "directorsCacUrl": "https://docs.example.com/bob-cac.pdf",
            "supportingDocumentsUrls": [
                "https://docs.example.com/bob-extra.pdf"
            ]
        }
    ],
    "relatedCompanies": [
        {
            "name": "Acme Ventures Inc.",
            "address": "100 Venture Blvd, Austin, TX",
            "localRegNumber": "ACME987654",
            "companyType": "PUBLIC",
            "industry": "TECHNOLOGY",
            "service": "SOFTWARE_DEVELOPMENT",
            "supportingDocumentsUrls": [
                "https://docs.example.com/acme-support1.pdf"
            ]
        }
    ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://partners-api.service.cedar.money/bpapi/v1/business/submitOnboarding' \
--header 'x-api-key: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed' \
--header 'x-api-secret: CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB' \
--header 'Content-Type: application/json' \
--data-raw '{
    "businessId": 1,
    "businessData": {
        "companyType": "CORPORATION",
        "tradingName": "Example Trading Ltd.",
        "industry": "TECHNOLOGY",
        "service": "SOFTWARE_DEVELOPMENT",
        "numberOfEmployees": "FROM_10_TO_50",
        "description": "We provide digital payment infrastructure for SMEs.",
        "websiteUrl": "https://www.example.com",
        "sectorOfActivity": "TRADING_COMPANY",
        "countryIso": "US",
        "state": "California",
        "city": "San Francisco",
        "address": "Market St",
        "streetNumber": "123",
        "zipcode": "94103",
        "localRegNumber": "REG123456",
        "taxId": "TAX987654",
        "businessEstablishmentDate": 953891647000,
        "requestedCurrencySymbols": [
            "USD",
            "EUR"
        ],
        "destinationCountries": [
            "US",
            "GB",
            "DE"
        ],
        "totalExpectedMonthlyVolumeUsd": "5000000.0",
        "averageTransactionAmount": "FROM_20K_TO_50K",
        "expectedRecipients": [
            "Company A",
            "Company B",
            "Company B"
        ],
        "keyRecipientName": "Global Supplies Ltd.",
        "keyRecipientCountry": "GB",
        "keyRecipientIndustry": "MANUFACTURING"
    },
    "businessDocuments": {
        "legalFormationDocumentsUrl": "https://docs.example.com/legal-formation.pdf",
        "proofOfCompanyAddressUrl": "https://docs.example.com/address-proof.pdf",
        "memorandumAndArticlesOfAssociationUrl": "https://docs.example.com/memo-articles.pdf",
        "corporateCharterAndBylawsUrl": "https://docs.example.com/charter-bylaws.pdf",
        "ownershipStructureChartUrl": "https://docs.example.com/ownership-chart.pdf",
        "proofOfFundsUrl": "https://docs.example.com/proof-of-funds.pdf",
        "licensesAndPermitsUrl": "https://docs.example.com/licenses.pdf",
        "supportingDocumentsUrls": [
            "https://docs.example.com/supp1.pdf",
            "https://docs.example.com/supp2.pdf"
        ]
    },
    "businessPersons": [
        {
            "firstName": "Alice",
            "lastName": "Smith",
            "idNumber": "ID123456",
            "nationality": "US",
            "dateOfBirth": 953891647000,
            "address": "456 Elm St, New York, NY",
            "phoneNumberPrefix": "+1",
            "phoneNumber": "5551234567",
            "email": "alice.smith@example.com",
            "ownershipPercentage": "40",
            "socialMediaUrl": "https://linkedin.com/in/alicesmith",
            "bvn": "12345678901",
            "proofOfAddressUrl": "https://docs.example.com/alice-address.pdf",
            "driversLicenseUrl": "https://docs.example.com/alice-license.pdf",
            "passportUrl": "https://docs.example.com/alice-passport.pdf",
            "nationalIdUrl": "https://docs.example.com/alice-id.pdf",
            "supportingDocumentsUrls": [
                "https://docs.example.com/alice-extra1.pdf"
            ]
        }
    ],
    "businessDirectors": [
        {
            "firstName": "Bob",
            "lastName": "Johnson",
            "idNumber": "ID654321",
            "nationality": "US",
            "dateOfBirth": 953891647000,
            "address": "789 Pine St, Chicago, IL",
            "bvn": "10987654321",
            "proofOfAddressUrl": "https://docs.example.com/bob-address.pdf",
            "driversLicenseUrl": "https://docs.example.com/bob-license.pdf",
            "passportUrl": "https://docs.example.com/bob-passport.pdf",
            "nationalIdUrl": "https://docs.example.com/bob-id.pdf",
            "directorsCacUrl": "https://docs.example.com/bob-cac.pdf",
            "supportingDocumentsUrls": [
                "https://docs.example.com/bob-extra.pdf"
            ]
        }
    ],
    "relatedCompanies": [
        {
            "name": "Acme Ventures Inc.",
            "address": "100 Venture Blvd, Austin, TX",
            "localRegNumber": "ACME987654",
            "companyType": "PUBLIC",
            "industry": "TECHNOLOGY",
            "service": "SOFTWARE_DEVELOPMENT",
            "supportingDocumentsUrls": [
                "https://docs.example.com/acme-support1.pdf"
            ]
        }
    ]
}'

Responses

🟢200OK
application/json
Body

Example
{
    "id": 1,
    "creationTime": 1741003185214,
    "lastUpdateTime": 1741003185214,
    "name": "Company Name",
    "localRegNumber": "123456789",
    "countryIso": "NG",
    "address": "Akanu Ibiam Rd",
    "zipcode": "12345",
    "kycStatus": "PENDING_REVIEW",
    "contactName": "John Doe",
    "contactEmail": "john@company.com",
    "contactPhone": "1234567890",
    "contactPhonePrefix": "234",
    "streetNumber": "12",
    "city": "Umuahia",
    "state": "AB",
    "industry": "AGRICULTURE_FORESTRY_WILDLIFE"
}
🟠400Error
Modified at 2025-06-03 13:52:55
Previous
Accept Legal Agreements
Next
Create Receiver Account
Built with