An invitation

Path parameters

Response fields

invitation

object. The invitation.

invitation.id

uuid. The invitation's id.

invitation.email

string. The address invited.

invitation.status

one of open, accepted, declined, expired, withdrawn. Where it stands. An unanswered invitation past its date reads expired.

invitation.sponsored

boolean. The organisation pays for the candidate's verification.

invitation.position_id

uuid or null. The position it was sent for; null for none.

invitation.candidate_id

uuid or null. The grant once accepted: the id for /candidates/{id}.

invitation.custom_data

object or null. Your own data on the invitation, as you sent it; null for none.

invitation.created_at

string. When it was sent (ISO 8601).

invitation.expires_at

string or null. When an unanswered invitation expires (ISO 8601).

checklist

array of object or null. The candidate's checklist once accepted; null before.

checklist[].key

string. The item: identity, work_history, education, certifications, roles, languages, right_to_work, contact or birth_date.

checklist[].state

one of ready, waiting, missing. ready: in; waiting: asked, not back yet; missing: the candidate still has to add or ask for it.

checklist[].counts

object. How many of the item's parts are in, such as {"ready": 3, "total": 4}.

checklist[].detail

string or null. What the item needs, where it says more than its state.

Errors

• 404 invite.not_found
• 400 api.credential_in_url
• 401 api.key_invalid
• 401 api.key_expired
• 401 api.key_revoked
• 401 api.key_suspended
• 403 api.scope_missing
• 429 api.rate_limited