
Title
Create new category
Edit page index title
Edit category
Edit link
Revoke Consent API
API To Revoke Consent And Associated Data On Attestr Platform
The Revoke Consent API allows customers to withdraw a previously registered consent and discontinue any future processing, verification, storage, sharing, or reporting activities associated with that consent. Once a consent is successfully revoked, it can no longer be used to perform any further operations on the Attestr platform. Depending on the configured data retention and deletion policies, associated data may be deleted, anonymised, or archived in accordance with applicable regulatory and contractual requirements. The API also creates an auditable lifecycle event, enabling customers to maintain a complete record of consent creation, modification, and revocation activities for compliance and governance purposes.
API Definition
Request
| Type | URL |
|---|---|
| POST | https://api.attestr.com/api/v3/public/consent/<_id>/revoke |
Request URL Parameters
| Type | Name | Description | Option (default) | Min Version | Max Version |
|---|---|---|---|---|---|
| String | _id | Consent ID as generated in Register Consent API | Required | v3 |
Request Header Parameters
| Type | Name | Value / Description | Optional | Min Version | Max Version |
|---|---|---|---|---|---|
| String | Content-Type | application/json | Required | v3 | |
| String | Authorization | Basic {authToken} | Required | v3 |
If you do not have the authentication token, please refer to Register App to generate one.
Sample Request Payload
xxxxxxxxxxcurl --location --request POST 'https://api.attestr.com/api/v3/public/consent/CX3RnblcrFw4smjIM6/revoke' \--header 'Authorization: Basic your_auth_token' \--header 'Content-Type: application/json'Response
Http Status 200
200 status code indicates that the revocation request has been successfully enqueued. The data cleanup activity is performed through automated jobs thereafter.
Error Response
| Parameter | Type | Description |
|---|---|---|
| code | Number | Unique error codes for different errors. Always available. |
| httpStatusCode | String | Standard HTTP status code for the error |
| message | String | Error message describing the error. Always Available. |
| details | String | Detail error message. Available only for certain types of errors. |
Error Codes
| HTTP Status | Error Code | Error Message |
|---|---|---|
| 400 | 4001 | Malformed data or missing required parameter values |
| 400 | 4005 | Operation could not be performed due to low credits balance |
| 401 | 4016 | Invalid client authorization |
| 403 | 4031 | Unauthorized access |
| 403 | 4035 | Requested service is not provisioned for your account |
| 403 | 4039 | Client's IP address is not whitelisted |
| 403 | 4035 | Requested service is not provisioned for your account |
| 429 | 4291 | Maximum account rate limit exceeded |
| 429 | 4292 | Maximum API rate limit exceeded |
| 429 | 4293 | Maximum account daily limit exceeded |
| 429 | 4294 | Maximum API daily limit exceeded |
| 500 | 5001 | Request could not be processed |
Sample Error Response
xxxxxxxxxx{ "httpStatusCode": 400, "code": 4001, "message": "Malformed data or missing required parameter values", "appError": true}Copyright © Attestr