Sign in

v1

latestOpenAPI 3.0.12026-07-2474233379.5 KB
Transaction

Get transaction data

Retrieves detailed information for a verification process by transaction identifier.

get/api/transactions/{transactionId}

Path parameters

transactionIdstring uuid required

Headers

Accept-Versionstring required
Example:3.0

API version header.

Response

OK

transactionIdstring

The unique identifier of a Trulioo document verification transaction.

dataVendorSessionIdstring

The unique identifier referencing a specific vendor verification session.

timeOfTransactionstring

Date and time (ISO 8601) when the transaction took place.

status'ACCEPTED' | 'REVIEW' | 'DECLINED' | 'ERROR' | 'NO_RESULT'

The decision of the verification.

errorsstring[]

List of errors related to image processing, network with vendor, or vendor errors during verification.

Example response

{
  "transactionId": "28087e85-9c6c-4ce9-83e2-1fb3d66b8cde",
  "dataVendorSessionId": "8005efed-e683-40ab-a803-56eba164b767",
  "timeOfTransaction": "2023-01-01T16:00:00.000Z",
  "status": "REVIEW",
  "indicators": [
    {
      "type": "DOCUMENT",
      "result": "REVIEW",
      "description": "Document requires a review.",
      "score": "90",
      "subindicators": [
        {
          "type": "OCR",
          "result": "REVIEW",
          "description": "Poor image quality."
        }
      ]
    }
  ],
  "person": {
    "fullName": "Sherlock Holmes",
    "firstName": "Sherlock",
    "middleName": "Scott",
    "lastName": "Holmes",
    "dateOfBirth": "1859-05-22",
    "placeOfBirth": "London",
    "nationality": "England",
    "gender": "F",
    "location": {
      "fullAddress": "221b Baker St, London, England, NW16XE",
      "addressLine1": "221b Baker St",
      "addressLine2": "London, State, NW16XE",
      "city": "London",
      "stateProvince": "State",
      "country": "England",
      "zipCode": "NW16XE"
    },
    "alternateFirstName": "小明",
    "alternateMiddleName": "大",
    "alternateLastName": "王",
    "alternateFullName": "王大小明",
    "alternateDateOfBirth": "πρώτος Ιανουαρίου",
    "alternateLocation": {
      "fullAddress": "1234バンクーバー通り, バンクーバー, ブリティッシュコロンビア,  カナダ, NW16XE",
      "addressLine1": "1234バンクーバー通り",
      "addressLine2": "バンクーバー",
      "city": "バンクーバー",
      "stateProvince": "ブリティッシュコロンビア",
      "country": "カナダ",
      "zipCode": "מיקוד"
    },
    "standardizedLocation": {
      "fullAddress": "221b Baker St, London, England, NW16XE",
      "addressLine1": "221b Baker St",
      "addressLine2": "London, State, NW16XE",
      "city": "London",
      "stateProvince": "State",
      "country": "England",
      "zipCode": "NW16XE"
    },
    "firstLastName": "Silva",
    "secondLastname": "Pereira",
    "alternateFirstLastname": "司",
    "alternateSecondLastname": "徒",
    "birthLastName": "Holmes",
    "spouseLastName": "Smith",
    "estimatedMinAge": 23,
    "estimatedMaxAge": 25
  },
  "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 日"
  },
  "images": {
    "frontDocumentId": "0116879a-ff2d-4c58-96da-fb4f088452e7",
    "backDocumentId": "78b65b2a-72ee-4b81-a14b-e795cedbc818",
    "selfieId": "f12885ea-699f-4572-8630-cddc01e8a929"
  }
}