Verify

post

https://api.trulioo.com/verifications/v1/verify

Calling this method will perform a verification. You can query configuration to get what fields are available to you in each country. It is also possible to get sample requests from the customer portal.

Sandbox Accounts

If you are configured for a sandbox account make sure to call Get Test Entities to get test data for a country you want to try. Sandbox accounts only use these test entities and so trying to verify with any other data will result in no matches being found.

Body Params

AcceptTruliooTermsAndConditions

boolean

Indicate that Trulioo terms and conditions are accepted. The Verification request will be executed only if the value of this header is passed as 'true'.

CallBackUrl

string

length between 0 and 2083

Including this field will cause the transaction to follow our asynchronous flow, detailed here. Please do not include this field if you do not wish to trigger the asynchronous transaction flow.

Timeout

int32

If set, Trulioo will try to update the client synchronously within the timeout in seconds. If failed to accomplish, the transaction will be canceled.

ConfigurationName

string

length between 0 and 45

Indicate the configuration used for the verification. Currently only 'Identity Verification' is supported. Default value will be "Identity Verification"

ConsentForDataSources

array of strings

Some datasources require your customer provide consent to access them. For each datasource that requires consent, send the required string if your customer has provided it. A list of these required strings for a country can be gotten by the Get Consents call. If consent is not provided the datasource will not be queried.

ConsentForDataSources

CountryCode

string

required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

CustomerReferenceID

string

Use this field to send any internal reference ID to Global Gateway. It will be contained in the response so it is simple to link Trulioo's API to your system.

DataFields

object

required

The data field name-value pairs for the data elements on which the verification is to be performed

VerboseMode

boolean

Defaults to false

To return additional appended fields of watch list hit details in the response

Responses

400

Your request could not be processed, there should be more details in the response.

401

The user name and password you provided is not valid or you are using an account not configured to be an API user.

408

The request took longer to process than we waited.

415

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

500

An error happened on the server without a specific message.

200OK