Customising Sandbox Test Data

As a Smile ID partner, you will interact with our system in two different environments - Sandbox and Production. The Sandbox environment enables you to test and try out our products using the test data we have provided, however you can not query any live ID authority databases or lists. The Production environment lets you run jobs using real ID information.
We provide you with ID numbers that cater to multiple scenarios, however there are times when you might want to customize the response we send back when you use our test data.
You can customise the test value returned for any of our standardised top level keys.
Customising the Response for Basic KYC and Enhanced KYC
Getting Started Checklist
To get started please take note of the following:
Identify the ID type you want to customise its data
Get the “custom-response” test ID number for your chosen ID type (note all custom-response test ID numbers end with a “4”). The test ID numbers for each ID type can be found on the documentation page dedicated to the ID type
Identify the top level keys typically returned for the ID type, the information can be found on the documentation page dedicated to the ID type
Decide which top level keys returned for the ID type you want to customise
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 object 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
{
    "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”
    json},
    "Source": "ID API",
    "signature": "---",
    "timestamp": "2021-03-07T13:23:24.591Z"
}
​
Customising the Response for Biometric KYC
To get successful Biometric KYC responses in Sandbox, the image returned using the test data must match the selfie supplied. This means the test data photo returned must be customised.
Getting Started Checklist
To get started please take note of the following:
Identify the ID type you want to customise its data
Get the “custom-response” test ID number for your chosen ID type (note all custom-response test ID numbers end with a “4”). The test ID numbers for each ID type can be found on the documentation page dedicated to the ID type
Identify the top level keys typically returned for the ID type, the information can be found on the documentation page dedicated to the ID type
In addition to the Photo key, identify other top level keys returned for the ID type you want to customise
Running a Successful Sandbox Biometric KYC Job with Custom Data
Add a "Photo" key and its base64 string along with other keys you intend to customize to the “partner_params” object when making an upload URL request. See JSON sample below
{
    "source_sdk": "rest_api",
    "source_sdk_version":"1.0",
    "file_name": "Archive.zip",
    "smile_client_id": "--",
    "signature": "--",
    "timestamp": "2021-03-07T13:23:24.591Z",
    "partner_params": {
       "user_id": "user_a1d60852-5d82-4875-ac40-c76c64e2593a",
       "job_id": "job_58627dfc-dc6b-4ce2-8dad-d906219c79b8",
       "job_type": 1,
       "Photo": "/9j/4AAQSkZJRgA- SAMPLE Base64 - LISOad5n1/OolQYz607YK/2Q=="
    },
"model_parameters": {},
 "callback_url": "webhook.example.site"
.
.
.
You can only use photos that are < 300kb (less than 300 kb) in size
If you are using the REST API, in your “info.json” file provide another base64 image string of the same person, but not the exact same image as using the exact same image will trigger a spoof and the job will be rejected.
If you are using one of the mobile SDKs you can skip the editing the info.json section.

Be sure to use “id_number” values from our provided test data for your test. Specifically, use the one ending in “4”
Your “info.json” file should look like this before it is zipped.
{
 "package_information": {
   "apiVersion": {
     "buildNumber": 0,
     "majorVersion": 2,
     "minorVersion": 0
   }
 },
 "id_info": {
   "dob": "",
   "country": "NG",
   "entered": true,
   "id_type": "NIN",
   "id_number": "00000000004",
   "last_name": "",
   "first_name": "",
   "middle_name": ""
 },
 "images": [
   {
     "image_type_id": 2,
     "image": "base64 encoded image string",
     "file_name": ""
   }
 ]
}
Test Data
ID Number Regex
Last modified 2mo ago