Skip to content
/
Create a new Invitation

Create a new Invitation

Request

Creates a new Invitation resource.

Security
basic_auth
Bodyapplication/jsonrequired
packagestringrequired

slug of the associated package.

Example:"driver_pro"
candidate_idstringrequired

ID of the Candidate for whom the Invitation is created.

Example:"551564b7865af96a28b13f36"
nodestring

Required for hierarchy-enabled accounts.

custom_id of the associated node.

work_locationsArray of objects(WorkLocation)

Required for hierarchy-enabled accounts.

Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.

tagsArray of strings

Array of tags for the Report.

curl -i -X POST \
  -u '<username>:<password>' \
  https://docs.checkr.com/_mock/apis/openapi/invitations \
  -H 'Content-Type: application/json' \
  -d '{
    "package": "driver_pro",
    "candidate_id": "551564b7865af96a28b13f36",
    "node": "string",
    "work_locations": [
      {
        "country": "US",
        "state": "CA",
        "city": "San Francisco"
      }
    ],
    "tags": [
      "string"
    ]
  }'

Responses

Invitation was successfully created

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"invitation"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/invitations/e44aa283528e6fde7d542194"
invitation_urlstring

URL for the Invitation.

Example:"https://apply.checkr.com/invite/try-checkr/290f9d6d6e46/test"
statusstring

Status of the Invitation.

Enum:"pending""completed""expired"
Example:"pending"
created_atstring, (date-time)

Time at which the Invitation was created.

Example:"2015-05-14T17:45:34Z"
expires_atstring, (date-time)

Time at which the Invitation will expire.

Example:"2015-05-21T17:45:34Z"
completed_atstring or null, (date-time)

Time at which the Invitation was completed by the candidate.

Example:null
deleted_atstring or null

Time at which the Invitation was deleted.

Example:null
packagestring

Package associated with the Invitation.

Example:"driver_pro"
candidate_idstring

ID of the Candidate to whom the Invitation was sent.

Example:"551564b7865af96a28b13f36"
report_idstring or null

ID of the Report created by the completion of this Invitation. Will be null if the Invitation has not yet been completed.

Example:null
archivedboolean

Returns true if the invitation is archived.

Example:false
archived_infoobject

Information relating to an archived report or invitation

Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "invitation",
  "uri": "/v1/invitations/e44aa283528e6fde7d542194",
  "invitation_url": "https://apply.checkr.com/invite/try-checkr/290f9d6d6e46/test",
  "status": "pending",
  "created_at": "2015-05-14T17:45:34Z",
  "expires_at": "2015-05-21T17:45:34Z",
  "completed_at": null,
  "deleted_at": null,
  "package": "driver_pro",
  "candidate_id": "551564b7865af96a28b13f36",
  "report_id": null,
  "archived": false,
  "archived_info": {
    "time": "2023-08-29T23:15:34Z",
    "user": { … }
  }
}
© Checkr, Inc.