Submit Merchant Onboarding - Cedar Partners API

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

x-api-key

string

required

Example:

CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed

x-api-secret

string

required

Example:

CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB

Body Params application/json

businessId

integer

required

The id of the merchant to submit the onboarding for

businessData

object

required

General merchant onboarding details

companyType

enum<string>

required

The merchant's company type

Allowed values:

CORPORATIONSOLE_PROPRIETORSHIPPUBLIC

tradingName

string

optional

The merchant's trading (public) name

industry

enum<string>

optional

The industry the merchant is active in

Allowed values:

AGRICULTURE_FORESTRY_WILDLIFEBUSINESS_INFORMATIONCONSTRUCTION_UTILITIES_CONTRACTINGEDUCATIONFINANCE_INSURANCEFOOD_HOSPITALITYGAMINGHEALTH_SERVICESMOTOR_VEHICLENATURAL_RESOURCES_ENVIRONMENTALPERSONAL_SERVICESREAL_ESTATE_HOUSINGSAFETY_SECURITY_LEGALTRANSPORTATIONGARMENTSPHARMACEUTICALSTECHNOLOGYMANUFACTURINGENTERTAINMENTTELECOMMUNICATIONS

service

enum<string>

optional

The service the merchant is providing in that industry

Allowed values:

PESTICIDES_HERBICIDESLIVESTOCKCROPSFISHING_EQUIPMENTHUNTING_GEARLANDSCAPE_DESIGN_SERVICESLAWN_MAINTENANCE_EQUIPMENTCONSULTING_SERVICESRECRUITMENT_STAFFING_SOLUTIONSFUNDRAISING_TOOLSCRM_SOFTWAREADVERTISING_MARKETING_SERVICESCLOUD_COMPUTING_SOLUTIONSECOMMERCE_PLATFORMSPUBLICATION_PRINTING_SERVICESHVAC_SYSTEMSARCHITECTURAL_DESIGN_SERVICESCONSTRUCTION_EQUIPMENTSAFETY_INSPECTION_SERVICESCONCRETE_CEMENT_SUPPLIESENGINEERING_CONSULTINGTOOL_EQUIPMENT_RENTALPLUMBING_FIXTURES_EQUIPMENTHOME_REMODELING_SERVICESCHILDCARE_PROGRAMSHIGHER_EDUCATION_COURSESBEAUTY_COSMETOLOGY_TRAININGK12_EDUCATIONAL_MATERIALSPRIVATE_TUTORING_SERVICESREAL_ESTATE_LICENSING_COURSESVOCATIONAL_TRAININGFINANCIAL_PLANNING_SERVICESAUDIT_COMPLIANCE_SERVICESBANKING_SOLUTIONSINSURANCE_PRODUCTSINVESTMENT_OPPORTUNITIESLOAN_MORTGAGE_SERVICESTAX_PREPARATION_SOFTWAREALCOHOLIC_BEVERAGESBAKERY_GOODSCATERING_SERVICESFOOD_PROCESSING_EQUIPMENTGROCERY_SUPPLYHOSPITALITY_MANAGEMENT_SOFTWARERESTAURANT_BAR_SUPPLIESGAMING_CONSOLES_ACCESSORIESCASINO_EQUIPMENTSPORTS_BETTING_SERVICESEVENT_TICKET_MANAGEMENT_SOLUTIONSMEDICAL_DENTAL_EQUIPMENTWELLNESS_PROGRAMSMEDICAL_PRACTICE_MANAGEMENT_SOFTWAREPHARMACEUTICAL_PRODUCTSHOME_HEALTH_CARE_SUPPLIESVETERINARY_PRODUCTSREHABILITATION_TOOLSAUTOMOTIVE_PARTS_ACCESSORIESVEHICLE_CLEANING_PRODUCTSRENTAL_LEASING_SERVICESAUTOMOTIVE_REPAIR_SERVICESNEW_USED_VEHICLESENVIRONMENTAL_CONSULTINGSURVEY_EQUIPMENTOIL_GAS_EXTRACTION_TOOLSPIPELINE_MAINTENANCE_REPAIR_SERVICESWATER_TREATMENT_SOLUTIONSBEAUTY_PERSONAL_CARE_PRODUCTSEVENT_PARTY_SUPPLIESPERSONAL_TRAINING_GYM_SERVICESPHOTOGRAPHY_EQUIPMENT_SERVICESCLEANING_MAINTENANCE_SERVICESPROPERTY_INSPECTION_SERVICESINTERIOR_DESIGN_SERVICESPREFABRICATED_HOUSINGREAL_ESTATE_CRM_SYSTEMSPROPERTY_MANAGEMENT_SERVICESLEGAL_CONSULTATION_SERVICESBAIL_BOND_SERVICESSECURITY_EQUIPMENTPRIVATE_INVESTIGATION_SERVICESCYBERSECURITY_SOLUTIONSAIR_SEA_CARGO_SERVICESLUXURY_TRANSPORTATION_SERVICESPUBLIC_TRANSPORT_SOLUTIONSTOWING_EQUIPMENTFUEL_ENERGY_SOLUTIONSCLOTHING_MANUFACTURINGTEXTILE_PRODUCTIONFASHION_DESIGNRETAIL_CLOTHING_SALESFABRIC_DYEING_PRINTINGGARMENT_EXPORT_SERVICESQUALITY_CONTROL_SERVICESDRUG_MANUFACTURINGCLINICAL_RESEARCHPHARMACEUTICAL_MARKETINGREGULATORY_AFFAIRSPHARMACY_SERVICESBIOTECH_RESEARCHMEDICAL_DEVICE_PRODUCTIONSOFTWARE_DEVELOPMENTIT_CONSULTINGCYBERSECURITY_SERVICESDATA_ANALYTICSCLOUD_COMPUTINGNETWORK_INFRASTRUCTUREAI_MACHINE_LEARNING_SOLUTIONSPRODUCT_DESIGN_PROTOTYPINGQUALITY_ASSURANCE_TESTINGASSEMBLY_LINE_PRODUCTIONSUPPLY_CHAIN_MANAGEMENTEQUIPMENT_MAINTENANCEPACKAGING_DISTRIBUTIONINVENTORY_MANAGEMENTFILM_PRODUCTIONMUSIC_RECORDINGEVENT_MANAGEMENTTALENT_AGENCY_SERVICESTHEATER_PRODUCTIONSDIGITAL_CONTENT_CREATIONMEDIA_BROADCASTINGMOBILE_NETWORK_SERVICESINTERNET_SERVICE_PROVISIONVOIP_SERVICESCABLE_TELEVISION_SERVICESSATELLITE_COMMUNICATIONSTELECOM_EQUIPMENT_SALESCUSTOMER_SUPPORT_SERVICES

