How can I look up a specific user's data?

Note: The user ID set in the PartnerParams JSON must be unique. It is used to connect future jobs to the correct user. Using this user ID you are able to check the state of that user in our system and retrieve a list of the outcomes of actions they have taken in our system.

This is done by making a call to:

POST https://[env].smileidentity.com/api/v2/partner/enrollee/info

Where [env] is either "portal" or "prod" “portal” (test environment) - "https://portal.smileidentity.com/api/v2/partner/enrollee/info" “prod” (production environment) - "https://prod.smileidentity.com/api/v2/partner/enrollee/info"

With a JSON body shown below:

{
  "environment": "<test | production>",
  "partner_id": "<Put your partner ID here>",
  "signature": "<Put signature here>",
  "timestamp": "<Put the timestamp here>",
  "user_id": "<Put User ID here>"
}

Example response:

{
  "enrolled_user": {
    "allow_new_enroll": false,
    "complete": true,
    "deleted": false,
    "inactive": false,
    "is_fraudulent": false,
    "pending": false,
    "provisional": false
  },
  "history": [
    {
      "created_at": "2019-07-12T18:13:50.586Z",
      "partner_params": {
        "job_id": "1180ad5b-e2fa-4a26-b3c2-de3872b4a438",
        "user_id": "49435266-4d92-45fc-93ec-935628f79d84",
        "job_type": 2
      },
      "job_id": "0000008081",
      "result_code": "1220",
      "result_message": "Authenticated",
      "id_check": null
    },
    {
      "created_at": "2019-07-12T18:13:50.586Z",
      "partner_params": {
        "job_id": "3905ad5b-e2fa-4a26-b3c2-de3872b5bce5",
        "user_id": "49435266-4d92-45fc-93ec-935628f79d84",
        "job_type": 5
      },
      "job_id": "0000008080",
      "result_code": "1012",
      "result_message": "ID Number Validated",
      "id_check": {
        "name": "SOME PERSON",
        "id_number": "12345678901",
        "country": "NG",
        "id_type": "BVN",
        "dob": "1996-01-02",
        "expiration_date": "Not Available",
        "photo": "base64 string",
        "address": "Not Available",
        "gender": "Male",
        "phone_number": "Not Available",
        "result_code": "1012",
        "result_text": "ID Number Validated",
        "full_data": {
          // json content varies by id type and country
        }
      }
    },
    {
      "created_at": "2019-07-10T18:13:33.011Z",
      "partner_params": {
        "job_id": "0f4b0017-6eba-4135-98b0-0f24dc6db0ab",
        "user_id": "49435266-4d92-45fc-93ec-935628f79d84",
        "job_type": 4
      },
      "job_id": "0000008079",
      "result_code": "0840",
      "result_message": "Enroll User",
      "id_check": null
    }
  ]
}

Last updated