HomeDocumentationSupportRelease NotesSearch Box
Documentation

Getting Started

Getting Started (API Version 2.5)

This is a quickstart guide on how to work with our API.

Steps to take

Note: Make sure you add Accept-Version as a header parameter for your requests, and to enter 2.5 as its value.

1. Authorize

Connect to the /authorize endpoint by passing in a license in the authorization header of your HTTP request. This access token will be used in the authorization header of your requests in subsequent steps.

You will receive the access token in the form of a string in the API's response. Once an access token is used for a transaction, it will no longer be usable. You will need to use a new access token (with the authorize call) to create another one.

Dealing with access token expiry (click to expand)

Access tokens expire in one hour. If for some reason you require more time, you can call the refresh endpoint to generate a new one for the same transaction. Alongside the access token, the authorize endpoint will have also returned a refresh token in the body of its response, which you will need for the refresh endpoint. Check out the Additional Information section to learn more.

2. Create a transaction

Create a transaction using the /customer/transactions endpoint. Once the transaction is created, the API will return a transactionId associated with the transaction.

In the body of your request, you will need to specify the kinds of transactions you want to accept from end users. For example, you can specify if you would only like to only process passports and drivers licenses from certain countries. Check out a sample body request Check out a sample body request here.

3. Fetch the shortCode

Finally, you can request a shortCode using the /customer/handoff endpoint, which you will need to launch your SDK. The shortCode lasts up to 5 minutes.

The shortCode is required in the following SDK integration steps:

4. Let your SDK do the work!

If you have integrated with one of our SDKs, it will automatically upload the images submitted through the SDK.

For more information about our SDKs, check out the following documentation:

Once your transaction is processed, you are done! You can now use the API to:

  • Get data from the transaction
  • Get an image from the transaction

5. Retrieve data

Retrieve the data of a transaction with the /customer/transactions/{transactionId} endpoint. You will need to pass in the transactionId of your transaction as a path parameter. The API will return the transaction corresponding to the ID inputted in a JSON format. See a sample retrieve data response here..

6. Retrieve images

You can fetch the image in two ways:

  1. The endpoint from Step 5 will return the URLs pre-constructed with all of the parameters you need, so you simply need to download or display the images at those URLs.

  2. Retrieve an image from a transaction with the /customer/transactions/{transactionId}/images/{imageId} endpoint. You will need to pass in the transactionId of the transaction, an imageId of an image belonging to the transaction, and an image access token as path parameters. The API will return the image requested in Base64 Format. See a sample retrieve images response here..

Note: The image access token is different from the accessToken from Step 1. It is included in the images object of the response to Step 4.

Flow Visualization

The flow of Document Verification

The image above shows the full Document Verification flow from start to finish.

The flow begins from the left with Authorization (Step 1).

The Configuration (Step 2) node requires an access token from the previous node.

Calling Handoff (Step 3) will result in a shortCode, which lasts 5 minutes and is required to launch the SDK.

If a user starts onboarding from a desktop computer, they will be redirected with a QR Code. Each QR Code lasts 4 minutes, but will automatically renew when it is expired.

Once the user QR Code is scanned, the user will resume the flow on their mobile device. It will prompt for a Country, then a Document Type (e.g. Passport, Driver's Licence, etc.), then images (e.g. front of document, selfie), and then ask the user to submit. They will have a total of 40 minutes to finish the flow.

While the user is going through the flow on their mobile device, the desktop webpage will update based on user's current step on their mobile device. After they upload their images, the desktop will let them know when their images are being uploaded, and when the upload is complete.

If this flow is not completed within an hour of Authorization (Step 1), it will be considered to be aborted by the user.

Additional Information

  • Refresh your access token with the /authorize/refresh endpoint can be used to refresh the access token once it has expired. You will need to enter the clientId as part of the request body to access it. The API will return an access token if the call is successful. Check a sample transaction response here. .

The clientId should be com.trulioo.client.

  • Once the refresh token expires you will need to repeat step one to fetch a new pair of tokens.
  • If the verification process takes a significantly long time, contact [email protected] for assistance.