Demo License

Demo license is designed to give back consistent responses in Customer APIs. User can use it to explore API's requests and response structures and the associated webhook events content.

Authorize and generate access tokens

POST /authorize/customer

Request:

{
   "consent": true,
   "webhook": "https://yourwebhookurl"
}

Response:

Status: 200
Body:
{
    "accessToken": "access token jwt",
    "refreshToken": "refresh token jwt",
    "tokenType": "refresh_token",
    "expiresIn": 10799279
}

Webhook Message:

{
  "id": "69bd4352-b4c0-4735-9c57-b658e7d2cb26",
  "transactionId": "0bcbc9d6-0909-43b0-ae7c-67ac0d3ca70c",
  "clientId": "",
  "event": {
    "name": "create",
    "type": "transaction",
    "result": "created"
  },
  "error": {
    "code": 0,
    "message": ""
  }
}

Note: The transactionId is unique for each new transaction with demo license.

Create and Configure Transactions

POST /customer/transactions

Request:

{
    "documentVerification": {
        "enabled": true,
        "documentsAccepted": []
    },
    "selfieVerification":{
        "enabled": true
    }
}

Response:

Status: 201
Body:
{
    "transactionId": "0bcbc9d6-0909-43b0-ae7c-67ac0d3ca70c"
}

Upload a document

POST /customer/transactions/documents

Request (multipart/form-data):

Body: [The image file to be uploaded]
Context: 'front'

Response:

{
	"imageId": "19bab966-0b8a-4bd6-8731-a84bec3de043"
}

Note: With demo license, images are not stored on Trulioo side and they can not be retrieved afterwards.

Start to verify a transaction

POST /customer/transactions/verify

Response:

Status: 202
Body:
{
    "status": "ACCEPTED"
}

Webhook Message:

{
  "id": "3bfd8204-9df0-43ce-8642-8a8833743cc1",
  "transactionId": "0bcbc9d6-0909-43b0-ae7c-67ac0d3ca70c",
  "clientId": "",
  "event": {
    "name": "decision",
    "type": "transaction",
    "result": "accepted"
  },
  "error": {
    "code": 0,
    "message": ""
  }
}

Get the data of a transaction

GET /customer/transactions/{transactionId}

Response:

Status: 200
Body:
{
    "transactionId": "0bcbc9d6-0909-43b0-ae7c-67ac0d3ca70c",
    "dataVendorSessionId": "8132ac2d-b428-4328-8d8e-010c5b6ea80e",
    "timeOfTransaction": "2024-04-30T16:46:26.800025177Z",
    "status": "ACCEPTED",
    "errors": [],
    "indicators": [
        {
            "type": "FACE_MATCH",
            "result": "ACCEPTED",
            "description": "Face match indicator has passed.",
            "score": "85",
            "subindicators": [
                {
                    "type": "FACE_MATCH",
                    "result": "ACCEPTED",
                    "description": "Document photo and selfie matched.",
                    "code": "ACCEPTED_FACE_MATCH"
                }
            ]
        },
        {
            "type": "LIVENESS",
            "result": "ACCEPTED",
            "description": "Liveness indicator has passed.",
            "score": "92",
            "subindicators": [
                {
                    "type": "LIVENESS",
                    "result": "ACCEPTED",
                    "description": "Passive liveness check passed",
                    "code": "ACCEPTED_LIVENESS"
                }
            ]
        },
        {
            "type": "DOCUMENT",
            "result": "ACCEPTED",
            "description": "Document verification indicators have passed.",
            "score": "93",
            "subindicators": [
                {
                    "type": "VALID_DOCUMENT",
                    "result": "ACCEPTED",
                    "description": "Document verification passed.",
                    "code": "ACCEPTED_DOCUMENT"
                }
            ]
        }
    ],
    "person": {
        "fullName": "Benjamin Franklin",
        "firstName": "Benjamin",
        "lastName": "Franklin",
        "dateOfBirth": "1986-01-17",
        "gender": "",
        "middleName": "Galen",
        "placeOfBirth": "この世界の外",
        "nationality": "エイリアン",
        "location": {
            "fullAddress": "a full address",
            "addressLine1": "alternateAddress line1",
            "addressLine2": "alternateAddress line2",
            "city": "A big city",
            "stateProvince": "it is a state province",
            "country": "A big big country",
            "zipCode": "123abc-456def"
        },
        "alternateFirstName": "你好",
        "alternateLastName": "Γειά σου",
        "alternateMiddleName": "سلام",
        "alternateFullName": "გამარჯობა",
        "alternateDateOfBirth": "",
        "alternateLocation": {
            "fullAddress": "完整地址",
            "addressLine1": "ladɛrɛsi 1",
            "addressLine2": "Адрестік Жол 2",
            "city": "நகரம்",
            "stateProvince": "дәүләт өлкәсе",
            "country": "देश",
            "zipCode": "מיקוד"
        }
    },
    "document": {
        "documentCountry": "US",
        "issueDate": "2024-04-30T16:46:26.800118064Z",
        "expirationDate": "2024-04-30T19:46:26.800127247Z",
        "documentType": "DRIVERS_LICENSE",
        "documentName": "PASSPORT of I do not know where",
        "dlCategory": "class",
        "documentNumber": "44b500b0-4321-45b3-8866-8be2918c9b22",
        "documentNumber2": "84233822-0434-44f2-bee1-511ebd537637",
        "documentNumber3": "25d740bf-726e-4c95-98fe-ceb390ff5bbc",
        "documentNumber4": "dc8c8f82-5d0c-4f17-b731-5bfe861d1b76",
        "jurisdictionCode": "CD",
        "alternateDocumentNumber": "",
        "alternateDocumentNumber2": "",
        "alternateDocumentNumber3": "",
        "alternateDocumentNumber4": "",
        "alternateExpiryDate": "2100年1月",
        "alternateIssueDate": "2000年1月",
        "mrzLineOne": "",
        "mrzLineTwo": "",
        "mrzLineThree": ""
    },
    "images": {
        "frontDocumentId": "1113093c-1c44-4e06-a8ae-9e6bea25c8a1",
        "backDocumentId": "222f334d-65ef-4bd7-90a4-1075e23bff62",
        "selfieId": "333eaf53-9d9e-43c5-8224-f2158a574be3",
        "accessToken": "[Token needed to download images]",
        "documentFrontUrl": "[Trulioo URL to download the uploaded image]",
        "documentBackUrl": "[Trulioo URL to download the uploaded image]",
        "selfieUrl": "[Trulioo URL to download the uploaded image]"
    },
    "matcherResults": []
}

Note: Except the transactionId, all data in this response are mocked data.