Professional License Verification

Use a Professional License Verification to verify a candidate's professional credentials.

Operations

Retrieve an existing Professional License Verification

Request

Returns an existing Professional License Verification with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the Professional License Verification to retrieve.

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

Responses

Professional License Verification details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstring

Value:"professional_license_verification"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/professional_license_verifications/5ee1b0c080c74df951ce6a59"

statusstring

Status of the screening.

Value:"pending"

Example:"consider"

resultstring or null

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:603216

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"

documentsArray of objects(Document)

An array of documents captured for the Professional License Verification.

certificationsArray of objects

An array of candidate input objects and license verification results objects.

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "professional_license_verification",
  "uri": "/v1/professional_license_verifications/5ee1b0c080c74df951ce6a59",
  "status": "consider",
  "result": "consider",
  "assessment": "eligible",
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "turnaround_time": 603216,
  "cancellation_reason": "complete_now_customer_requested",
  "cancellation_reason_description": "Customer requested Complete Now prior to screening completion",
  "documents": [
    { … }
  ],
  "certifications": [
    { … }
  ]
}