Skip to content
Professional Reference Ve...
/
Retrieve an existing Prof...

Retrieve an existing Professional Reference Verification

Request

Returns an existing Professional Reference Verification with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the Professional Reference Verification to retrieve.

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

Responses

Professional Reference Verification details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"642f279b0ea616002e474daa"
objectstring
Value:"professional_reference_verifications"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/professional_reference_verifications/642f279b0ea616002e474daa"
statusstring(ScreeningStatus)

Status of the screening.

Enum:"complete""pending"
Example:"consider"
resultstring or null(ScreeningResult)

Result of the screening.

Enum:"clear""consider"
Example:"consider"
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.

Example:42
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"
namestring

Professional Reference's full name.

Example:"John Smith"
emailstring, (email)

Professional Reference's email address.

Example:"john.smith@gmail.com"
phonestring

Professional Reference's phone number.

Example:5555555555
relationshipstring

Relationship between Candidate and Professional Reference.

Example:"Manager"
questionsArray of objects

Array of questions and answers received from Professional Reference.

Response
{
  "id": "642f279b0ea616002e474daa",
  "object": "professional_reference_verifications",
  "uri": "/v1/professional_reference_verifications/642f279b0ea616002e474daa",
  "status": "consider",
  "result": "consider",
  "assessment": "eligible",
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "turnaround_time": 42,
  "cancellation_reason": "complete_now_customer_requested",
  "cancellation_reason_description": "Customer requested Complete Now prior to screening completion",
  "name": "John Smith",
  "email": "john.smith@gmail.com",
  "phone": 5555555555,
  "relationship": "Manager",
  "questions": [
    { … }
  ]
}
© Checkr, Inc.