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 | DRIVERS_LICENSE | 00000000 |
Kenya | KE | KRA_PIN | 00000000 |
Kenya | KE | NATIONAL_ID | 00000000 |
Kenya | KE | NATIONAL_ID_NO_PHOTO | 00000000 |
Kenya | KE | PASSPORT | A00000000 |
| | 🇳🇬 | |
Nigeria | NG | BVN | 00000000000 |
Nigeria | NG | NIN_V2 | 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 |
South Africa | ZA | NATIONAL_ID_NO_PHOTO | 0000000000000 |
| | 🇺🇬 | |
Uganda | UG | NATIONAL_ID_NO_PHOTO | 00000000000000 |
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 | 1012 |
Last modified 11d ago