Skip to main content
DELETE/api/conversations/{conversationId}

Block access or delete data of the verification process

Creates the conversation deletion order in two available modes:

  • EXPIRE (default) - triggers the process of expiration of active conversation. After completing such an order, the conversation will be switched to the 'EXPIRED' status. The verification process will be blocked. This means that the user entering such a verification process will be automatically redirected to the 'returnUrl' address.
  • DELETE_DATA - triggers the process of data deletion from finished conversation. This mode should be used with caution, when you are sure that you do not expect any callbacks associated with the conversation as they may not be delivered.

Parameters

NameInTypeRequiredDescription
conversationIdpathstringRequired

Conversation ID

modequerystringOptional

Deletion mode

Responses

202

Accepted

402

Exhaustion of the plan or limitations related to non-payment

403

Forbidden

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

404

Conversation not found

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

409

Conflict

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

410

Conversation is unavailable

application/vnd.authologic.v1.1+json
statusstring required

Response status

messagestring required

Descriptive error message

violationsarray<object> required

Validation error list

Array of object

Validation error list

fieldstring required

Field name

messagestring required

Descriptive error message

statusDetailstring optional

Response status detailed information

500

Server side error

Powered by Authologic Nisaba