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.
Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")
Session id signed with the shared secret key
Session id
Session is deleted
API request status
Verification object
UUID v4 which identifies the verification session
Bad request response
Unauthorized
Session not found
Too many requests
Internal server error