description

string

required

The merchant's description. For example: We provide digital payment infrastructure for SMEs.

localRegNumber

string

required

The merchant's local registration number of the company.

taxId

string

required

The merchant's Tax ID

numberOfEmployees

enum<string>

required

The merchant's number of employees in the company

Allowed values:

UNDER_10FROM_10_TO_50FROM_50_TO_250OVER_250

websiteUrl

string

optional

The merchant's public website URL

sectorOfActivity

enum<string>

required

The merchant's business focus

Allowed values:

TRADING_COMPANYFREIGHT_FORWARDERIMPORTEREXPORTEROTHER

countryIso

string

required

The merchant's address country ISO2 (For example: NG)

state

string

optional

The merchant's address state

city

string

required

The merchant's address city

address

string

required

The merchant's street address

streetNumber

string

optional

The merchant's address street number

zipcode

string

optional

The merchant's address zip

businessEstablishmentDate

integer

required

The merchant's establishment date in UNIX timestamp

requestedCurrencySymbols

array[string]

required

List of currency ISO3 of the requested currencies. For example: EUR, USD

destinationCountries

array[string]

required

List of country ISO2 of destination countries. For example: NG, US

totalExpectedMonthlyVolumeUsd

string

required

The total expected monthly volume through Cedar's system

averageTransactionAmount

enum<string>

required

The average transaction amount through Cedar's system

Allowed values:

UNDER_5KFROM_5K_TO_20KFROM_20K_TO_50KFROM_50K_TO_100KFROM_100K_TO_500KFROM_500K_TO_1MFROM_1M_TO_2MOVER_2M

expectedRecipients

array[string]

required

List of company names that are expected to be recipients for the merchant's transactions

keyRecipientName

string

optional

Name of a key recipient company

keyRecipientCountry

string

optional

The country ISO2 of the key recipient

keyRecipientIndustry

enum<string>

optional

