Test Data
Real ID numbers can only be used in the production environment. To gain access to the production environment please complete the steps outlined in the section Submit Your Company KYC. Then follow the simple steps outlined in the section Go Live.
Below we also provide ID test data that allows you to run an unlimited number of tests in the sandbox environment. The test data will have the same JSON structure as the production environment. To test error conditions you can modify the final digit in the id number. All the id types follow the format in the table below, but the final digit determines what response is received.
Test data is only available for use in the Sandbox. If test data is used in Production an error will be returned with ResultCode 1014 and the ResultText as "Unsupported ID number format".
Country
Country Code
id_type
Format
🇬🇭
Ghana
GH
DRIVERS_LICENSE
B0000000
Ghana
GH
PASSPORT
G0000000
Ghana
GH
SSNIT
C000000000000
Ghana
GH
VOTER_ID
0000000000
Ghana
GH
NEW_VOTER_ID
0000000000
🇰🇪
Kenya
KE
ALIEN_CARD
000000
Kenya
KE
NATIONAL_ID
00000000
Kenya
KE
PASSPORT
A00000000
🇳🇬
Nigeria
NG
BVN
00000000000
Nigeria
NG
NIN
00000000000
Nigeria
NG
NIN_SLIP
00000000000
Nigeria
NG
DRIVERS_LICENSE
ABC000000000
Nigeria
NG
VOTER_ID
0000000000000000000
Nigeria
NG
PHONE_NUMBER
00000000000
🇿🇦
South Africa
ZA
NATIONAL_ID
0000000000000

How to use the test data

To test various outcomes, change the final digit of the id_number to attain the desired outcome.
There are four Simulated Results to test your integration:
Final Digit
Simulated Result
Result Code
0
Success w/ meta-data return
1012
1
Failure, no record found
1013
2
Invalid ID number format
1014
3
Database unavailable/unknown network issue
1015
4
Success w/ custom meta-data return
1012

Customising ID Test Data Response Values

You can customise our ID test data response fields in Sandbox. This means that you can specify the value we return for some specific fields in the Sandbox environment for our supported id types e.g. you can state that you want Nelson Mandela returned as the full name for Nigerian Driver’s License. Customising test data response is especially useful when testing different textual matching scenarios for our Identity Verification product or getting a successful response for Enhanced KYC + SmartSelfie™. You can return a custom value for any of our standardised top level keys for any of our supported ID types.

Getting Started Checklist

To get started please take note of the following:
  • You have identified the ID type you want to customise its data
  • You know the custom-response test ID number for your chosen ID type (note all custom-response test ID numbers ends with a “4”), the test ID numbers available for an ID type can be found on the documentation page dedicated to the ID type
  • You have confirmed the top level keys typically returned for the ID type, the information can be found on the documentation page dedicated to the ID type
  • You have selected the top level keys you want to return values, please take note of the exact spelling of the keys. The full list of top level keys and their spelling can be found below:
Top Level Key
Description
Example
FullName
Full name of ID owner
"Leo Doe Joe"
Gender
Gender of ID owner
"Male"
DOB
Date of birth of ID owner
"2000-09-20"
PhoneNumber
Phone number of ID owner
"12345678900"
PhoneNumber2
Second phone number of ID owner (when available)
"12345678900"
Address
Address of ID owner
“221B Baker Street”
ExpirationDate
Expiration date of the ID card
"2021-08-15"
Photo
Photo of ID owner on file in the ID authority database
- - - base64 Encoded String- - -
You can only use photos that are < 300kb in size in Sandbox

Running a Job with a Custom Data Request

Once you have all the items above, you can proceed to run the sandbox job with a custom request. To customise the value of any fields, you need to specify the top level key in the partner params section of the request body.

Sample Request for an Enhanced KYC ran with Custom Data

{
"signature": "---",
"partner_params": {
"user_id": "887ceeea-e9fd-4f96-aa58-d4b12d0b5f98",
"job_id": "985c594e-7e67-4f2e-a6e0-3be127dbb6a0",
"job_type": 5,
"FullName": "Nelson Mandela",
},
"id_number": "00000000004",
"country": "NG",
"id_type": ​​"NIN",
"timestamp": 2021-03-07T13:23:24.591Z,
"partner_id": "--"
}

Response Based on Request

{
"JSONVersion": "1.0.0",
"SmileJobID": "0000000164",
"PartnerParams": {
"user_id": "887ceeea-e9fd-4f96-aa58-d4b12d0b5f98",
"job_id": "985c594e-7e67-4f2e-a6e0-3be127dbb6a0",
"job_type": 5,
"FullName": "Nelson Mandela",
"FirstName": "Nelson",
"MiddleName": "",
"LastName": "Mandela"
},
"ResultType": "ID Verification",
"ResultText": "ID Number Validated",
"ResultCode": "1012",
"IsFinalResult": "true",
"Actions": {
"Verify_ID_Number": "Verified",
"Return_Personal_Info": "Returned"
},
"Country": "NG",
"IDType": "NIN",
"IDNumber": "00000000004",
"ExpirationDate": "Not Available",
"FullName": "Nelson Mandela",
"DOB": "2000-09-20",
"Photo": "/9j/4AAQSk --- truncated",
"PhoneNumber": "0123456789",
"PhoneNumber2": "Not Available",
"Document": "Not Available",
"Gender": "Male",
"Address": "10, Workbox, Ojora Close, Victoria Island, Lagos, Lagos Island, Lagos",
"FullData": {
"birthdate": "2000-09-20",
"nin": "00000000000",
"telephoneno": "0123456789",
"othername": "",
"nspokenlang": "YORUBA",
"state": "",
"height": "****",
"trackingId": "",
"profession": "STUDENT",
"nok_firstname": "Joe",
"residencestatus": "birth",
"self_origin_state": "",
"residence_state": "Lagos",
"nok_state": "Lagos",
"nok_middlename": "",
"self_origin_lga": "",
"nationality": "Nigeria",
"maritalstatus": "single",
"success": true,
"nok_lga": "Lagos Island",
"maidenname": "",
"firstname": "Nelson",
"gender": "Male",
"pmiddlename": "",
"title": "mr",
"pfirstname": "",
"nok_lastname": "Leo",
"employmentstatus": "",
"surname": "Mandela",
"place": "Victoria Island",
"email": "",
"educationallevel": "tertiary",
"birthcountry": "Not Available",
"nok_address2": "10, Workbox, Ojora Close, Victoria Island, Lagos",
"nok_address1": "10, Workbox, Ojora Close, Victoria Island, Lagos",
"nok_postalcode": "",
"middlename": "",
"photo": "/9j/4AAQSk---”,
"message": "Results Found",
"ospokenlang": "",
"centralID": "",
"documentno": "",
"self_origin_place": "",
"birthstate": "",
"psurname": "",
"nok_town": "Lagos",
"residence_lga": "Lagos Island",
"residence_AddressLine2": "10, Workbox, Ojora Close, Victoria Island, Lagos",
"residence_AddressLine1": "10, Workbox, Ojora Close, Victoria Island, Lagos",
"residence_town": "Lagos State",
"FullName": "Nelson Mandela",
"FirstName": "Nelson",
"MiddleName": "",
"LastName": "Mandela"
},
"Source": "ID API",
"signature": "---",
"timestamp": "2021-03-07T13:23:24.591Z"
}