Joint Accounts

Open a Joint Account

POST /onboarding/applyForJointAccount

A joint account in a bank works like a regular bank account and is shared by two or more people.

These accounts can be created permanently, for example, an account between two family members or spouses where both can deposit their salaries.

It can also be created temporarily for a shorter period of time between two parties to collect funds.

Parameters	Type	Description	Required?
userId	String	Channel user id	Mandatory
mandate	Int	Singly Anyone or survivor	Mandatory
applicationForm	File	pdf image (default)	Mandatory
applicationFormType	string	pdf image (default)	Optional
primaryOwnerInfo	object
firstName	String	Full name	Mandatory
middleName	String	Middle name	Optional
lastName	String	Last name	Mandatory
idType	Int	ID type: 101 - National ID 102 - Alien ID 103 - Passport	Mandatory
idNumber	String	ID number	Mandatory
kraPin	String	Kra pin number	Mandatory
countryCode	String	Country code	Mandatory
mobile	String	Mobile number	Mandatory
email	String	Email address	Optional
idFrontSideFile	File	ID's front side pdf image (default)	Mandatory
idFrontSideFileType	string	pdf image (default)	Optional
idBackSideFile	File	pdf image (default)	Mandatory
idBackSideFileType	string	pdf image (default)	Optional
kraPinFile	File	pdf image (default)	Mandatory
kraPinFileType	string	pdf image (default)	Optional

Response

00000

{
  "onboardingRequestId": ""
}

Adding a joint account owner

POST /onboarding/addJointAccountOwner

This endpoint will be used to request the addition of joint account holders. Account holders will be added one at a time

This API can be called after the OTP has passed but before the onboarding request is approved.

Parameters

Parameters	Type	Description	Required?
onboardingRequestId	String	Onboarding request id	Mandatory
firstName	String	Full name	Mandatory
middleName	String	Middle name	Optional
lastName	String	Last name	Mandatory
idType	Int	101 - National ID 102 - Alien ID 103 - Passport	Mandatory
idNumber	String	Id number	Mandatory
kraPin	String	Kra pin number	Mandatory
countryCode	String	Country code	Mandatory
mobile	String	Mobile number	Mandatory
email	String	Email address	Optional
idFrontSideFile	File	Front side of the id Allow pdf and image	Mandatory
idFrontSideFileType	File	pdf/image, default image	Opyional
idBackSideFile	File	Allow pdf and image	Mandatory
idBackSideFileType	string	pdf/image, default image	Optional
kraPinFile	File	Allow pdf and image	Mandatory
kraPinFileType	string	pdf/image default image	Optional

Response

00000

{
  "memberId": "", returned for user to remove owner(s) in processing stage
}

Query joint account information

POST /onboarding/getJointAccountOnboardingInfo

Use this endpoint to get the onboarding information of the joint account that customer submitted.

Parameters

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

Response

00000

{
  "onboardingRequestId": "",//ID of request which customer submitted most recently
  "channel": "", //This is your channel ID
  "channelUserId": "", //The unique user identifier in your system
  "operatingMode": "", //1 (Singly) or 6 (Anyone or survivor)
  "status": "",
  "createTime": "", 
  "auditTime": "0", //0-Female; 1-Male
  "rejectReasonIds": "", //ISO 3166-2 country code
  "rejectReasonMsgs": "", //101-(Kenya) National ID; 102-(Kenya) Alien ID; 103-Passport
  "onboardingMediaInfos": [
        {
            "fileUrl": "",
            "mediaType": "",
            "contentType": "",
            "fileTypeId": "", //File type id，KYCFxxxxx
            "fileKey": "", //s3 file key
            "fileId": "",
        }
  ],
 "onboardingMediaInfos": [
        {
            "memberId": "", //ownerId
            "firstName": "", //First name of customer
            "middleName": "",//Middle name of customer
            "lastName": "", //Last Name of customer
            "fullName": "",
            "idType": "",
            "idNumber": "",
            "kraPin": "", //Kenya KRA PIN code or tax number from other countries
            "mobile": "",
            "email": "",
            "idFrontFileUrl": "",
            "idFrontFileType": "",
            "idFrontFile": "",
            "idBackFileUrl": "",
            "idBackFileType": "",
            "idBackFile": "",
            "kraPinFileUrl": "",
            "kraPinFileType": "", //File type, image/pdf
            "kraPinFile": "",
            "isPrimary": "", //Is primary owner，0：false，1：true
            "emailVerified": "", //0:unverify, 1:verified
            "mobileVerified": "", //0:unverify, 1:verified
        }
]