Session init

POST 
/v4/session/init

warning

The response body of this endpoint (the session_id field), must be treated as a sensitive information.

Initialize a verification session. Once initialized, the session can be shared with the end-user to complete the verification process.

An initialized session is not invoiced; only individual steps within the session are billed.

After a session is initialized, you can access it through the following link: https://verify.synaps.io?session_id=$SESSION_ID. Here, $SESSION_ID is the session_id field in the response of this request.

The initialized session will use the verification flow associated with the App linked to the API key you are using. If sandbox credentials are used, the session will be initialized as a sandbox session.

Request

application/json

Body

required

alias string
metadataobject
property name* string

Responses

200

200 response

application/json

Schema

Schema

sandbox boolean
session_id string
Example: fd6d19c9-ab30-46a5-8980-c748f396b879

Example (from schema)

{
  "sandbox": true,
  "session_id": "fd6d19c9-ab30-46a5-8980-c748f396b879"
}

400

400 response

application/json

Schema

Schema

code int32
Example: 1100220
message string
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

401

401 response

application/json

Schema

Schema

code int32
Example: 1100220
message string
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

404

404 response

application/json

Schema

Schema

code int32
Example: 1100220
message string
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

500

500 response

application/json

Schema

Schema

code int32
Example: 1100220
message string
Example: An error occured

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}