The industry of the key recipient

Allowed values:

businessDocuments

object

required

Onboarding documents for the merchant

legalFormationDocumentsUrl

string

required

URL of business registration document file

proofOfCompanyAddressUrl

string

required

URL of proof of company address file

memorandumAndArticlesOfAssociationUrl

string

optional

URL of memorandum and articles of association file

corporateCharterAndBylawsUrl

string

optional

URL of corporate charter and bylaws file

ownershipStructureChartUrl

string

optional

URL of ownership structure chart file

proofOfFundsUrl

string

required

URL of proof of funds file

licensesAndPermitsUrl

string

optional

URL of license and permits file

supportingDocumentsUrls

array[string]

optional

Additional merchant documents relevant for the onboarding process

businessPersons

array [object {17}]

required

Merchant list of UBOs

firstName

string

required

The UBO's first name

lastName

string

required

The UBO's last name

idNumber

string

required

The UBO's ID number

nationality

string

required

The UBO's nationality country ISO2 (For example: US)

dateOfBirth

integer

required

The UBO's date of birth in UNIX timestamp

address

string

optional

Full address of the UBO

phoneNumberPrefix

string

required

The UBO's telephone country code - Digits only

phoneNumber

string

required

The UBO's telephone - Digits only

string

required

The UBO's email

ownershipPercentage

string

optional

Ownership percentage in the company of the UBO

socialMediaUrl

string

optional

URL of a social media profile of the UBO (Facebook, Instagram...)

bvn

string

optional

The UBO's BVN (Bank Verification Number). Required only for nationality NG (Nigeria)

proofOfAddressUrl

string

optional

URL of proof of address file

driversLicenseUrl

string

optional

URL of drivers license file

passportUrl

string

optional

URL of passport file

nationalIdUrl

string

required

URL of national ID file

supportingDocumentsUrls

array[string]

optional

Additional UBO documents relevant for the onboarding process

businessDirectors

array [object {13}]

required

Merchant list of directors

firstName

string

required

The director's first name

lastName

string

required

The director's last name

idNumber

string

required

The director's ID number

nationality

string

required

The director's nationality country ISO2 (For example: US)

dateOfBirth

integer

optional

The director's date of birth in UNIX timestamp

address

string

optional

Full address of the director

bvn

string

optional

The director's BVN (Bank Verification Number). Required only for nationality NG (Nigeria)

proofOfAddressUrl

string

optional

URL of proof of address file

driversLicenseUrl

string

optional

URL of drivers license file

passportUrl

string

optional

URL of passport file

nationalIdUrl

string

required

URL of national ID file

directorsCacUrl

string

optional

URL of directors CAC file

supportingDocumentsUrls

array[string]

optional

Additional director documents relevant for the onboarding process

relatedCompanies

array [object {7}]

required

Merchant list of related companies

name

string

required

The related company name

address

string

required

Full company address

localRegNumber

string

required

Local registration number of the related company

companyType

enum<string>

required

The company type

Allowed values:

CORPORATIONSOLE_PROPRIETORSHIPPUBLIC

industry

enum<string>

required

The industry the company is active in

Allowed values:

service

enum<string>

required

The service the company is providing in that industry

Allowed values:

supportingDocumentsUrls

array[string]

optional

Additional related company documents relevant for the onboarding process

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

integer

required

The merchant's ID

creationTime

integer

required

The entity creation time in UNIX timestamp

lastUpdateTime

integer

required

The entity last update time in UNIX timestamp

name

string

required

The merchant's name

localRegNumber

string

required

Local registration number

countryIso

string

required

The merchant's country ISO2

state

string

optional

The merchant's state ISO2

city

string

optional

The merchant's address city

address

string

optional

The merchant's street address

streetNumber

string

optional

The merchant's address street number

zipcode

string

optional

The merchant's address zipcode

kycStatus

enum<string>

required

The current KYC verification status of the merchant

Allowed values:

NEWVALIDPENDINGPENDING_REVIEWFLAGGEDUNDER_REVIEWACTION_NEEDEDABANDONED

contactName

string

optional

The merchant's contact person full name

contactEmail

string

optional

The merchant's contact person email

contactPhonePrefix

string

optional

The merchant's contact person telephone country code

contactPhone

string

optional

The merchant's contact person telephone

industry

enum<string>

optional

The merchant's industry

Allowed values:

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