INTERESTED ?
Create Profile API
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.
To start a chat, click the button below, and one of our available executives will assist you with questions about onboarding and commercials.
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 |
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 | Max 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 | 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"}INTERESTED ?
To start a chat, click the button below, and one of our available executives will assist you with questions about onboarding and commercials.