Utilities

Required Class: Utilities Class

Job Status

The job status endpoint lets you retrieve information about jobs you have ran previously. With the job status endpoint, you can get the job results, submitted selfie and liveness images, and the ID response (this is only available on the Enhanced KYC and Biometric KYC products).

If you are querying job status for a job immediately after submitting it, you might need to keep polling job status till you get a result. We recommend you always submit your job with a callback.

To run job status for a job, you can edit the sample code below:

require 'smile-identity-core'

# Initialize
partner_id = '<Put your partner ID here>'; #login to the Smile ID portal to view your partner id
api_key = '<Put your API key here>'; # copy your API key from the Smile ID portal
sid_server = '<0 | 1>'; # Use '0' for the sandbox server, use '1' for production server

utilities_connection = SmileIdentityCore::Utilities.new(partner_id, api_key, sid_server)

# Set options for the job status
options = {
  return_history: <true | false>, # Set to true to return results of all jobs you have ran for the user in addition to current job result. You must set return_job_status to true to use this flag.
  return_image_links: <true | false>, # Set to true to receive selfie and liveness images you uploaded. You must set return_job_status to true to use this flag.
  signature: true
};

# Get the job status
user_id = '<put the user_id of the user whose job(s) results you want to retrieve>'
job_id = '<put the job_id of the job you want to retrieve its results>'

response = utilities_connection.get_job_status(user_id, job_id, options)

Example Response

If you set both return_history and return_image_links to true, you will receive the JSON object containing the result like below:

{
  "job_success": true,
  "result": {
    "ConfidenceValue": "99",
    "Actions": {
      "Verify_ID_Number": "Verified",
      "Return_Personal_Info": "Returned",
      "Human_Review_Update_Selfie": "Not Applicable",
      "Human_Review_Compare": "Not Applicable",
      "Update_Registered_Selfie_On_File": "Not Applicable",
      "Liveness_Check": "Not Applicable",
      "Register_Selfie": "Approved",
      "Human_Review_Liveness_Check": "Not Applicable",
      "Selfie_To_ID_Authority_Compare": "Completed",
      "Selfie_To_ID_Card_Compare": "Not Applicable",
      "Selfie_To_Registered_Selfie_Compare": "Not Applicable"
    },
    "ResultText": "Enroll User",
    "PartnerParams": {
      "job_type": "1",
      "optional_info": "Your additional tracking information",
      "user_id": "HBBBBBBH57g",
      "job_id": "HBBBBBBHg"
    },
    "Source": "WebAPI",
    "ResultCode": "0810",
    "SmileJobID": "0000001111"
  },
  "code": "2302",
  "job_complete": true,
  "signature": "...",
  "history": [
    {
      "ConfidenceValue": "99",
      "Actions": {
        "Verify_ID_Number": "Verified",
        "Return_Personal_Info": "Returned",
        "Human_Review_Update_Selfie": "Not Applicable",
        "Human_Review_Compare": "Not Applicable",
        "Update_Registered_Selfie_On_File": "Not Applicable",
        "Liveness_Check": "Not Applicable",
        "Register_Selfie": "Approved",
        "Human_Review_Liveness_Check": "Not Applicable",
        "Selfie_To_ID_Authority_Compare": "Completed",
        "Selfie_To_ID_Card_Compare": "Not Applicable",
        "Selfie_To_Registered_Selfie_Compare": "Not Applicable"
      },
      "ResultText": " Enroll User",
      "PartnerParams": {
        "job_type": "1",
        "optional_info": "we are one",
        "user_id": "HBBBBBBH57g",
        "job_id": "HBBBBBBHg"
      },
      "Source": "WebAPI",
      "ResultCode": "0810",
      "SmileJobID": "0000001111"
    }
  ],
  "image_links": {
    "selfie_image": "image_link"
  },
  "timestamp": "2019-10-10T12:32:04.622Z"
}