Delete

/v1/sessions/{id}

Requests the deletion of a session. Not available by default, contact your Solutions Engineer for info and configuration.

It is possible to delete sessions which have the following session statuses: created, started, abandoned, expired, approved, resubmission_requested, declined, inflow_completed, review.

Attempting to delete the session in other statuses will respond with the Session is not in a completed status. error message.

If session status is one of created, started or resubmission_requested, a decision webhook with expired/abandoned status will be sent. After successful request, session will immediately become unavailable in Veriff Customer Portal and via public API endpoints. Data will be deleted within 12 hours.

Rate-limit is: 10 sessions per 24 hours and 5 sessions per 1 hour.

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

Security

API Key: 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

Session id signed with the shared secret key

Path parameters

id

stringRequired

Session id

Responses

200

Session is deleted

Headers

x-auth-client

string

Your integration's API key. Required to identify the request or response sender. Occasionally referred to as the "API token".

x-hmac-signature

string

Response body signed with the shared secret key. Required to authenticate the response sender.

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

400

Bad request response

OneOf

DeleteSessionNotCompletedBadRequestErrorResponse

object (DeleteSessionNotCompletedBadRequestErrorResponse)

status

number

Valid values[ 400 ]

Example400.0

code

string

Example1305

message

string

ExampleSession is not in a completed status.

DeleteSessionInProgressBadRequestErrorResponse

object (DeleteSessionInProgressBadRequestErrorResponse)

status

number

Valid values[ 400 ]

Example400.0

code

string

Example1306

message

string

ExampleSession in progress.

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

429

Too many requests

object

status

string

Valid values[ "fail" ]

Examplefail

code

string

Example1004

message

string

ExampleToo many requests.

500

Internal server error

object

status

string

Valid values[ "fail" ]

Examplefail

code

string

Example1101

message

string

ExampleSomething went wrong

Document Versioning

Article Versioning

Date	Description
Oct 2, 2025	`vrf-` headers removed from response headers
Aug 6, 2025	Response headers added
Mar 12, 2025	Documentation published