How to Download Digital Identity Process Data

(Self-serve)

Product: Digital Identity Verification

This guide will help you retrieve and download your digital identity (DI) process data from Truora systems. Whether you are looking to get detailed information about individual processes or download all the related document images and facial recognition outputs, following these steps with our API or dashboard will ensure a smooth experience.

Prerequisites

  1. Truora API Key: You will need an active Truora API Key to access our endpoints. Here is a guide to create a Truora API Key.
  2. API Client: Any API client like Postman.

Retrieving Digital Identity Process Data

Step 1: Retrieve Process IDs

To get all your digital identity process data, you need to first fetch the process IDs.

  • Option 1: Using the Truora API

    1. Create a GET request to the endpoint: https://api.identity.truora.com/v1/processes/. You can also refer to our API Reference How to get processes.
    2. Add the next headers
      • Truora-API-Key: <api key> set the API key obtained in the prerequisites.
      • Content-Type: application/x-www-form-urlencoded
    3. This will return a list of process IDs that you can use for further requests.

  • Option 2: Using the Truora Dashboard

    • Alternatively, you can log in to your Truora account and navigate to the Processes Dashboard. From here, you can download the history of DI processes.
      sample image

Step 2: Get Detailed Results for a Specific Process

With the process_id obtained in the previous step, you can request detailed results for each process.

  1. Create a GET request to the endpoint: https://api.identity.truora.com/v1/processes/{process_id}/result. You can also refer to our API Reference How to get process result.
  2. Replace {process_id} in the URL with the Process ID obtained in the Step 1: Retrieve Process IDs.
  3. Add the next headers
    • Truora-API-Key: <api key> set the API key obtained in the prerequisites.
    • Content-Type: application/x-www-form-urlencoded
  4. Send the request. You should receive a response similar to the following:
    Response 200 
    
{
  "account_id": "some text",
  "city": "some text",
  "client_id": "some text",
  "client_user_id": "some text",
  "country": "CO",
  "geolocation_ip": "1.12345, -123.456",
  "override_status": "success",
  "override_status_history": [
    {
      "current_status": "failure",
      "date": "2006-01-02T15:04:04.000000Z",
      "ip_address": "127.0.0.1",
      "override_status": "success",
      "reason_category": "in_person_customer",
      "reason_description": "Some description explain the change in the process status.",
      "username": "john@example.com"
    }
  ],
  "process_id": "some text",
  "status": "failure",
  "time_to_live": "120",
  "validations": [
    {
      "account_id": "some text",
      "attachment_status": "valid",
      "attachment_validations": [
        {
          "attachment_type": "document-front",
          "result": "some text",
          "validation_name": "some text",
          "validation_type": "ocr-validation"
        },
        {
          "attachment_type": "document-reverse",
          "result": "some text",
          "validation_name": "some text",
          "validation_type": "ocr-validation"
        }
      ],
      "creation_date": "2018-02-10T09:30Z",
      "declined_reason": "invalid_curp",
      "details": {
        "document_details": {
          "document_id": "some text"
        },
        "document_validations": {
          "data_consistency": [
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "government_database": [
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "image_analysis": [
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "manual_review": [
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "photocopy-analysis": [
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ]
        }
      },
      "failure_status": "declined",
      "flow_id": "some text",
      "front_image": "some text",
      "identity_process_id": "some text",
      "ip_address": "some text",
      "reverse_image": "some text",
      "type": "identity-questions",
      "validation_id": "some text",
      "validation_status": "failure"
    },
    {
      "account_id": "some text",
      "attachment_status": "pending",
      "attachment_validations": [
        {
          "attachment_type": "document-reverse",
          "result": "some text",
          "validation_name": "some text",
          "validation_type": "face-clarity-validation"
        },
        {
          "attachment_type": "document-front",
          "result": "some text",
          "validation_name": "some text",
          "validation_type": "face-clarity-validation"
        }
      ],
      "creation_date": "2018-02-10T09:30Z",
      "declined_reason": "identity_belongs_to_dead_person",
      "details": {
        "document_details": {
          "document_id": "some text"
        },
        "document_validations": {
          "data_consistency": [
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "government_database": [
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "image_analysis": [
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "manual_review": [
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ],
          "photocopy-analysis": [
            {
              "message": "some text",
              "result": "valid",
              "validation_name": "some text",
              "validation_type": "some text"
            },
            {
              "message": "some text",
              "result": "invalid",
              "validation_name": "some text",
              "validation_type": "some text"
            }
          ]
        }
      },
      "failure_status": "expired",
      "flow_id": "some text",
      "front_image": "some text",
      "identity_process_id": "some text",
      "ip_address": "some text",
      "reverse_image": "some text",
      "type": "identity-questions",
      "validation_id": "some text",
      "validation_status": "success"
    }
  ]
}

Detailed Response from identity processes

In the response, you will find detailed information such as:

  1. Process ID and Status: Overall process status and ID.
  2. Validation Details: Status and results for each validation step.
  3. Document and Facial Images: Necessary for audits and reviews.
  4. Other Metadata: Information about the user and device used for the process.

Validations data

You can get detailed information about the validations performed in the digital identity process.

Document validation

There is important information related with the document validation such as the background check, details and results of the document analysis. Also, you can extract front and reverse images of the documents and facial recognition outputs from the response.

  • Document Images: Fields front_image and reverse_image.

Take into account that the files have an expiration date, if links are expired you need to perform the request again to get the identity process result.

Face validation

Similarly, there is information of the facial validation such as the similarity of the enrolled photo and the end-user photo to compare and validate.

  • Facial Recognition Images: Fields front_image, face_photo, and face_photo_watermark.

Likewise with document validation urls of the files have an expiration date.

Detailed validation data

With the validations ids retrieved from the identity process result you can get more detailed information of the validations. You need to perform some requests to the validations API.

  1. Create a GET request to the endpoint: https://api.validations.truora.com/v1/validations/{{validation_id}}. You can also refer to our API Reference How to get process result.
  2. Replace {validation_id} in the URL with the Validation ID obtained in Digital Identity Process Data.
  3. Add the next headers
    • Truora-API-Key: <api key> set the API key obtained in the prerequisites.
    • Content-Type: application/x-www-form-urlencoded
  4. Pass the query param show_details with the value true.
    • This endpoint returns a json with the result of the validation and the images:
      • The images are uploaded to S3 and a link is returned where the content can be consulted.
      • These links have an expiration time of 15 minutes, after that time the link cannot be used.
      • To generate new links, the Get Result endpoint must be called again to return the result of the process with new links to view the images.

We have the following guides about how to perform the request and expected responses: