Production Base URL
Sandbox Base URL
Signed request performed by back-end SDKs that includes a X-Yoti-Auth-Digest.
Generate signed request Yoti API endpoints are authenticated through signed requests. To create a signed request:
Concatenate the following elements using the '&' character:
- HTTP method
- Path
- Query string (enriched with a timestamp and a nonce parameter)
- Base64 encoded request body (if available)
Apply SHA256withRSA to the resulting string, using your PEM private key generated from the Yoti Hub.
Base64 encode the result from step 2.
Example GET request:
GET&/sessions?sdkId=b88ad843-13cc-44ba-a3e0-053f71d89b1f&nonce=b88ad843-13cc-44ba-a3e0-053f71d89b1f×tamp=1480509893Example POST request:
POST&/sessions?sdkId=b88ad843-13cc-44ba-a3e0-053f71d89b1f&nonce=b88ad843-13cc-44ba-a3e0-053f71d89b1f×tamp=1480509893&ew0KImlkIiA6IDEsDQoibmFtZSIgOiBpdGVtDQoNCn0=Parameters:
- SDK ID: UUID generated when producing your Yoti keys
- nonce: UUID strings
- Timestamp: UNIX timestamps (number of elapsed seconds since Jan 1st 1970)
| Key | In | |
|---|---|---|
| X | Header |
Backend Endpoints
Endpoints for the Back-End SDK (Relying Business)
Get all the supported documents
| includeNonLatin | boolean | Controls whether or not the documents returned should include non-latin documents Default: false |
curl --get \ --url 'https://api.yoti.com/idverify/v1/supported-documents' \ --data includeNonLatin={includeNonLatin}OK
| object | object | ||
| supported | array[object] | ||
| code | string | ||
| supported | array[object] | ||
| type | string | ||
| is | boolean | ||
| requirements | object | ||
| date | string |
{ "supported_countries": [ { "code": "AGO", "supported_documents": [ { "type": "DRIVING_LICENCE", "is_strictly_latin": true, "requirements": { "date_from": "2012-10-31" } }, { "type": "NATIONAL_ID", "is_strictly_latin": false }, { "type": "PASSPORT", "is_strictly_latin": true } ] } ]}Create a new session
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme |
| object | object | Create Session Payload | |
| client | integer | Number of seconds for the user to complete the whole flow. Default: 600 | |
| session | string | The point-in-time by which the user must complete the whole flow. Expressed as a date, time and time-zone in RFC3339 format. This field may not be used with a client_session_token_ttl field. | |
| resources | integer | Retention period for uploaded documents/images in number of seconds. minimum: 86700 Default: 87000 | |
| ttl | integer | Retention period for a generated import_token, in seconds | |
| user | string | Allows to track the same user across multiple sessions. Should not contain any personal identifiable information. | |
| block | boolean | Allows the relying business to block the collection of biometric consent Default: false | |
| notifications | object | ||
| endpoint | string | POST endpoint required. Update notifications are sent to this endpoint based on the selected subscription topics pattern: | |
| topics | array[string] | Enum: | |
| auth | string | If provided, Yoti will send this as a base64 encoded value for the Authorization header in the notifications | |
| auth | string | Determines the type of auth header to include in outbound notifications. Defaults to BASIC Enum: | |
| requested_checks | Mutually exclusive with identity_profile_requirements | ||
| object | object | ||
| type | string | Enum: | |
| config | object | ||
| manual | string | The values IBV is not permitted, although it is permitted for some other types of check Enum: | |
| issuing | object | ||
| requested | boolean | ||
| filter | |||
| object | object | ||
| type | string | Enum: | |
| allow | boolean | ||
| allow | boolean | ||
| country | object | ||
| inclusion | string | Acceptable values are (case-insensitive): [INCLUDE, EXCLUDE]. WHITELIST and BLACKLIST are deprecated, but are still accepted and mapped to INCLUDE or EXCLUDE Enum: | |
| country | array[string] | ||
| type | object | ||
| inclusion | string | Acceptable values are (case-insensitive): [INCLUDE, EXCLUDE]. WHITELIST and BLACKLIST are deprecated, but are still accepted and mapped to INCLUDE or EXCLUDE Enum: | |
| document | array[string] | ||
| requested_tasks | Mutually exclusive with identity_profile_requirements | ||
| object | object | ||
| type | string | Enum: | |
| config | object | ||
| manual | string | Acceptable values vary for each check type, but may be one of: [NEVER, FALLBACK, ALWAYS] Enum: | |
| chip | string | Enum: | |
| required_documents | Allows the Relying Business to require multiple documents and filter the list of allowable document countries/types. Mutually exclusive with identity_profile_requirements | ||
| object | object | ||
| type | string | Enum: | |
| filter | Any filters that results in an empty list of allowed documents will be rejected | ||
| object | object | ||
| type | string | Enum: | |
| allow | boolean | ||
| allow | boolean | ||
| country | object | ||
| inclusion | string | Acceptable values are (case-insensitive): [INCLUDE, EXCLUDE]. WHITELIST and BLACKLIST are deprecated, but are still accepted and mapped to INCLUDE or EXCLUDE Enum: | |
| country | array[string] | ||
| type | object | ||
| inclusion | string | Acceptable values are (case-insensitive): [INCLUDE, EXCLUDE]. WHITELIST and BLACKLIST are deprecated, but are still accepted and mapped to INCLUDE or EXCLUDE Enum: | |
| document | array[string] | ||
| sdk | object | ||
| allowed | string | Acceptable values are (case-insensitive): [CAMERA_AND_UPLOAD, CAMERA] Enum: | |
| primary | string | pattern: | |
| secondary | string | pattern: | |
| font | string | pattern: | |
| locale | string | pattern: | |
| preset | string | ||
| success | string | ||
| error | string | ||
| privacy | string | ||
| attempts | object | Allows the relying business to specify the number of retries allowed for certain scenarios. | |
| ID | object | Retry configuration for ID document text extraction tasks. This is treated as a map, and so keys are subject to change | |
| * | integer | ||
| allow | boolean | Allows the relying business to enable/disable handoff functionality (normally defaults to false, but some orgs are defaulted to true in the env configs) Default: false |
curl --request POST \ --url 'https://api.yoti.com/idverify/v1/sessions' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data nonce={nonce} \ --data timestamp={timestamp} \ --data '{ "client_session_token_ttl": 600, "session_deadline": "2021-08-16T21:33:03.000Z", "resources_ttl": "{integer}", "import_token": "{}", "user_tracking_id": "{string}", "block_biometric_consent": "{boolean}", "notifications": { "endpoint": "https://example.com/idv/notification", "topics": [ "RESOURCE_UPDATE", "TASK_COMPLETION", "CHECK_COMPLETION", "SESSION_COMPLETION" ], "auth_token": "{string}", "auth_type": "{string}" }, "requested_checks": [ { "type": "{string}", "config": { "manual_check": "FALLBACK", "issuing_authority_sub_check": { "requested": "{boolean}", "filter": { "type": "{string}", "allow_non_latin_documents": "{boolean}", "allow_expired_documents": "{boolean}", "country_restriction": { "inclusion": "INCLUDE", "country_codes": [ "GBR", "FRA" ] }, "type_restriction": { "inclusion": "INCLUDE", "document_types": [ "PASSPORT", "STATE_ID" ] } } } } } ], "requested_tasks": [ { "type": "{string}", "config": { "manual_check": "FALLBACK", "chip_data": "{string}" } } ], "required_documents": [ { "type": "{string}", "filter": { "type": "{string}", "allow_non_latin_documents": "{boolean}", "allow_expired_documents": "{boolean}", "country_restriction": { "inclusion": "INCLUDE", "country_codes": [ "GBR", "FRA" ] }, "type_restriction": { "inclusion": "INCLUDE", "document_types": [ "PASSPORT", "STATE_ID" ] } } } ], "sdk_config": { "allowed_capture_methods": "CAMERA_AND_UPLOAD", "primary_colour": "#2d9fff", "secondary_colour": "#FFFFFF", "font_colour": "#FFFFFF", "locale": "en-US", "preset_issuing_country": "USA", "success_url": "https://example.com/idv/success", "error_url": "https://example.com/idv/error", "privacy_policy_url": "http://example.com/policy/privacy", "attempts_configuration": { "ID_DOCUMENT_TEXT_DATA_EXTRACTION": { "GENERIC": 3, "RECLASSIFICATION": 2 } }, "allow_handoff": "{boolean}" }}'Session created
| object | object | Create Session Response Body | |
| client | integer | remaining time the user has to complete the session | |
| client | uuid | client token to be used for auth of any calls made by client for this session | |
| sessionId | uuid |
Payload validation error or malformed request
Unauthorised request (wrong key or signature)
Unauthorised request (app is disabled or has no associated organisation_id)
The application for provided sdk id does not exist
The service is unavailable
{ "client_session_token_ttl": 599, "client_session_token": "{uuid}", "sessionId": "{uuid}"}Retrieve the entire Session
| sessionId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme |
curl --get \ --url 'https://api.yoti.com/idverify/v1/sessions/{sessionId}' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data timestamp={timestamp} \ --data nonce={nonce}OK
| object | object | ||
| sessionId | uuid | ||
| client | integer | remaining time the user has to complete the session | |
| import | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| failure | string | ||
| user | string | ||
| biometric | date-time | ||
| state | string | The current state of the session Enum: | |
| client | uuid | client token to be used for auth of any calls made by client for this session | |
| resources | object | ||
| id | array[object] | ||
| id | uuid | ||
| source | object | ||
| type | string | Enum: | |
| document | string | ||
| issuing | string | ||
| pages | array[object] | ||
| capture | string | Acceptable values are (case-insensitive): [CAMERA, UPLOAD] Enum: | |
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| frames | array[object] | The frames for page media. | |
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| document | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| document | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times | |
| tasks | array | ||
| id | uuid | ||
| state | string | Enum: | |
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times | |
| generated | array[object] | ||
| id | uuid | ||
| type | string | Enum: | |
| generated | array[object] | ||
| id | uuid | ||
| type | string | Enum: | |
| type | string | Enum: | |
| supplementary | array[object] | ||
| id | uuid | ||
| source | object | ||
| type | string | Enum: | |
| document | string | ||
| issuing | string | ||
| file | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| pages | array[object] | ||
| capture | string | Acceptable values are (case-insensitive): [CAMERA, UPLOAD] Enum: | |
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| frames | array[object] | The frames for page media. | |
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| document | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times | |
| tasks | array | ||
| id | uuid | ||
| state | string | Enum: | |
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times | |
| generated | array[object] | ||
| id | uuid | ||
| type | string | Enum: | |
| generated | array[object] | ||
| id | uuid | ||
| type | string | Enum: | |
| type | string | Enum: | |
| liveness | array[object] | ||
| id | uuid | ||
| source | object | ||
| type | string | Enum: | |
| liveness | string | Enum: | |
| facemap | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| frames | array[object] | The frames (images) for a Zoom liveness capture. first frame should always have media in a completed liveness resource. The first three frames should always have media in a completed zoom liveness resource. Media might be null for frames 4-7 | |
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times | |
| tasks | array[object] | ||
| image | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| face | array[object] | ||
| id | uuid | ||
| source | object | ||
| type | string | Enum: | |
| image | object | ||
| media | object | ||
| id | uuid | ||
| type | string | Enum: | |
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times | |
| tasks | array[object] | ||
| checks | |||
| object | object | ||
| id | uuid | ||
| type | string | Enum: | |
| state | string | The current state of the Check Enum: | |
| resources | array[string] | ||
| generated | array[object] | ||
| id | uuid | ||
| type | string | Enum: | |
| report | object | ||
| recommendation | object | ||
| value | string | Enum: | |
| reason | string | must be preset if 'value' is 'REJECT' | |
| recovery | string | must be present if 'value' is 'REJECT' | |
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| created | date-time | Uses the ISO8601 standard representation of date times | |
| last | date-time | Uses the ISO8601 standard representation of date times |
Invalid payload or request missing headers or query params
Unauthorised request (wrong key or signature)
Session or App not found
xxxxxxxxxx{ "sessionId": "{uuid}", "client_session_token_ttl": 599, "import_token": {...}, "user_tracking_id": "{string}", "biometric_consent": "{date-time}", "state": "{string}", "client_session_token": "{uuid}", "resources": {...}, "checks": [...]}Delete the session and everything associated with it
| sessionId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme |
curl --request DELETE \ --url 'https://api.yoti.com/idverify/v1/sessions/{sessionId}' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data timestamp={timestamp} \ --data nonce={nonce}Session deleted
| No response body |
Invalid payload or request missing headers or query params
Unauthorised request (wrong key or signature)
App not found
The checks are not finished
No responseRetrieve media content
Retrieves a specific media
| X | string |
|
| sessionId | string | ||
| mediaId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme |
curl --get \ --url 'https://api.yoti.com/idverify/v1/sessions/{sessionId}/media/{mediaId}/content' \ --header 'X-Yoti-Device-Meta: eyJtYW51ZmFjdHVyZV9uYW1lIjoiQXBwbGUiLCJtb2RlbF9uYW1lIjoiSXBob25lWCIsImJyb3dzZXJfbmFtZSI6IkNocm9tZSIsImJyb3dzZXJfdmVyc2lvbiI6IjcyLjAuMzYyNi4xMTkiLCJsb2NhbGUiOiJlbi1HQiIsImNsaWVudF92ZXJzaW9uIjoiMi4xMi4wIiwib3NfbmFtZSI6Ik1hY09zIiwib3NfdmVyc2lvbiI6IjEwLjEzLjE0IiwicHJvZHVjdCI6M30=' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data nonce={nonce} \ --data timestamp={timestamp}OK. Response body depends on Content-Type of the media
| No response body |
OK. Regulations prevent us from returning the media content
Bad Request
Unauthorised request (wrong key or signature)
Session, Media or App not found
No responseDelete media content
Deletes a specific media content
| X | string |
|
| sessionId | string | ||
| mediaId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme |
curl --request DELETE \ --url 'https://api.yoti.com/idverify/v1/sessions/{sessionId}/media/{mediaId}/content' \ --header 'X-Yoti-Device-Meta: eyJtYW51ZmFjdHVyZV9uYW1lIjoiQXBwbGUiLCJtb2RlbF9uYW1lIjoiSXBob25lWCIsImJyb3dzZXJfbmFtZSI6IkNocm9tZSIsImJyb3dzZXJfdmVyc2lvbiI6IjcyLjAuMzYyNi4xMTkiLCJsb2NhbGUiOiJlbi1HQiIsImNsaWVudF92ZXJzaW9uIjoiMi4xMi4wIiwib3NfbmFtZSI6Ik1hY09zIiwib3NfdmVyc2lvbiI6IjEwLjEzLjE0IiwicHJvZHVjdCI6M30=' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data nonce={nonce} \ --data timestamp={timestamp}No content
| No response body |
Bad Request
Unauthorised request (wrong key or signature)
Session, Media or App not found
Session is locked (session in progress before triggering checks) or Resource is locked (session in progress with checks triggered)
No responseResponse Config Endpoints
Endpoints for configuring Sandbox behaviour
Fetch the configuration for a specified sdk application ID
| sdkId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme |
curl --get \ --url 'https://api.yoti.com/idverify/v1/apps/{sdkId}/response-config' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data timestamp={timestamp} \ --data nonce={nonce}OK
| object | object | Configuration Response | |
| task | object | ||
| ID | array | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| check | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| LIVENESS | array[object] | ||
| liveness | string | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| secondary | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| THIRD | object | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| async | integer |
Invalid payload or request missing headers or query params
Unauthorised request (wrong key or signature)
App not found
xxxxxxxxxx{ "task_results": {...}, "check_reports": {...}}Update the configuration for a specified sdk application ID
| sdkId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme |
| object | object | Configuration Payload | |
| task | object | Task Results Payload | |
| ID | array | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| check | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| LIVENESS | array[object] | ||
| liveness | string | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| THIRD | object | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| secondary | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| async | integer |
curl --request PUT \ --url 'https://api.yoti.com/idverify/v1/apps/{sdkId}/response-config' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data timestamp={timestamp} \ --data nonce={nonce} \ --data '{ "task_results": { "ID_DOCUMENT_TEXT_DATA_EXTRACTION": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "document_fields": {}, "detected_country": "GBR", "recommendation": { "value": "{string}", "reason": { "value": "{string}", "detail": "{string}" } } } } ], "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "document_fields": {}, "detected_country": "GBR", "recommendation": { "value": "{string}", "reason": { "value": "{string}", "detail": "{string}" } } } } ] }, "check_reports": { "ID_DOCUMENT_AUTHENTICITY": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "ID_DOCUMENT_TEXT_DATA_CHECK": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] }, "document_fields": {} } } ], "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] }, "document_fields": {} } } ], "ID_DOCUMENT_FACE_MATCH": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "LIVENESS": [ { "liveness_type": "{string}", "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "THIRD_PARTY_IDENTITY": { "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } }, "ID_DOCUMENT_COMPARISON": [ { "secondary_document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "async_report_delay": "{integer}" }}'Updated configuration successfully
| No response body |
Invalid payload or request missing headers or query params
Unauthorised request (wrong key or signature)
Unauthorised request (app is disabled or has no associated organisation_id)
App not found
The service is unavailable
No responseGet the configured config for a specified session ID
| sessionId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme |
curl --get \ --url 'https://api.yoti.com/idverify/v1/sessions/{sessionId}/response-config' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data timestamp={timestamp} \ --data nonce={nonce}OK
| object | object | Configuration Response | |
| task | object | ||
| ID | array | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| check | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| LIVENESS | array[object] | ||
| liveness | string | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| secondary | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| THIRD | object | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| async | integer |
Invalid payload or request missing headers or query params
Unauthorised request (wrong key or signature)
Session or App not found
xxxxxxxxxx{ "task_results": {...}, "check_reports": {...}}Update the configuration for a specified session ID
| sessionId | string |
| sdkId | string | Required if using a Signed Request as the authentication scheme | |
| timestamp | string | Required if using a Signed Request as the authentication scheme | |
| nonce | string | Required if using a Signed Request as the authentication scheme |
| object | object | Configuration Payload | |
| task | object | Task Results Payload | |
| ID | array | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| document | object | ||
| detected | string | The detected country of origin for the identity document. Must be a 3 letter ISO code in uppercase | |
| recommendation | object | Provide in-session feedback | |
| value | string | Enum: | |
| reason | object | Provide in-session feedback reason | |
| value | string | Enum: | |
| detail | string | ||
| check | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| SUPPLEMENTARY | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| document | object | ||
| ID | array[object] | ||
| document | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| LIVENESS | array[object] | ||
| liveness | string | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| THIRD | object | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| ID | array[object] | ||
| secondary | object | ||
| country | array[string] | ||
| document | array[string] | ||
| result | object | ||
| report | object | ||
| recommendation | object | ||
| value | string | ||
| reason | string | ||
| recovery | string | ||
| breakdown | array[object] | ||
| sub | string | ||
| result | string | Enum: | |
| details | array[object] | ||
| async | integer |
curl --request PUT \ --url 'https://api.yoti.com/idverify/v1/sessions/{sessionId}/response-config' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data sdkId={sdkId} \ --data timestamp={timestamp} \ --data nonce={nonce} \ --data '{ "task_results": { "ID_DOCUMENT_TEXT_DATA_EXTRACTION": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "document_fields": {}, "detected_country": "GBR", "recommendation": { "value": "{string}", "reason": { "value": "{string}", "detail": "{string}" } } } } ], "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "document_fields": {}, "detected_country": "GBR", "recommendation": { "value": "{string}", "reason": { "value": "{string}", "detail": "{string}" } } } } ] }, "check_reports": { "ID_DOCUMENT_AUTHENTICITY": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "ID_DOCUMENT_TEXT_DATA_CHECK": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] }, "document_fields": {} } } ], "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] }, "document_fields": {} } } ], "ID_DOCUMENT_FACE_MATCH": [ { "document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "LIVENESS": [ { "liveness_type": "{string}", "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "THIRD_PARTY_IDENTITY": { "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } }, "ID_DOCUMENT_COMPARISON": [ { "secondary_document_filter": { "country_codes": [ "ARE", "GBR" ], "document_types": [ "NATIONAL_ID", "PASSPORT" ] }, "result": { "report": { "recommendation": { "value": "{string}", "reason": "{string}", "recovery_suggestion": "{string}" }, "breakdown": [ { "sub_check": "{string}", "result": "{string}", "details": [ {} ] } ] } } } ], "async_report_delay": "{integer}" }}'Updated configuration successfully
| No response body |
Invalid payload or request missing headers or query params
Unauthorised request (wrong key or signature)
Unauthorised request (app is disabled or has no associated organisation_id)
App not found
The service is unavailable
No response