Update Profile API

AI Tools

Update profile basic information for background checks

Introduction

Use this API to update the basic info a profile created earlier. For creating a profile, refer to Create Profile API

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

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.

Type	Name	Description	Optional (default)	Min Version
String	tag	Unique employee Id / reference id to be passed by the client	Required	v1
String	name	Name of the asset (individual or business)	Required	v1
String	email	Optional contact email field	Optional	v1
String	mobile	Optional contact mobile field (E.164 format)	Optional	v1

{ "tag":"AA-1234", "name":"Gitanjali Raheja", "email":"gitanjali.raheja@gmail.com", "mobile":"+918888999978" }

Http Status 200

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.

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
400	40018	Invalid profile Id or you do not have access to this record
400	40038	Profile is archived already, operation not allowed
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

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

Last updated on Aug 20, 2022