Quick Start

We suggest you read through the step by step integration guide to understand the integration in detail. Please see below for a postman collection.

Before you start

Ensure that your business is registered with Yoti. For more detailed information and to register your business if you haven't done so yet, click on the link below."

View Onboarding with Yoti

Postman example

To run the example in Postman please click the button below:

Example code

Please see examples for different scenarios.

Full example

To use all 6 services:

{

"type": "OVER",

"age_estimation": {

"allowed": true,

"threshold": 25,

"level": "PASSIVE"

"digital_id": {

"allowed": true,

"threshold": 18,

"age_estimation_allowed": true,

"age_estimation_threshold": 21,

"level": "NONE"

"doc_scan": {

"allowed": true,

"threshold": 18,

"authenticity": "AUTO",

"level": "PASSIVE"

"credit_card": {

"allowed": false,

"threshold": 18,

"level": "NONE"

"mobile": {

"allowed": false,

"threshold": 18,

"level": "NONE"

Over 18 example

{

"type": "OVER",

"age_estimation": {

"allowed": true,

"threshold": 25,

"level": "PASSIVE"

"digital_id": {

"allowed": true,

"threshold": 18,

"age_estimation_allowed": true,

"age_estimation_threshold": 21,

"level": "NONE"

"doc_scan": {

"allowed": true,

"threshold": 18,

"authenticity": "AUTO",

"level": "PASSIVE"

"ttl": 900,

"reference_id": "over_18_example",

"callback": {

"auto": true,

"url": "https://www.yoti.com"

"notification_url": "https://yourdomain.example/webhook",

"cancel_url": "https://www.yoti.com",

"synchronous_checks": true

Over 16 example

{

"type": "OVER",

"age_estimation": {

"allowed": true,

"threshold": 25,

"level": "PASSIVE"

"digital_id": {

"allowed": true,

"threshold": 16,

"age_estimation_allowed": true,

"age_estimation_threshold": 19,

"level": "NONE"

"doc_scan": {

"allowed": true,

"threshold": 16,

"authenticity": "AUTO",

"level": "PASSIVE"

"ttl": 900,

"reference_id": "over_18_example",

"callback": {

"auto": true,

"url": "https://www.yoti.com"

"notification_url": "https://yourdomain.example/webhook",

"cancel_url": "https://www.yoti.com",

"synchronous_checks": true

Under 40 example

{

"type": "UNDER",

"age_estimation": {

"allowed": true,

"threshold": 40,

"level": "PASSIVE"

"digital_id": {

"allowed": false,

"threshold": 40,

"level": "NONE"

"doc_scan": {

"allowed": true,

"threshold": 40,

"authenticity": "AUTO",

"level": "PASSIVE"

"ttl": 900,

"reference_id": "over_18_example",

"callback": {

"auto": true,

"url": "https://www.yoti.com"

"notification_url": "https://yourdomain.example/webhook",

"cancel_url": "https://www.yoti.com",

"synchronous_checks": true

}

Exact age example

{

"type": "AGE",

"age_estimation": {

"allowed": true,

"level": "PASSIVE"

"digital_id": {

"allowed": true,

"level": "NONE"

"doc_scan": {

"allowed": true,

"authenticity": "AUTO",

"level": "PASSIVE"

"ttl": 900,

"reference_id": "exact_age_example",

"callback": {

"auto": true,

"url": "https://www.yoti.com"

"notification_url": "https://yourdomain.example/webhook",

"cancel_url": "https://www.yoti.com",

"synchronous_checks": true

}

Last updated on

Was this page helpful?