Skip to main content
GET
Get ID Check

Authorizations

x-api-key
string
header
required

Each key carries scopes chosen when it is created: candidates:read, candidates:write, assessments:read, assessments:write, problems:read, problems:write, results:read, id_checks:read, id_checks:write. Keys created before scopes existed have full access. A request with a key that lacks an operation's scope returns 403 naming the missing scope.

Path Parameters

idCheckId
string
required

The ID check identifier

Response

ID check

id
string
required

The ID check identifier.

candidateId
string
required
status
enum<string>
required

sent: emailed, not started. in_progress: the candidate is verifying or retrying. processing: awaiting the decision. verified, failed, expired and canceled are final.

Available options:
sent,
in_progress,
processing,
verified,
failed,
expired,
canceled
failure
object | null
required

Why the check or attempt failed. Null unless it failed.

attemptCount
integer
required

Decided verification sessions. Each one is billed.

maxRetries
integer
required
attempts
object[]
required

Verification sessions, oldest first.

continuity
object | null
required

Face continuity across the candidate's screens, from their latest Scout run. Null until Scout has run.

metadata
object
required
createdAt
string<date-time>
required
expiresAt
string<date-time>
required
completedAt
string<date-time> | null
required