Onboarding

Create a new client

POST /onboarding/v3/submitEasyOnboardingRequest

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

Parameters

Parameters	Type	Description	Is Required
userId	string	A unique string to identify the user in the partner 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	Base 64 string	TRUE
backSidePhoto	string	Base 64 string When idType==101, this is required; When idType==102, this is required; When idType==103, this is NOT required;	FALSE
selfiePhoto	string	Base 64 string	TRUE

Response

00000

{
  "onboardingRequestId": "ONBOARD7695534567876"
}

Others

{
  "code": "12005",
  "msg": "Invalid signature"
}

Query onboarding status

POST /onboarding/getOnboardingStatus

<Use this endpoint to query the onboarding status>

Parameters

Parameters	Type	Description	Is Required
userId	string	The unique string to identify the user in the partner system.	FALSE
onboardingRequestId	string	The unique onboarding request id that was returned from Choice system.	FALSE
mobile	string	The mobile number that the customer is using to onboard. Use either one from userId / onboardingRequestId / mobile to query the onboarding status.	FALSE

Response

00000

{
  "onboardingRequestId": "ONBOARD2309LKSD90432",
  "onboardingStatus": "Completed successfully"
}

Others

{
 "code": "12005",
 "msg": "Invalid signature"
}

Query client KYC information

POST /onboarding/getUserKyc

<Use this endpoint to get the KYC information and its status>

Parameters

Parameters	Type	Description	Is 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

{
 "code": "12005",
 "msg": "Invalid signature"
}

Query client KYC media information

POST /onboarding/personal/getKycMediaList

<Use this endpoint to get client's kyc media information>

Parameters

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

Response

00000

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

Others

{
 "code": "12005",
 "msg": "Invalid signature"
}

Query client onboarding request ID

POST /onboarding/getOnboardingRequestId

<This endpoint allows you to get client's onboardingRequestId using its user ID or mobile number>

Parameters

Parameters	Type	Description	Is Required
userId	string	The unique string to identify the user in the partner system.	FALSE
mobile	string	User's mobile number / The mobile number that the user used to onboard	FALSE

Response

00000

{
  "onboardingRequestId": ""
}