Guide to Get Results
To get the results of a validation, you must first create and perform the validation. Here are the guides with the types of integration to create the validations:
- Document Validation from web process and via API.
- Face Validation from web process and via API.
- Document and Face Validation from web process and via API.
- Phone Validation from web process and via API Phone
- Email Validation from web process and via API Email.
- WhatsApp to Validate Identity, all Digital Identity validators (Document, Face, Phone and Email).
- Electronic Signature from web and WhatsApp process. Via API.
Note: If the validation fails you can see declined reason for Document validation, Face Validation, Phone validation and Email validation.
Get the results of a process
From Truora’s Dashboard
In Truora’s Dashboard you can filter the results of a process by:
-
The Process ID and Flow ID these is unique identifiers assigned to each process and flow, upon creation or initiation respectively.
-
The Phone Number of the person who initiated or received the WhatsApp message to communicate with the chatbot.
Within the results of a process, you can find the information of each validation performed and its corresponding outcome.
Digital Identity Verification or Customer Engagement > Results History
- Another alternative is to download csv file with the history of results that can be filtered by
date
and/orFlow ID
By means of Truora’s API
Using Truora’s API you should:
- Create a GET request to
https://api.identity.truora.com/v1/processes/{process_id}/result
- Replace
{process_id}
in the URL with the *Process ID
obtained from the Truora’s Dashboard, or by creating a rule to be notified via Webhook . - Create a Header named
Truora-API-Key
and set its value to your API key. - Send the request. Once you start or finish a process you will be able to see the results. The possible states of a process are
success
,pending
, orfailure
.
*Note: In the Web Flow test you can get the Process ID in the URL as a path param of the process https://identity.truora.com/{process_id}
. (e.g., https://identity.truora.com/IDP58eec9282cxxxxxxxxx
).
Note: If you register additional information in the digital validation process token, you can identify it in the JSON under the metadata
section.
Devices information
As part of the API response results, you have access to information about the devices used during the identity verification process in the devices_info
field. The available data may include the following:
model
: Model of the device (e.g., iPhone 12).type
: Type of device (e.g., mobile, computer).os
: Operating system of the device (e.g., Android, macOS, iOS).os_version
: Operating system version (e.g., 10.0.0, 13.0.0, 14.3.0).browser
: Browser used during the process, (e.g., Chrome, Safari)browser_version
: Version of the browser used during the process (e.g., 123.0.0.0, 5.1.7)
You will find two possible scenarios:
- Scenario 1: Only one device
This case occurs when the entire process is conducted using a single device. In the response, you will receive information similar to the following:
- Scenario 2: Two devices involved in the process
An example of this case is when the process initiates on a PC and then continues on a mobile device using the redirection feature. In the response, you will receive information similar to the following:
Get the results of a validation
From Truora’s Dashboard
In Truora’s Dashboard you can filter the results by:
- Type of Validation: Filter the results for a specific validation type. (e.g.,
Face Recognition
). - Date: Returns the results in a time interval in the date format
YYYY-MM-DD
. (e.g., From:2023-05-01
To:2023-05-12
). - Validation Status: The possible states for a validation are
success
,pending
, orfailure
. - Validation ID: The Validation ID is a unique identifier assigned to each validation created, which can be used to retrieve the results of that particular validation.
Digital Identity Verification > Validation results
By means of Truora’s API
Using Truora’s API you should:
- Create a GET request to
https://api.validations.truora.com/v1/validations/{validation_id}
- Replace
{validation_id}
in the URL with thevalidation id
obtained in the request response when you create the validation via the API, from the dashboard, or by creating a rule to be notified via Webhook . - Create a Header named
Truora-API-Key
and set its value to your API key. - Send the request. Once you create the validation you will be able to see the results. The possible validation statuses are
success
,pending
orfailure
.