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
Nigeria
NG
TIN
00000000-0000
Nigeria
NG
CAC
0000000
🇿🇦
South Africa
ZA
NATIONAL_ID
0000000000000
South Africa
ZA
NATIONAL_ID_NO_PHOTO
0000000000000
🇺🇬
Uganda
UG
NATIONAL_ID_NO_PHOTO
00000000000000

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

How to use the custom meta data return feature

Most of the options using test data will return the same meta data and image every time you access them. In order to test your business logic built around the evaluation of the data we return, or testing our facial verification outcomes, you will need to specify what is being returned by the api call. To use this feature, first run a test where the final digit of the test id number is 0 in order to learn which values you would like to replace. Check the FullData section of the response to see which keys correspond to the values you would like to replace. Then send another request where the final digit of the ID number is 4, and in the partner_params section of the request, add those keys with the values you would like to be returned.

Step 1

Example request:
1
{
2
"sec_key": "dv1hmt2IpnhFn5jy|zgkod8hk+lZh",
3
"partner_params": {
4
"user_id": "1",
5
"job_id": "1",
6
"job_type": 5
7
},
8
"id_number": "00000000000",
9
"country": "NG",
10
"id_type": "BVN",
11
"timestamp": 1579641236,
12
"partner_id": "002"
13
}
Copied!
Example response:
1
{
2
"JSONVersion": "1.0.0",
3
"SmileJobID": "0000000001",
4
"PartnerParams": {
5
"user_id": "887ceeea-e9fd-4f96-aa58-d4b12d0b5f98",
6
"job_id": "985c594e-7e67-4f2e-a6e0-3be127dbb6a0",
7
"job_type": 5
8
},
9
"ResultType": "ID Verification",
10
"ResultText": "ID Number Validated",
11
"ResultCode": "1012",
12
"IsFinalResult": "true",
13
"Actions": {
14
"Verify_ID_Number": "Verified",
15
"Return_Personal_Info": "Returned"
16
},
17
"Country": "NG",
18
"IDType": "BVN",
19
"IDNumber": "00000000000",
20
"ExpirationDate": "Not Available",
21
"FullName": "Doe Joe Leo",
22
"DOB": "2000-01-20",
23
"Photo": <base 64 string>,
24
"PhoneNumber": "12345678900",
25
"Gender": "Male",
26
"Address": "10, Workbox, Ojora Close, Victoria Island, Lagos, Victoria Island, Lagos State",
27
"FullData": {
28
"watchListed": "No",
29
"enrollmentBranch": "...",
30
"stateOfOrigin": "Lagos State",
31
"stateOfResidence": "Lagos State",
32
"Gender": "Male",
33
"title": " ",
34
"nin": "00000000000",
35
"nameOnCard": "Doe Joe Leo",
36
"LevelOfAccount": "Level 2 - Medium Level Accounts",
37
"registrationDate": "",
38
"email": "...",
39
"DateOfBirth": "20-January-2000",
40
"FirstName": "Doe",
41
"PhoneNumber2": "",
42
"PhoneNumber1": "12345678900",
43
"MiddleName": "Joe",
44
"ImageBase64": <base 64 string>,
45
"lgaOfResidence": "Victoria Island",
46
"nationality": "Nigeria",
47
"lgaOfOrigin": "...",
48
"residentialAddress": "10, Workbox, Ojora Close, Victoria Island, Lagos",
49
"enrollmentBank": "000",
50
"BVN": "00000000000",
51
"LastName": "Leo",
52
"maritalStatus": "Single",
53
"success": true
54
},
55
"Source": "ID API",
56
"sec_key": "pgVQGn0bs9lcZXK|bO+1x4gG8XKLy",
57
"timestamp": 1593727494844
58
}
Copied!

Step 2

Find the relevant keys for the values you want to change. In this example I want to specify the name and photo to be returned.
Find the exact keys in the FullData section of the values you want to replace

Step 3

Example request:
1
{
2
"sec_key": "dv1hmt2IpnhFn5jyzg|kod8hk+lZhxe",
3
"partner_params": {
4
"user_id": "887ceeea-e9fd-4f96-aa58-d4b12d0b5f98",
5
"job_id": "985c594e-7e67-4f2e-a6e0-3be127dbb6a0",
6
"job_type": 5,
7
"FirstName": "SMILE",
8
"MiddleName": "IDENTITY",
9
"LastName": "EMPLOYEE",
10
"ImageBase64": <Your base64 image>
11
},
12
"id_number": "00000000004",
13
"country": "NG",
14
"id_type": "BVN",
15
"timestamp": 1579641236,
16
"partner_id": "002"
17
}
Copied!
Example response:
1
{
2
"JSONVersion": "1.0.0",
3
"SmileJobID": "0000000001",
4
"PartnerParams": {
5
"user_id": "1",
6
"job_id": "1",
7
"job_type": 5,
8
"FirstName": "SMILE",
9
"MiddleName": "IDENTITY",
10
"LastName": "EMPLOYEE",
11
"ImageBase64": <Your base64 image>
12
},
13
"ResultType": "ID Verification",
14
"ResultText": "ID Number Validated",
15
"ResultCode": "1012",
16
"IsFinalResult": "true",
17
"Actions": {
18
"Verify_ID_Number": "Verified",
19
"Return_Personal_Info": "Returned"
20
},
21
"Country": "NG",
22
"IDType": "BVN",
23
"IDNumber": "00000000004",
24
"ExpirationDate": "Not Available",
25
"FullName": "SMILE IDENTITY EMPLOYEE",
26
"DOB": "2000-01-20",
27
"Photo": <Your base64 image>,
28
"PhoneNumber": "12345678900",
29
"Gender": "Male",
30
"Address": "10, Workbox, Ojora Close, Victoria Island, Lagos, Victoria Island, Lagos State",
31
"FullData": {
32
"watchListed": "No",
33
"enrollmentBranch": "...",
34
"stateOfOrigin": "Lagos State",
35
"stateOfResidence": "Lagos State",
36
"Gender": "Male",
37
"title": " ",
38
"nin": "00000000000",
39
"nameOnCard": "Doe Joe Leo",
40
"LevelOfAccount": "Level 2 - Medium Level Accounts",
41
"registrationDate": "",
42
"email": "...",
43
"DateOfBirth": "20-January-2000",
44
"FirstName": "SMILE",
45
"PhoneNumber2": "",
46
"PhoneNumber1": "12345678900",
47
"MiddleName": "IDENTITY",
48
"ImageBase64": <Your base64 image>,
49
"lgaOfResidence": "Victoria Island",
50
"nationality": "Nigeria",
51
"lgaOfOrigin": "...",
52
"residentialAddress": "10, Workbox, Ojora Close, Victoria Island, Lagos",
53
"enrollmentBank": "000",
54
"BVN": "00000000000",
55
"LastName": "EMPLOYEE",
56
"maritalStatus": "Single",
57
"success": true
58
},
59
"Source": "ID API",
60
"sec_key": "ubIDmC1SvfJ+Tlx1X|3FPYsqCOHh",
61
"timestamp": 1593729211112
62
}
Copied!
Note: not all possible outcomes are included in these Simulated Results — For example, using an ID from a country we don’t support would result in an "Unsupported ID Type and/or Country” result. A full list of possible ID related result codes can be found in the Result Codes and Result Texts section under each Product that uses IDs.
Last modified 22d ago