Onboard

Create a new wallet

POST /onboarding/v3/submitEasyOnboardingRequest

<Use this endpoint to onboard a new client and submit its kyc information>

Parameters

Parameters	Type	Description	Required?
userId	string	Unique string what identifies the user in your system	TRUE
firstName	string	First name of the onboarding customer	TRUE
middleName	string	middle name of the onboarding customer	FALSE
lastName	string	last name of the onboarding customer	TRUE
birthday	string	Date of Birth; yyyy-mm-dd	TRUE
gender	integer	0 - Female 1 - Male	TRUE
countryCode	string	The country code of the mobile, that the customer is using to onboard	TRUE
mobile	string	The mobile number that the customer is using to onboard	TRUE
idType	string	Type of the document that the customer is using to onboard. 101 - (Kenya) National ID 102 - (Kenya) Alien ID 103 - Passport	TRUE
idNumber	string	ID Number of National ID/Passport/Alien ID	TRUE
address	string	Physical address of the onboarding customer	FALSE
kraPin	string	KRA PIN / Tax Number	FALSE
email	string	Email address of the customer	FALSE
frontSidePhoto	string	Base64 string representation of Front side of ID document	TRUE
backSidePhoto	string	Base64 string representation of back side of ID document	TRUE
selfiePhoto	string	Base 64 string	TRUE

Response

00000

{
  "onboardingRequestId": ""
}

Others

Query onboarding status

POST /onboarding/getOnboardingStatus

Once you have initiated the onboarding, you can call this endpoint at any point to query its status.

NOTE: You must pass at a non-null value for at least one of these three parameters.

Parameters

Parameters	Type	Description	Required?
userId	string	Unique string what identifies the user in your system	FALSE
onboardingRequestId	string	Unique onboarding request ID that we assigned	FALSE
mobile	string	Mobile number end-user onboarded with	FALSE

Response

00000

{
  "onboardingRequestId": "ONBOARD2309LKSD90432",
  "onboardingStatus": "", //integer
  "rejectionReasonId": "", //refer to Onboarding Failure Definition
  "rejectionReasonMsg": "", //refer to Onboarding Failure Definition
  "accountId": "", //account number
  "accountType": "", //refer to Account Type definition
}

Others

Query KYC information

POST /onboarding/getUserKyc

Use this endpoint to get the KYC information/details you submitted as well the onboarding status.

Parameters

Parameters	Type	Description	Required?
onboardingRequestId	string	The unique onboarding request id that was returned from Choice system.	TRUE

Response

00000

{
  "onboardingRequestId": "ONBOARD2309LKSD90432",
  "baasChannelId": "", //This is your channel ID
  "userId": "", //The unique user identifier in your system
  "firstName": "Lily",
  "middleName": "IMISA",
  "lastName": "WAMBUI",
  "gender": "0", //0-Female; 1-Male;
  "nationality": "Kenya",
  "idType": "", //101-(Kenya) National ID; 102-(Kenya) Alien ID; 103-Passport
  "idNumber": "",
  "birthday": "",
  "address": "",
  "countryCode": "", //country code for mobile number
  "mobile": "",
  "employmentStatus": "", //Please refer to Employment Status Enumeration
  "monthlyIncome": "", //Please refer to Monthly Income Enumeration
  "kraPin": "", //Kenya KRA PIN code or tax number from other countries
  "businessIndustry": "",
  "specifyIndustry": "",
  "profileCheck": "", //0-Not Checked; 1-Submitted; 2-Validated; 3-Declined; 4-Processing;
  "profileCheckResultCode": "",
  "profileCheckResultText": "",
  "createTime": "",
  "updateTime": "",
  "status": "", //1-Submitted; 2-Processing; 3-Passed; 4-Rejected; 
  //5-Account Closed; 9-Manual Reviewing
}

Others

Query KYC media

POST /onboarding/personal/getKycMediaList

Use this endpoint to get a list of the KYC media files you uploaded.

Parameters

Parameters	Type	Description	Required?
onboardingRequestId	string	The unique onboarding request id that was returned from Choice system.	TRUE

Response

00000

{
    "mediaList": [
        {    
            "mediaType": "",
            "fileTypeId": "",
            "mediaUrl": "",
        }, {}    
    ]
}

Others

Query onboarding request ID

POST /onboarding/getOnboardingRequestId

Use this endpoint to get the end-user's onboardingRequestId using either the userId (if unique) or mobile you passed.

NOTE: You must pass a non-null value for at least one of these two parameters.

Parameters

Parameters	Type	Description	Required?
userId	string	Unique string what identifies the user in your system	FALSE
mobile	string	Mobile number end-user used to onboard	FALSE

Response

00000

{
  "onboardingRequestId": ""
}