post
https://sandbox.treeforttech.com/api/client/cancel-verification
This endpoint is used to cancel the ID verification request sent to a client. Cancelling the request will expire the link to the client that is needed to begin the ID verification process.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Schema
| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Standard HTTP response code. Status codes are outlined in the Errors section of this API reference. |
| message | String | A human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference. |
| data | Boolean | True indicates that the ID verification request was cancelled and the link was expired. False indicates that the ID verification was not successfully cancelled and the link was not expired. |
| errors | Array of Strings | An array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code. |