INTERESTED ?
Get Profile API
Retrieve a background check profile by profile Id
Introduction
Use this API to fetch the profile details of a given background check profile Id. This API only returns the list of associated items. To retrieve the individual verification item result, refer to the respective verification API documentation.
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 |
---|---|
GET | https://api.attestr.com/api/{version} /public/factx/<profileId> |
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.
Response Details
Http Status 200
Type | Name | Description | Min Version | Max Version |
---|---|---|---|---|
String | _id | Profile Id | v1 | |
String | tag | Unique reference number as assigned by the client | v1 | |
String | number | Unique reference number assigned by the Attestr platform | v1 | |
String | name | Name of the profile | v1 | |
String | Contact email address | v1 | ||
String | mobile | Contact number | v1 | |
Array[VerificationItemObject] | items | Array of associated items to the profile | v1 | |
Array[QueryObject] | queries | Array of follow up queries and responses posted on the profile | v1 | |
Number | created | Unix timestamp of profile creation time | v1 | |
String | createdBy | Member Id if the profile was created by a member from the dashboard. For the profiles which are created using API, the createdBy field value will be null. | v1 | |
String | createdByOrg | account Id | v1 | |
String | client | App Id if this profile was created using API | v1 | |
Number | updated | Unix timestamp when this profile was last updated | v1 | |
String | updatedBy | Member Id if the profile was updated by a member using the dashboard else null | v1 |
Verification Item Object
Type | Key | Description | Min Version | Max Version |
---|---|---|---|---|
String | _id | Id of the verification item | v1 | |
String | number | Unique number assigned by Attestr to each verification item | v1 | |
String | type | Type of the verification item e.g. EDUCATION, EMPLOYMENT etc. | v1 | |
Object | input | Payload same as provided input for the respective verification item. This will be null if the profile is archived. | v1 | |
Array [ActivityObject] | activity | Array of review comments posted to the profile | v1 |
Activity Object
Type | Key | Description | Min Version | Max Version |
---|---|---|---|---|
String | value | Input review comment text posted | v1 | |
String | author | Member name / API depending on if the review comment was added by a member using the dashboard or through the API | v1 | |
Number | created | Unix timestamp of the review comment creation | v1 | |
String | createdBy | Member Id if the comment was created by a member using the dashboard | v1 | |
String | client | App Id if the comment was added through API | v1 |
Query Object
Type | Key | Description | Min Version | Max Version |
---|---|---|---|---|
String | _id | The unique Id for the query object | v1 | |
String | text | Query text to be shared with the candidate | v1 | |
String[] | documents | Array of any documents attached to the query. | v1 | |
String | response | The response submitted to the query. Set as null for new unanswered follow up queries. | v1 | |
String[] | responseDocuments | Array of supporting documents submitted while responding to the query. | v1 | |
Number | created | Unix timestamp of the query creation | v1 | |
Number | createdBy | Created by member Id if available else null | v1 | |
Number | updated | Unix timestamp of last modified date for the query | v1 | |
Number | updatedBy | Updated by member Id if available else null | v1 |
Sample Response
{
"_id": "AX1kTmPZVyl51ZoY2O",
"tag": "AA-1234",
"number": "3883-608712-3987",
"name": "Gitanjali Raheja",
"mobile": null,
"email": "gitanjali.raheja@gmail.com",
"items": [ ],
"queries": [ ],
"created": 1661026598177,
"createdBy": null,
"createdByOrg": "OX02zfeuvt8akkilm7kpt",
"client": "AC02zfeuvg8qksd36sou",
"updated": 1661026667058,
"updatedBy": null
}
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 |
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.
