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.

INTERESTED ?

To start a chat, click the button below, and one of our available executives will assist you with questions about onboarding and commercials.

Chat With Attestr Support

API Details

Request

TypeURL
GEThttps://api.attestr.com/api/{version}/public/factx/<profileId>

Request Header Parameters

TypeNameValue / DescriptionOptionalMin VersionMax Version
StringContent-Typeapplication/jsonRequiredv1
StringAuthorizationBasic {authToken}Requiredv1

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

Response Details

Http Status 200

TypeNameDescriptionMin VersionMax Version
String_idProfile Idv1
StringtagUnique reference number as assigned by the clientv1
StringnumberUnique reference number assigned by the Attestr platformv1
StringnameName of the profilev1
StringemailContact email addressv1
StringmobileContact numberv1
Array[VerificationItemObject]itemsArray of associated items to the profilev1
Array[QueryObject]queriesArray of follow up queries and responses posted on the profilev1
NumbercreatedUnix timestamp of profile creation timev1
StringcreatedByMember 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
StringcreatedByOrgaccount Idv1
StringclientApp Id if this profile was created using APIv1
NumberupdatedUnix timestamp when this profile was last updatedv1
StringupdatedByMember Id if the profile was updated by a member using the dashboard else nullv1

Verification Item Object

TypeKeyDescriptionMin VersionMax Version
String_idId of the verification itemv1
StringnumberUnique number assigned by Attestr to each verification itemv1
StringtypeType of the verification item e.g. EDUCATION, EMPLOYMENT etc.v1
ObjectinputPayload same as provided input for the respective verification item. This will be null if the profile is archived.v1
Array [ActivityObject]activityArray of review comments posted to the profilev1

Activity Object

TypeKeyDescriptionMin VersionMax Version
StringvalueInput review comment text postedv1
StringauthorMember name / API depending on if the review comment was added by a member using the dashboard or through the APIv1
NumbercreatedUnix timestamp of the review comment creationv1
StringcreatedByMember Id if the comment was created by a member using the dashboardv1
StringclientApp Id if the comment was added through APIv1

Query Object

TypeKeyDescriptionMin VersionMax Version
String_idThe unique Id for the query objectv1
StringtextQuery text to be shared with the candidatev1
String[]documentsArray of any documents attached to the query.v1
StringresponseThe response submitted to the query. Set as null for new unanswered follow up queries.v1
String[]responseDocumentsArray of supporting documents submitted while responding to the query.v1
NumbercreatedUnix timestamp of the query creationv1
NumbercreatedByCreated by member Id if available else nullv1
NumberupdatedUnix timestamp of last modified date for the queryv1
NumberupdatedByUpdated by member Id if available else nullv1

Sample Response

JSON
Copy

Error Response

ParameterTypeDescription
codeNumberUnique error codes for different errors. Always available.
messageStringError message describing the error. Always Available.
detailsStringDetail error message. Available only for certain types of errors.

Error Codes

HTTP StatusError CodeError Message
4004001Malformed data or missing required parameter values
4004003Request ID is invalid
4004005Operation could not be performed due to low credits balance
40040018Invalid profile Id or you do not have access to this record
4014016Invalid client authorization
4034031Unauthorized access
4034035Requested service is not provisioned for your account
4034039Client's IP address is not whitelisted
4034035Requested service is not provisioned for your account
4294291Maximum account rate limit exceeded
4294292Maximum API rate limit exceeded
4294293Maximum account daily limit exceeded
4294294Maximum API daily limit exceeded
5005001Request could not be processed

Sample Error Response

JSON
Copy

INTERESTED ?

To start a chat, click the button below, and one of our available executives will assist you with questions about onboarding and commercials.

Chat With Attestr Support
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard