Alien Card
Last updated
Last updated
Input | Value |
---|---|
All fields are returned as string
To limit the probability of your user mistyping the id number, we advice that you enforce the format of the id number field in your app. You can use the regex below:
/^[0-9]{6,9}$/
The Kenya alien card can be used on any of the following products:
For the supported integration options, you can check the integration options supported by each product here.
To test the Kenya alien card in our Sandbox, we provide you with 5 different id numbers to mirror various scenarios you can experience with real IDs in production.
* to get a successful Biometric KYC, you will need to pass a custom photo. You can read more about customising the PII response in sandbox in our documentation here.
Response Field | Value Returned |
---|---|
ID Number | Result | Result Code |
---|---|---|
Country
YES
IDType
YES
IDNumber
YES
ExpirationDate
N/A
FullName
YES
DOB
YES
Photo
NO
PhoneNumber
NO
PhoneNumber2
NO
Document
NO
Gender
YES
Address
YES
000000
Success with PII return
1012
000001
Failure, no record found
1013
000002
Invalid ID number format
1014
000003
Database unavailable/unknown network issue
1015
000004*
Success with custom PII return
1012
country
KE
id_type
ALIEN_CARD
id_number
Alien card number