Delete a questionnaire session

Purpose

Use this call to delete a questionnaire record on request. Erase session personal data does not destroy a questionnaire record that has no session; this call does.

Request

POST <API_BASE_URL>/kyc/questionnaire/session/delete. All calls are POST under your API address. Replace <API_BASE_URL> with the API address provided with your access.

Send a permanent API token in the token field of the body, or a user token in the token header. See authentication.

Content type: application/json.

Field	Type	Required	Description
`token`	string (uuid)	if no header	Your permanent API token. Required unless you send a user token in the `token` header.
`questionnaireSessionId`	string (uuid)	yes	The identifier of the record to delete.

Response

HTTP 200. The record was deleted.

Field	Type	Description
`status`	string	Always `ok` on this body. The body carries nothing else.

Errors

400: The body failed validation, or the record was not found, or it belongs to another account. The last two are deliberately indistinguishable.
401: The token is missing, expired or unknown.

A refusal can also come before the operation runs: an address outside your IP allowlist, a token bound to another address, or a body that is not valid JSON. See response format and errors.

Example

Request:

curl -X POST "<API_BASE_URL>/kyc/questionnaire/session/delete" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "<your permanent API token>",
    "questionnaireSessionId": "00000000-0000-0000-0000-000000000000"
  }'

Response:

{
  "status": "ok"
}