Application ID

This is the application ID, you should send with each API request.


Run your requests

https://gateway.trulioo.com/trial

Step 1: Test Authentication

You can use the Test Authentication endpoint to check that your api key is working. The only thing you need to provide in this request is a variable in the header, as shown below. As seen in the request example below, send ‘x-trulioo-api-key: {Your Key at the top of this page}’ as a request header.

Request
Response

Step 2: Get Country Codes

Trulioo's API is structured to make calls by country. If you're not sure what countries are configured for your account, Trulioo provides an endpoint to retrieve this information at any time. Simply run the following Get Country Codes request and you will receive the full list of country codes available to your account.

Request
Response

Step 3: Get Test Entities

Now that you know what country codes are valid for your account, you can see what test entities exist for each of these countries. These test entities can be used to test verifying individuals call in Step 5.
These test entities are only demo data and different ones exist for every country.

Request
Response

Step 4: Get Consents

Consents

It is the responsibility of the developer to ensure any necessary consents are being collected from the individual being verified. See Trulioo's Terms and Conditions.

Due to the nature of some of our datasources, you may need to obtain consent from your customer for their data to be sent to that particular source. You may or may not be configured to use any of these datasources, so it is recommended to run a Get Consents request for all the countries obtained in step 2. This will give you a list of datasources requiring additional consents in each country. If applicable, you can obtain these special consents from your customer, and then provide them in the "ConsentForDataSources" field of the Verify request.

Request
Response

Step 5: Verify

Once steps 1 through 4 have been completed you should have everything needed to carry out a Verify request. Using one of the country codes from step 2, one of the test entities from step 3, and any necessary consents from step 4, you can now run the following request.

Explanation of additional fields:

  • AcceptTruliooTermsAndConditions: This flag indicates that you accept Trulioo terms and conditions. The verification request will be executed only if the value of this field is passed as 'true'.
  • CleansedAddress: Trulioo provides a service to check address data and ensure it is correct and all necessary address fields are provided. In general these cleansed addresses have a higher likelihood of producing a match result. Set this field to true to receive address cleanse information.
  • ConfigurationName: For now this should be hard-coded to "Identity Verification".
  • Request
    Response

    Step 1: Test Authentication

    You can use the Test Authentication endpoint to check that your api key is working. The only thing you need to provide in this request is a variable in the header, as shown below. As seen in the request example below, send ‘x-trulioo-api-key: {Your Key at the top of this page}’ as a request header.

    Request
    Response

    Step 2: Get Country Codes

    Trulioo's API is structured to make calls by country. If you're not sure what countries are configured for your account, Trulioo provides an endpoint to retrieve this information at any time. Simply run the following Get Country Codes request and you will receive the full list of country codes available to your account.

    Request
    Response

    Step 3: Get Document Types

    Trulioo supports different document types in each country. In order to see what documents are supported for a specific country you can run the Get Document Types request.

    Request
    Response

    Step 4: Verify Request

    Once steps 1 through 3 have been completed you should have everything needed to carry out a Verify request. Using one of the country codes from step 2 and the document types from step 3, you can now run the following request.

    The DocumentFrontImage, DocumentBackImage and LivePhoto fields are base64strings. For this example, the base64 strings are not actual images and have been shortened to be able to demonstrate the request structure.

    CallBackUrl

    For a Document Verification the call has to be made asynchronously. In order to do this with Trulioo’s API you need to send a value for the CallBackUrl field:
    The CallBackUrl parameter must be a valid URL. Trulioo recommends setting up your own server and URL so you can receive all the necessary information to review your response.

    Explanation of additional fields:
  • AcceptTruliooTermsAndConditions: This flag indicates that you accept Trulioo terms and conditions. The verification request will be executed only if the value of this field is passed as 'true'.
  • ConfigurationName: For now this should be hard-coded to "Document Verification".
  • Request
    Response

    Step 5: Verify Response

    Once your request is submitted, Trulioo will try to update the client with transaction state updates - at the URL specified - until the transaction completes. Only once the transaction is complete will a Transaction Record ID (TRID) become available in that response.
    The TransactionRecordId will populate when Status is Completed:

    Callback Response

    To review your transaction's results, perform a GET Transaction Record request with the completed transaction's resulting TRID:

    Request
    Response

    Next Steps

    <EmbedID/>

    Paste a snippet of code to your sign-up process and verify identities in a sandbox environment.


    Learn more >

    Check out interactive docs

    See and play with our interactive documentation. Get started on your integration with GlobalGateway using JSON.

    Play >

    Upgrade Account!

    Apply to Trulioo’s private beta Developer Plan; start verifying identities of your customers.


    Upgrade Account >