HOhoneycoin

Individual Customer Onboarding

Changed on

This API endpoint allows the upload of individual customer data required for KYC processes. This data is essential for opening virtual accounts, issuing virtual cards, and other financial services.

post/api/b2b/customers/{customerId}/onboarding

Request

  • Base URL
    https://api-v2.honeycoin.app
  • URL
    https://api-v2.honeycoin.app/api/b2b/customers/{customerId}/onboarding
  • Auth
    API key in header Authorization

Path parameters

customerIdstring required

Request body

dobstring required

Must be a valid iso format

taxNumberstring required

The customer's tax identification number. Must be a valid image url.

taxDocumentUrlstring required

The customer's tax document url. Must be a valid image url.

documentTypestring required

national-id or passport

photoFrontUrlstring required

Front image of the passport or national-id document. Must be a valid image url.

photoBackUrlstring

Back image of the national id. Only required when documentType is national-id. Must be a valid image url.

selfieVideoUrlstring required

A selfie video of the customer. Must be a valid video url.

documentNumberstring required

The customer's identification number.

genderstring required

"M" or "F"

monthlyIncomeinteger required

Will be assumed to be in the currency of the customer account. e.g KES.

phoneNumberstring required

E-164 format e.g +254712345678

employmentStatusstring required

Employee, Self employed, Unemployed, Employer or Student

stepstring required

Must be set to individualKYC

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Successfully uploaded data."
}

Changes