Archive Profile API

AI Tools

Archive a profile and purge associated data from Attestr

Introduction

Utilize this API to archive / purge data from a profile. This operation removes all verification items associated to a profile along with any media linked to it. This operation is irreversible.

API Details

Request

Type	URL
PUT	https://api.attestr.com/api/`{version}`/public/factx/<profileId>/archive

Request Header Parameters

Type	Name	Value / Description	Optional	Min Version	Max Version
String	Content-Type	application/json	Required	v1
String	Authorization	Basic `{authToken}`	Required	v1

Info

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

Response Details

Http Status 200

Error Response

Parameter	Type	Description
code	Number	Unique error codes for different errors. Always available.
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	4003	Request ID is invalid
400	4005	Operation could not be performed due to low credits balance
400	40018	Invalid profile Id or you do not have access to this record
400	40038	Profile is archived already, operation not allowed
400	40039	Async request type {type} can not be associated to the background check profile
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

{ "code": 4001, "message": "Malformed data or missing required parameter values" }

Last updated on Aug 20, 2022