v1

latestOpenAPI 3.0.12026-07-2474233379.5 KB

Verifications

Verify

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

post/v3/verifications/verify

Request body

VerificationType'Demo'

The type of verification to perform. Please use 'Demo' to try it.

PackageIdstring

The Package ID to run the transaction under which can be obtained by your Customer Success Manager or via a support ticket.

CallBackUrlstring nullable

Timeoutinteger nullable

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

ConsentForDataSourcesstring[] nullable

Some datasources required your customer provide consent to access them. Set that the customer has provided consent for each datasource that requires one. If consent is not provided the datasource will not be queried.

CountryCodestring

The country code for which the verification needs to be performed.

CustomerReferenceIDstring nullable

Customer Reference Id

VerboseModeboolean

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

Example request

{
  "DataFields": {
    "Document": {
      "documentName": "Australia - ePassport (2009) Travel Document",
      "dlCategory": "Class 5",
      "documentNumber": "EX504966",
      "documentNumber2": "A09354726",
      "documentNumber3": "C07321129",
      "documentNumber4": "D06364026",
      "documentCountry": "GB",
      "jurisdictionCode": "ENG",
      "issueDate": "2020-11-17T00:00:000Z",
      "expirationDate": "2030-11-17T00:00:000Z",
      "alternateDocumentNumber": "一百二十三萬四千五百六十七",
      "alternateDocumentNumber2": "一百二十三萬四千五百六十七",
      "alternateDocumentNumber3": "一百二十三萬四千五百六十七",
      "alternateDocumentNumber4": "一百二十三萬四千五百六十七",
      "alternateExpiryDate": "2050 年 1 月 1 日",
      "alternateIssueDate": "2000 年 1 月 1 日"
    }
  }
}

Response

Success

TransactionIDstring nullable

The id for the transaction it will be a GUID

UploadedDtstring date-time

Time in UTC

CompletedDtstring date-time nullable

Time in UTC

CountryCodestring nullable

Country Code

ProductNamestring nullable

Product Name

CustomerReferenceIDstring nullable

Customer Reference Id