Java

Installation

View the package on Maven and the open source code on Github.

Add the group, name and version to your application's build file, it will look similar based on your build tool:

group: "com.smileidentity", name: "smile-identity-core", version: "version-number"

The following classes exist for use:

import smile.identity.core.PartnerParameters;
import smile.identity.core.IDParameters;
import smile.identity.core.IDApi;

Please note that the ID API class is available in versions >= 1.0.1.

Copy this code and replace sections marked with <>

submit_job method

Your call to the library will be similar to the below code snippet:

try {
PartnerParameters partnerParameters = new PartnerParameters(<String user_id>, <String job_id>, <Integer 5>);
// Note: you may set the optional parameters for the specific ID Type to null.
IDParameters idInfo = new IDParameters(<String firstName>, <String middleName>, <String lastName>, <String country>, <String idType>, <String idNumber>, <String dob>, <String phoneNumber>);
IDApi connection = new IDApi(<String partner_id>, <String decoded_version_of_api_key>, <Integer 0 || 1>);
String response = connection.submit_job(partnerParameters.get(), idInfo.get());
} catch(Exception e) {
throw e;
}

Example Response Body

Your response will return a JSON String containing the below:

{
"JSONVersion":"1.0.0",
"SmileJobID":"0000001105",
"PartnerParams":{
"user_id":"T6yzdOezucdsPrY0QG9LYNDGOrC",
"job_id":"FS1kd1dd15JUpd87gTBDapvFxv0",
"job_type":5
},
"ResultType":"ID Verification",
"ResultText":"ID Number Validated",
"ResultCode":"1012",
"IsFinalResult":"true",
"Actions":{
"Verify_ID_Number":"Verified",
"Return_Personal_Info":"Returned"
},
"Country":"NG",
"IDType":"PASSPORT",
"IDNumber":"A04150107",
"ExpirationDate":"2017-10-28",
"FullName":"ADEYEMI KEHINDE ADUNOLA",
"DOB":"1989-09-20",
"Photo":"SomeBase64Image",
"sec_key":"pjxsxEY69zEHjSPFvPEQTqu17vpZbw+zTNqaFxRWpYDiO+7wzKc9zvPU2lRGiKg7rff6nGPBvQ6rA7/wYkcLrlD2SuR2Q8hOcDFgni3PJHutij7j6ThRdpTwJRO2GjLXN5HHDB52NjAvKPyclSDANHrG1qb/tloO7x4bFJ7tKYE=|8faebe00b317654548f8b739dc631431b67d2d4e6ab65c6d53539aaad1600ac7",
"timestamp":1570698930193
}

ID API Result Codes:

Code

Description

1012

Success

1013

Invalid ID

1014

Unsupported ID Type and/or Country

1015

Error - Queried Database Unavailable

1016

Product Activation Required