SmartSelfie™ Authentication

require 'smile-identity-core'

# Initialize
partner_id = '<Put your partner ID here>'; #login to the Smile ID portal to view your partner id
default_callback = '<Put your default callback url here>';
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

connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)

# Create required tracking parameters
partner_params = {
    user_id: '<put previously registered user"s user_id here>',
    job_id: '<put your unique job ID here>',
    job_type: 2
};

# Create image list
# image_type_id Integer
# 0 - Selfie image jpg (if you have the full path of the selfie)
# 2 - Selfie image jpg base64 encoded (if you have the base64image string of the selfie)
# 4 - Liveness image jpg (if you have the full path of the liveness image)
# 6 - Liveness image jpg base64 encoded (if you have the base64image string of the liveness image)
image_details = [
    {
      image_type_id: <0 | 2>,
      image: '<full path to selfie image or base64image string>'
     },
     { # Not required if you don't require proof of life (note photo of photo check will still be performed on the uploaded selfie)
       image_type_id: <4 | 6>,
       image: '<full path to liveness image or base64 image string>'
     }
  ];

# Set options for the job
options = {
  return_job_status: <true | false>, # Set to true if you want to get the job result in sync (in addition to the result been sent to your callback). If set to false, result is sent to callback url only.
  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
};

# Submit the job
response = connection.submit_job(partner_params, image_details, nil, options)

{success: true, smile_job_id: <the generated smile_job_id>}

{
  "Actions": {
    "Human_Review_Compare": "Not Applicable",
    "Human_Review_Liveness_Check": "Passed",
    "Human_Review_Update_Selfie": "Not Applicable",
    "Liveness_Check": "Passed",
    "Register_Selfie": "Not Applicable",
    "Return_Personal_Info": "Not Applicable",
    "Selfie_Provided": "Passed",
    "Selfie_To_ID_Authority_Compare": "Not Applicable",
    "Selfie_To_ID_Card_Compare": "Not Applicable",
    "Selfie_To_Registered_Selfie_Compare": "Completed",
    "Update_Registered_Selfie_On_File": "Not Applicable",
    "Verify_ID_Number": "Not Applicable"
  },
  "ConfidenceValue": "99",
  "PartnerParams": {
    "job_id": "KE_TEST_1013",
    "job_type": "2",
    "user_id": "KE_TESTTEST_1012"
  },
  "ResultCode": "1220",
  "ResultText": "Authenticated",
  "SmileJobID": "0000057497",
  "Source": "WebAPI",
  "timestamp": "2021-06-21T15:10:15.729Z",
  "signature": "----signature-----"
}

{
  "timestamp": "2022-03-31T15:07:04.806Z",
  "signature": "---signature---",
  "job_complete": true,
  "job_success": true,
  "code": "2302",
  "result": {
    "Source": "WebAPI - ruby",
    "Actions": {
      "Human_Review_Compare": "Not Applicable",
      "Human_Review_Liveness_Check": "Not Applicable",
      "Human_Review_Update_Selfie": "Not Applicable",
      "Liveness_Check": "Under Review",
      "Register_Selfie": "Not Applicable",
      "Return_Personal_Info": "Not Applicable",
      "Selfie_Provided": "Passed",
      "Selfie_To_ID_Authority_Compare": "Not Applicable",
      "Selfie_To_ID_Card_Compare": "Not Applicable",
      "Selfie_To_Registered_Selfie_Compare": "Completed",
      "Update_Registered_Selfie_On_File": "Not Applicable",
      "Verify_ID_Number": "Not Applicable"
    },
    "ResultCode": "0824",
    "ResultText": "Provisional Authentication - Under Review",
    "SmileJobID": "0000000194",
    "PartnerParams": {
      "job_id": "003",
      "user_id": "rb_ekyc+ss_test_user_005",
      "job_type": "2"
    },
    "ConfidenceValue": "99"
  },
  "history": [
    {
      "Source": "WebAPI - ruby",
      "Actions": {
        "Human_Review_Compare": "Not Applicable",
        "Human_Review_Liveness_Check": "Not Applicable",
        "Human_Review_Update_Selfie": "Not Applicable",
        "Liveness_Check": "Under Review",
        "Register_Selfie": "Not Applicable",
        "Return_Personal_Info": "Not Applicable",
        "Selfie_Provided": "Passed",
        "Selfie_To_ID_Authority_Compare": "Not Applicable",
        "Selfie_To_ID_Card_Compare": "Not Applicable",
        "Selfie_To_Registered_Selfie_Compare": "Completed",
        "Update_Registered_Selfie_On_File": "Not Applicable",
        "Verify_ID_Number": "Not Applicable"
      },
      "ResultCode": "0824",
      "ResultText": "Provisional Authentication - Under Review",
      "SmileJobID": "0000000194",
      "PartnerParams": {
        "job_id": "003",
        "user_id": "test_user_005",
        "job_type": "2"
      },
      "ConfidenceValue": "99"
    }
  ],
  "image_links": {
    "selfie_image": "---image link---"
  },
  "success": true,
  "smile_job_id": "0000000194"
}