How to create a Web Integration Token

Product: Digital Identity Verification

After creating a Web Flow, you will need a Web Integration Token to link the Flow with an URL and perform the necessary validations. Follow these steps to create a Web Integration Token in Postman or any other API client.

In order to ease the process, you can see this Postman collection:

https://www.postman.com/truora-api-docs/workspace/truora-api-docs/folder/26510995-9fc50159-1f32-43d2-80aa-2d69bf637b4f

Create a POST request with the next URL: https://api.account.truora.com/v1/api-keys. You can also refer to our API Reference.
Add the next headers
- Truora-API-Key: <truora api key> Get an Truora API key
- Content-Type: application/x-www-form-urlencoded
Add the following params in the request body with their respective values
- key_name: api-key user name
- key_type: web
- grant: digital-identity
- api_key_version: 1
- country: The country where the validation is to be performed. Allowed: ALL.
- redirect_url: URL where the user is to be redirected once the validation is completed
- flow_id: from flow creation
- account_id: account ID linked with this validation. Use this ID to trace the validations performed by the account later on. To see how to generate the account_id, please visit Create Account to link processes by user guide.
- phone (optional): The user phone number can be set if you already have it. The format is + country_code phone_number e.g.: +573101234567

Note: If you wish to include additional information in the identity validation process, you can do so by registering the inputs using the following structure start_variables.metadata., followed by the variable name and its corresponding result. Example: start_variables.metadata.name = juan.

Send the request and copy the api_key from the response.

Response 200


{
    "api_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjoiIiwiYWRkaXRpb25hbF9kYXRhIjoie1wiY291
    nRyeVwiOlwiQUxMXCIsXCJmbG93X2lkXCI6XCJJUEY4NWEzMGM4NGJhNTU1NTdiNzIwMTEzNzJjYmY0N2E5ZlwiLFwicmVkaXJlY3RfdXJ
    sXCI6XCJodHRwczovL3d3dy5nb29nbGUuY29tL1wiLFwicHJvY2Vzc19pZFwiOlwiSURQOWQwNzBiM2E0OWI3MDkwNjNlYXXXxxxxxXXXxxx",
    "message": "API key created successfully"
}

As last step use https://identity.truora.com/?token=<api_key> and set the api_key to perform the validation process and sharing the link.

Note: The Web Integration Tokens have a 2 hours shelf life by default

The process_id is a unique identifier assigned to each <api key> created in Truora, and it appears at the end of the URL when the flow is started. It is important to keep track of this process_id, as it is required to check the status of the process in the endpoint shown in the next step. Additionally, the API key can be verified on the https://jwt.io/ website to obtain information about the process.

JWT


HEADER
{
  "alg": "HS256",
  "typ": "JWT"
}

PAYLOAD
{
  "account_id": "XXXXXXXXXX",
  "additional_data": "{\"country\":\"ALL\",\"flow_id\":\"IPF0ffd66e565df771dd86a942118e8XXX\",
  \"redirect_url\":\"https://www.google.com/\",\"process_id\":\"IDP9c24df232e05099703a07ba575746XXX\"}",
  "client_id": "TCI3ca341c4d9676046f26d1f8bd042XXXX",
  "exp": 16642119XX,
  "grant": "digital-identity",
  "iat": 16642047XX,
  "iss": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_6QqpOnXX",
  "jti": "bd54322c-b32d-420a-89a3-6372b9593XXX",
  "key_name": "xxx",
  "key_type": "web",
  "username": "xxx"
}

The current state of the fetch process is to create a GET request using the following URL. You can also refer to our API Reference.

https://api.identity.truora.com/v1/processes/{{process_id}}/result

Response 200


