Skip to content

Retrieve an existing identity data evaluation

Request

Returns an existing identity data evaluation with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the identity data evaluation to retrieve.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/identity_data_evaluations/{id}'

Responses

identity data evaluation details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstring
Value:"identity_data_evaluation"
Example:"identity_data_evaluation"
uristring(ResourceURI)read-only

URI of the identity data evaluation.

Example:"/v1/identity_data_evaluations/9f82ebb23267477a606e0a9c"
statusstring

Status of the screening.

Enum:"pending""complete""canceled""suspended"
Example:"complete"
resultstring or null

Result of the screening.

Enum:"clear""consider"
Example:"clear"
assessmentstring or null(AssessmentAttribute)

The assessment for this screening. This field will be non-null only for Assess-enabled accounts. For accounts with Assess enabled, it will be null for reports completed before Assess was enabled, and null for a short time after report completion while the account's Assess rules are applied.

Enum:"eligible""review""escalated"
Example:"eligible"
created_atstring, (date-time)

Time at which the screening was created.

Example:"2014-01-18T12:34:00Z"
completed_atstring, (date-time)

Time at which the screening was completed.

Example:"2014-01-18T12:35:30Z"
turnaround_timeinteger

Number of seconds the screening took to complete, calculated from created_at to completed_at.

cancellation_reasonstring or null

See cancellation reasons section for possible values.

Example:"complete_now_customer_requested"
cancellation_reason_descriptionstring or null

See cancellation reasons section for possible values.

Example:"Customer requested Complete Now prior to screening completion"
ssn_riskobject or null

SSN risk data associated with the evaluation.

Response
{ "id": "e44aa283528e6fde7d542194", "object": "identity_data_evaluation", "uri": "/v1/identity_data_evaluations/9f82ebb23267477a606e0a9c", "status": "complete", "result": "clear", "assessment": "eligible", "created_at": "2014-01-18T12:34:00Z", "completed_at": "2014-01-18T12:35:30Z", "turnaround_time": 0, "cancellation_reason": "complete_now_customer_requested", "cancellation_reason_description": "Customer requested Complete Now prior to screening completion", "ssn_risk": { "id": "6dbba87999aac2b5deaf539f", "risk_flag": "inconsistent", "distinct_dobs": 2, "distinct_employers": 4, "distinct_full_names": 3, "total_usages_completed": 8, "internal_account_usages": [ … ], "external_account_usages": [ … ] } }