Transaction

Create and configure a transaction

Creates a transaction with configuration options for document verification, selfie liveness verification, biometric verification, and optional SDK configuration for client-side capture.

post/api/transactions

Request

Base URL
https://verification.trulioo.com
URL
https://verification.trulioo.com/api/transactions
Auth
HTTP bearer

Headers

Accept-Versionstring required

Example:3.0

API version header.

Request body

webhookUrlstring uri

Callback URL for webhook notifications

clientIdstring

Optional client identifier, max length 150 characters

Example request

{
  "documentVerification": {
    "documentsAccepted": [
      {
        "documentType": "DRIVERS_LICENSE",
        "documentOrigin": [
          {
            "countryCode": "CA",
            "jurisdictions": [
              {
                "jurisdictionCode": "FL"
              }
            ]
          }
        ]
      }
    ]
  },
  "subjectInfo": {
    "firstName": "John",
    "middleName": "Smith",
    "lastName": "Doe",
    "fullName": "John Smith Doe",
    "dateOfBirth": "1980-01-01",
    "addressLine1": "123 Main Street",
    "stateProvince": "BC",
    "city": "Vancouver",
    "postalCode": "V5V 0A0",
    "country": "CA",
    "firstLastName": "López",
    "secondLastName": "García",
    "birthLastName": "GABLER",
    "spouseLastName": "Molenaar"
  },
  "subjectInfoList": [
    {
      "firstName": "John",
      "middleName": "Smith",
      "lastName": "Doe",
      "fullName": "John Smith Doe",
      "dateOfBirth": "1980-01-01",
      "addressLine1": "123 Main Street",
      "stateProvince": "BC",
      "city": "Vancouver",
      "postalCode": "V5V 0A0",
      "country": "CA",
      "firstLastName": "López",
      "secondLastName": "García",
      "birthLastName": "GABLER",
      "spouseLastName": "Molenaar"
    }
  ],
  "sdk": {
    "locale": "en-US",
    "theme": {
      "colors": {
        "light": {
          "logoURL": "https://example.com/logo.png",
          "primaryButton": "#0066cc",
          "primaryButtonText": "#ffffff"
        },
        "dark": {
          "logoURL": "https://example.com/logo.png",
          "primaryButton": "#0066cc",
          "primaryButtonText": "#ffffff"
        }
      }
    },
    "presetCountries": [
      "US",
      "CA",
      "FR"
    ]
  },
  "documentLivenessConfig": {
    "screenUsed": {
      "enabled": true,
      "calibration": "MEDIUM"
    },
    "printout": {
      "enabled": true,
      "calibration": "MEDIUM"
    },
    "portraitSubstitution": {
      "enabled": true,
      "calibration": "MEDIUM"
    },
    "skipAlreadyCropped": false
  }
}

Response

Transaction created.

transactionIdstring uuid

Unique transaction identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.