{
    "process_id": "IDPae0f8e61706f77254fcbc46ad0xxxxx",
    "account_id": "ACC2d9457efc708e399b4d349fdfxxxxxx",
    "client_id": "TCI1c787378d69397955d60d9b266xxxxx",
    "flow_id": "IPFf2b8d99cd150839b92ca20bfaexxxxxx",
    "created_via": "web",
    "flow_version": 2,
    "country": "CO",
    "status": "success",
    "validations": [
        {
            "validation_id": "VLD8053b5476c7a2e0d80f2d55dc1xxxxx",
            "ip_address": "186.84.132.174",
            "account_id": "ACC2d9457efc708e399b4d349fdfxxxxxxx",
            "type": "document-validation",
            "validation_status": "success",
            "creation_date": "2023-04-20T15:23:23.16025688Z",
            "details": {
                "background_check": {
                    "check_id": "CHKea4700170b3abc7887667cd91xxxxxx",
                    "check_url": "https://api.checks.truora.com/v1/checks/CHKea4700170b3abc7887667cd91xxxxx"
                },
                "document_details": {
                    "birth_place": "xxxxxx",
                    "country": "CO",
                    "creation_date": "2023-04-20T15:23:23.089302125Z",
                    "date_of_birth": "1988-06-21T00:00:00Z",
                    "document_number": "xxxxxxxx",
                    "document_type": "national-id",
                    "expedition_place": "xxxxxxxx",
                    "gender": "xxxxxx",
                    "height": "1.75",
                    "issue_date": "2006-07-xxT00:00:00Z",
                    "last_name": "xxxx xxxxxxx",
                    "mime_type": "image/jpeg",
                    "name": "xxxxxxx xxxxx",
                    "national_registrar": "xxxxx xxxx xxxx",
                    "production_data": "xxxxxx-F-xxxxxxx-xxxxxx",
                    "rh": "O+",
                    "update_date": "2023-04-20T15:23:55.156336961Z"
                },
                "document_validations": {
                    "data_consistency": [
                        {
                            "validation_name": "Validation of date of birth",
                            "result": "valid",
                            "validation_type": "date-of-birth-validation",
                            "message": "The date of birth is valid",
                            "manually_reviewed": false,
                            "created_at": "2023-04-20T15:23:55.363068644Z"
                        },
                        {
                            "validation_name": "Validation of Document Number",
                            "result": "valid",
                            "validation_type": "document-number-validation",
                            "message": "The document has a valid document number or NUIP",
                            "manually_reviewed": false,
                            "created_at": "2023-04-20T15:23:55.363070657Z"
                        }
                    ],
                    "government_database": [
                        {
                            "validation_name": "Validation of Government Database - Registraduría",
                            "result": "valid",
                            "validation_type": "government-database-digital-validation-certificate-cedula",
                            "message": "Document is current and registered in main identity database",
                            "manually_reviewed": false,
                            "created_at": "2023-04-20T15:23:57.361281416Z"
                        }
                    ]
                }
            },
            ],
            "remaining_retries": 2,
            "front_image": "https://truora-files-production.s3.amazonaws.com/face-recognition-validator/enroll/
            TCI1c787378d69397955d60d9b266xxxxx/ACC2d9457efc708e399b4d349fdfxxxxx/ENRa1c1dbfe0d67fe8e0c8aaec32ee2xxxxx
            X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQO4PGUYHA6S6",
            "reverse_image": "https://truora-files-production.s3.amazonaws.com/face-recognition-validator/enroll/
            TCI1c787378d69397955d60d9b266xxxxx/ACC2d9457efc708e399b4d349fdfxxxxx/ENRa1c1dbfe0d67fe8e0c8aaec32ee2xxxxx
            ?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQO4PGUYHA6S6"
        },
        {
            "validation_id": "VLD4c6282e005ecb1e6c69d8b6decxxxxxx",
            "ip_address": "186.84.xxx.xxx",
            "account_id": "ACC2d9457efc708e399b4d349fdfxxxxxx",
            "type": "face-recognition",
            "validation_status": "success",
            "threshold": 0.65,
            "creation_date": "2023-04-20T15:24:03.757501287Z",
            "details": {
                "face_recognition_validations": {
                    "similarity_status": "success",
                    "confidence_score": 0.9
                }
            },
            "identity_process_id": "IDPae0f8e61706f77254fcbc46ad0b035f1",
            "front_image": "https://truora-files-production.s3.amazonaws.com/face-recognition-validator/enroll/
            TCI1c787378d69397955d60d9b266xxxxx/ACC2d9457efc708e399b4d349fdfxxxxx/ENRa1c1dbfe0d67fe8e0c8aaec32ee2xxxxx
            ?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQO4PGUYHA6S6X"
        },
    ],
    "creation_date": "2023-04-20T15:23:04.187201186Z",
    "update_date": "2023-04-20T15:24:49Z"
}

The process_status can either be success or failure at the end. In the meantime, it will be pending. Success occurs when the document validation was successfully. Failure can occur due to an internal error, a time out, or if the document validation is declined.

Note Whenever a validation fails due to inconsistencies in the validation process,a declined reason to indicate the specific reason for the failure Here’s a list of declined reasons.