Revoke Consent API

AI Tools

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

TypeURL
POSThttps://api.attestr.com/api/v3/public/consent/<_id>/revoke

Request URL Parameters

TypeNameDescriptionOption (default)Min VersionMax Version
String_idConsent ID as generated in Register Consent APIRequiredv3

Request Header Parameters

TypeNameValue / DescriptionOptionalMin VersionMax Version
StringContent-Typeapplication/jsonRequiredv3
StringAuthorizationBasic {authToken}Requiredv3

If you do not have the authentication token, please refer to Register App to generate one.

Sample Request Payload

CURL
Copy

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

ParameterTypeDescription
codeNumberUnique error codes for different errors. Always available.
httpStatusCodeStringStandard HTTP status code for the error
messageStringError message describing the error. Always Available.
detailsStringDetail error message. Available only for certain types of errors.

Error Codes

HTTP StatusError CodeError Message
4004001Malformed data or missing required parameter values
4004005Operation could not be performed due to low credits balance
4014016Invalid client authorization
4034031Unauthorized access
4034035Requested service is not provisioned for your account
4034039Client's IP address is not whitelisted
4034035Requested service is not provisioned for your account
4294291Maximum account rate limit exceeded
4294292Maximum API rate limit exceeded
4294293Maximum account daily limit exceeded
4294294Maximum API daily limit exceeded
5005001Request could not be processed

Sample Error Response

JSON
Copy

Get Free Trial

Create a free account Or “Talk to Us” for price information and other queries.

VariableType to search · ESC to discard
GlossaryType to search · ESC to discard
InsertType to search · ESC to discard
No matches
  Last updated