Redact an Account
Permanently deletes personally identifiable information (PII) for an Account and all associated Inquiries, Verifications and Reports. The response indicates a successful redaction of the Account. Redaction of the Account's associated child objects is done asynchronously and may take some time before all associated child objects are fully redacted. This action cannot be undone.
This endpoint can be used to comply with privacy regulations such as GDPR / CCPA or to enforce data privacy.
Note: An account is still updatable after redaction. If you want to delete data continuously, please reach out to us to help you setup a retention policy.
Request
- Base URL: https://api.withpersona.com/api/v1
- URL: https://api.withpersona.com/api/v1/accounts/{account-id}
- Auth: HTTP bearer
Path parameters
Query parameters
A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.
Headers
Determines casing for the API response.
Ensures the request is idempotent.
Server API version. More info on versioning can be found here.
Response
This endpoint returns an Account object and (optionally) its related objects in included.
Changes
No recorded changes to this operation across all 1 revision of this API.