Quick start

AI Tools

Here is a quick start guide to accelerate your SDK integration. For detailed information, we suggest that you read through the step-by-step integration guide.

Install the SDK

Yoti SDKs are available for several languages through popular dependency management systems.

To install the SDK:

Javascript
Java
PHP
C#
Go
Copy

Using Yoti SDKs

The description on how to use the above endpoint from the SDK can be found here:

Please read the above for a full description and understanding, below we have provided examples on how those requests will expose the new functionality.

First, specify the required imports and create a DocScanClient using the SDK ID and the PEM file. Then, define the subject to be returned in the verification report. And set the advanced identity profile requirements to your desired scheme. You will need to set up the SDK configuration and a session specification using the scheme requirements and the SDK config. Finally, use the DocScanClient to create a session by providing the session specification. Retrieve the Session ID and Client Session Token and utilise them to generate the iframe URL.

Node.js
Java
PHP
C#
Go
Copy

Subject Explained

FieldValueDescriptionMandatory
subjectObjectAllows to provide information on the subject.Optional
subject_idStringAllows to track the same user across multiple sessions. Should not contain any personal identifiable information.Optional

Identity Profile Requirements Explained

Trust frameworkSchemeObjectiveDescription
UK_TFIDARTWN/AUK certified right to work verification.
UK_TFIDARTRN/AUK certified right to rent verification.
UK_TFIDADBSBASIC, STANDARD, ENHANCEDUK certified digital method for verifying a person's identity for criminal record checks
YOTI_GLOBALIDENTITYAL_L1, AL_M1Yoti created Identity verification that can be set to a low assurance "L1" or a medium assurance "M1". The medium assurance adds a biometric face match.
YOTI_GLOBALIDENTITY_PLUS_ADDRESSAL_L1, AL_M1Yoti created Identity verification that can be set to a low assurance "L1" or a medium assurance "M1". The medium assurance adds a biometric face match. An address check will also be performed.
YOTI_GLOBALGBR_RTW_SHARECODEN/AYoti created verification that will fetch a users share code details and compare them to details extracted from a users Id documents.
YOTI_GLOBALCAN_CRCN/AYoti created Identity verification that will verify a document and perform a biometric face match. For the Canadian Criminal Record Check.

Client side view

Once you have generated the iframe URL, you can send it to the frontend for it to be rendered on the page. Please see example below:

HTML
Copy

Retrieve Results

After a session has been created, you can use the Yoti SDK to retrieve the session result (containing all the end-user's uploaded documents and associated metadata).

Result of the session

Session retrieval requires a session ID. This is generated while creating a session as demonstrated above.

Node.js
Java
PHP
C#
Go
Copy

Retrieve Media

In order to retrieve document images and document fields from the resources container we have to look for the relevant media ID inside of the id document pages.

Node.js
Java
PHP
C#
Go
Copy

Retrieve Identity Profile

Once the session has reached the state of 'Completed', identify profile can be successfully retrieved.

In case of a successful transaction, once the identity profile is received, the identity profile report JSON will be accessible. This contains the media ID which can then be used to get the full JSON response of the report.

Node.js
Java
PHP
C#
Go
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard