API Management

x-trulioo-api-key Sign Up to get your API key


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


GET https://gateway.trulioo.com/trial/connection/v1/testauthentication
x-trulioo-api-key: {Your Key at the top of this page}
            

Response


"Hello instantOnDemoUser"
            

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


GET https://gateway.trulioo.com/trial/configuration/v1/countrycodes/Identity Verification
x-trulioo-api-key: {Your Key at the top of this page}
            

Response


[
  "AU",
  "AT",
  "SE",
  "DK",
  "NO",
  "NL",
  "GB",
  "TR",
  "BR",
  "BE",
  "DE",
  "US"
]
            

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


GET https://gateway.trulioo.com/trial/configuration/v1/testentities/Identity Verification/AU
x-trulioo-api-key: {Your Key at the top of this page}
            

Response


[
  {
    "PersonInfo": {
      "FirstGivenName": "J",
      "MiddleName": "Henry",
      "FirstSurName": "Smith",
      "DayOfBirth": 5,
      "MonthOfBirth": 3,
      "YearOfBirth": 1983
    },
    "Location": {
      "BuildingNumber": "10",
      "UnitNumber": "3",
      "StreetName": "Lawford",
      "StreetType": "st",
      "Suburb": "Doncaster",
      "StateProvinceCode": "VIC",
      "PostalCode": "3108"
    },
    "Communication": {
      "Telephone": "03 9896 8785"
    },
    "Passport": {
      "Number": "N1236548"
    },
    "CountrySpecific": {
      "AU": {
        "MiddleInitial": "H"
      }
    }
  }
]
            

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


GET https://gateway.trulioo.com/trial/configuration/v1/consents/Identity Verification/AU
x-trulioo-api-key: {Your Key at the top of this page}
            

Response


[
  "Visa Verification"
]
            

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


POST
https://gateway.trulioo.com/trial/verifications/v1/verify
x-trulioo-api-key:{Your Key at the top of this page}
Content-Type: application/json
body:
{
  "AcceptTruliooTermsAndConditions": true,
  "CleansedAddress": false,
  "ConfigurationName": "Identity Verification",
  "ConsentForDataSources": ["Visa Verification"],
  "CountryCode": "AU",
  "DataFields": {
    "PersonInfo": {
        "DayOfBirth": 5,
        "FirstGivenName": "J",
        "FirstSurName": "Smith",
        "MiddleName": "Henry",
        "MinimumAge": 0,
        "MonthOfBirth": 3,
        "YearOfBirth": 1983
    },
    "Location": {
        "BuildingNumber": "10",
        "PostalCode": "3108",
        "StateProvinceCode": "VIC",
        "StreetName": "Lawford",
        "StreetType": "St",
        "Suburb": "Doncaster",
        "UnitNumber": "3"
    },
    "Communication": {
        "EmailAddress": "testpersonAU%40gdctest.com",
        "Telephone": "03 9896 8785"
    },
    "Passport": {
        "Number": "N1236548"
    }
  }
}
            

Response


{
  "TransactionID": "d3e5d20c-3ad7-448d-9034-b28c68d6db07",
  "UploadedDt": "2017-07-11T21:47:50",
  "Record": {
    "TransactionRecordID": "0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "DatasourceName": "Australia Citizen File",
        "DatasourceFields": [
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Credit Agency",
        "DatasourceFields": [
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": [],
    "Rule": {
      "RuleName": "Category 3 KYC v3",
      "Note": "Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored"
    }
  },
  "Errors": []
}
            

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 >