Create Profile API

AI Tools

Create a new profile for background checks

Introduction

Create profile API is the very first step in the background check process. This makes it easier to register a profile (a person or a company) in the system. Once registered, a profile can later be linked to other types of checks.

The legacy data processing model is being formally deprecated.

In order to ensure continued compliance with the Digital Personal Data Protection Act, 2023 (DPDP Act), we are implementing DPDP V3 (Consent-Driven Processing). Under this framework, clients are required to obtain explicit, informed, and verifiable consent from the data principal prior to accessing, processing, viewing, or storing any personal data through the platform. This regulatory transition may require modifications to existing configurations and workflows. Clients are advised to review and update their implementations to ensure ongoing compliance with applicable data protection obligations. Further information regarding this transition can be enquired here. Learn more about this change here.

API Details

Request

Type	URL
POST	https://api.attestr.com/api/`{version}`/public/factx/

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.

Request Body Parameters

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

Sample Request

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

Response Details

Http Status 200

Key	Description	Type	Min Version	Max Version
_id	Unique profile Id	String	v1
number	Unique human readable number to be used for any reference later	String	v1

{ "_id": "AX1LgghsxZsJZUwYvN", "number": "3801-575765-9695" }

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	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

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

Last updated on Feb 3, 2026