Get Session Configurations

AI Tools

This API endpoint will allow you to see the prebuilt Yoti identity verification configurations, as well as any custom configurations that have been created.

HTTP
    
 
GET https://api.yotisign.com/v2/idv/sessions/configs
Copy

Headers Explained

The following elements are needed:

Headers	Description
Authorization (header)	API Key to call the Yoti Sign API. This should be sent as a bearer token.
Content-Type (header)	application/json

Request Body

In this request you have the ability to view the identity verification session configuration payloads in their entirety, to understand what you are requesting.

JSON
    
 
{  "detailed_session_configs": false}
Copy

Value	Description
detailed_session_configs	If set to true the JSON session configuration payloads for each result will also be included in the response, resulting in a very large payload.

Response

On success, we return a 200 with a JSON body matching the following schema:

JSON
    
 
{    "session_configs":    [        {            "name": "Real Estate",            "is_custom": false,            "is_private": false        },        {            "name": "HR",            "is_custom": false,            "is_private": false        },        {            "name": "Finance",            "is_custom": false,            "is_private": false        }    ]}
Copy

Error codes

If the request is unsuccessful we will respond with an appropriate HTTP code, and a message will be detailed in the response body.

Last updated on

Was this page helpful?