Start Onboarding

Use this endpoint to initiate customer onboarding

Initiate Onboard Request

POST /onboard

Before you can start verifying customer identity, you need to initiate an onbording request, and later on use the returned onboarding request id to verify customer identity through a series of question and answers from the NIDA.

Headers

Name
Type
Description

authorization*

string

Bearer authorization token to authenticate the request

x-request-id*

string

A unique id identifying this request

{
  "id": "lS2Ju1biJuug",
  "applicationId": "bFo7zV0eG8rz",
  "nin": "XXXXXXXXXXXXXXX",
  "cardIssueDate": "2010-01-19T00:00:00.000Z",
  "cardExpiryDate": "2024-06-20T00:00:00.000Z",
  "phoneNumber": "2557183987655",
  "email": "john.doe@example.com",
  "status": "Created",
  "kycCompleted": 0,
  "accountNo": null,
  "accountName": null,
  "customerNo": null,
  "kyc": null,
  "partnerReference": null,
  "requestId": "17f36ae9-c9ef-4908-b151-50d3aad08b7b",
  "createdAt": "2024-08-02T08:05:52.000Z",
  "updatedAt": "2024-08-02T08:05:52.000Z"
}

PreviouseKYCNextRetrieve First Question

Last updated