/v1/sessions/{id}

  • Updated on Mar 18, 2025
Patch
/v1/sessions/{id}

Changes the status of the verification session to submitted

Make sure that you have uploaded all the images using the POST/sessions/{sessionId}/media request before setting the status to submitted. If you try to upload media after you have submitted the session, you may encounter the 409 - conflict error.


Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.


Security
API Key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired

Request body signed with the shared secret key

Path parameters
id
stringRequired

Session id

Body parameters

Session data

Expand All
object
verification
object Required

Verification object

status
string Required

Status of a verification session, always submitted

Example`submitted`
Responses
200

Session is patched

Expand All
object
status
string

API request status

Examplesuccess
verification
object

Verification object

id
string

UUID v4 which identifies the verification session

Example123e4567-e89b-12d3-a456-426614174000
url
string

URL for the timestamp

Examplehttps://sampleURL.veriff.com/v/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoiZmQ
vendorData
string

The unique identifier that you created for your end-user. It can be max 1,000 characters long and contain only non-semantic data that can not be resolved or used outside your systems or environments. Veriff returns it unmodified in webhooks and API response payloads, or as null if not provided

Example1234567890
host
string

Host URI

Examplehttps://sampleURL.veriff.com
status
string

Verification session status

Examplesubmitted
sessionToken
string

Session-specific token of the verification

ExampleeyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
400

Bad request

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleValidation failed
401

Unauthorized

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
404

Session not found

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleResource not found
500

Internal server error

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleSomething went wrong