Skip to content

Create order

Request

Create a new screening order for an applicant against a property. The property and the applicant can each be supplied either inline (address / identity fields) — in which case a new record is created — or by id (property_id / applicant_id) to reuse an existing record. Provide exactly one form per side.

Security
bearer-token
Query
includestring

Comma-separated list of related objects to embed in the response. Supported values: property, applicant. By default only the property_id and applicant_id are returned.

Example:include=property,applicant
Headers
Idempotency-Keystring, [ 1 .. 255 ] charactersrequired

Unique, client-generated string (1–255 characters; a UUIDv4 is recommended) that identifies a single logical request. Reusing the same key replays the original response. Transient errors (5xx) are not replayed — retrying with the same key will re-execute the request. Generate a fresh key per logical request; only reuse it when retrying the same request.

Example:8e1bce8f-2a5e-4f7e-9f61-7e1f3e6e0c7b
Checkr-Tenant-Versionstring

CalVer-dated API version to pin behavior to (e.g. 2026-04-29). When omitted, the request is served by the newest supported version. Unknown values return 422.

Value:"2026-04-29"
Bodyapplication/jsonrequired

The request body for creating a new order. Each side of the order — the property and the applicant — can be supplied either inline (the address or identity fields) or by id (a previously created pr_… / ap_…). Provide exactly one form per side; sending both, or neither, returns a validation error.

orderobjectrequired

Attributes for the new order.

POST
/orders
curl -i -X POST \
  'https://tenant.checkr.com/api/orders?include=property%2Capplicant' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Checkr-Tenant-Version: 2026-04-29' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: 8e1bce8f-2a5e-4f7e-9f61-7e1f3e6e0c7b' \
  -d '{
    "order": {
      "package": "starter",
      "property_id": "pr_K9dM2pXqR4vN8tLZbWyHJa",
      "property": {
        "name": "Sunset Apartments",
        "street": "1234 Market St",
        "unit": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "zipcode": "94103"
      },
      "applicant_id": "ap_F3hQ7wEsLp2xBnVcRuMyTk",
      "applicant": {
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "add_on_products": [
        "identity_verification"
      ]
    }
  }'

Responses

Created

Bodyapplication/json
idstring

Unique identifier for the order. Use this value in subsequent API calls; it is stable for the lifetime of the order. Test-mode IDs carry a _test_ infix (e.g. ord_test_TUyYsLnyTbG3xv9hONJF7w); live-mode IDs have no infix.

Example:"ord_TUyYsLnyTbG3xv9hONJF7w"
live_modeboolean

Whether this order was created with a live API key (true) or a test API key (false). Test-mode orders are inert: they route to canned provider responses and do not produce billable activity. See Testing for details.

Example:true
statusstring

Current state of the order in its lifecycle:

  • waiting_for_applicant — invitation sent; awaiting the applicant's consent and information
  • pending — applicant submitted consent and information; screening is in progress
  • completed — screening is complete and the report is available
  • canceled — terminated before completion
Enum:"waiting_for_applicant""pending""completed""canceled"
packagestring

Slug of the screening package on the order, e.g. starter or essential.

add_on_productsArray of strings, unique

Slugs of add-on products run on the order in addition to the ones bundled into package. Sorted alphabetically; empty if none were requested.

Example:
[
  "identity_verification"
]
property_idstring

Identifier of the property record this order is screening for. Pass ?include=property to embed the full property object.

Example:"pr_K9dM2pXqR4vN8tLZbWyHJa"
applicant_idstring

Identifier of the applicant being screened. Pass ?include=applicant to embed the full applicant object.

Example:"ap_F3hQ7wEsLp2xBnVcRuMyTk"
application_urlstring or null, (uri)

Absolute URL for the applicant apply flow (https://…/apply/<token>). Returned only while the order status is waiting_for_applicant — for live-mode orders, and in test mode only for the Hudson Green applicant-experience profile (other test applicants auto-submit and skip the apply flow — see Testing). null when status is pending, completed, or canceled, and for ordinary test-mode profiles. When the apply flow runs, Checkr emails this link to the applicant; in live mode, if a phone number is present, Checkr also texts it. Integrators may share application_url themselves.

Example:"https://tenant.checkr.com/apply/K7P2MX"
propertyobject(property)

Embedded property object. Only returned when the request includes ?include=property.

applicantobject(applicant)

Embedded applicant object. Only returned when the request includes ?include=applicant.

created_atstring, (date-time)

Timestamp the order was accepted by the API.

completed_atstring or null, (date-time)

Timestamp the order reached the completed status. Null while in any earlier state, and remains null if the order is canceled.

canceled_atstring or null, (date-time)

Timestamp the order was canceled. Null unless the order was canceled.

Response
{
  "id": "ord_TUyYsLnyTbG3xv9hONJF7w",
  "live_mode": true,
  "status": "waiting_for_applicant",
  "package": "string",
  "add_on_products": [
    "identity_verification"
  ],
  "property_id": "pr_K9dM2pXqR4vN8tLZbWyHJa",
  "applicant_id": "ap_F3hQ7wEsLp2xBnVcRuMyTk",
  "application_url": "https://tenant.checkr.com/apply/K7P2MX",
  "property": {
    "id": "pr_K9dM2pXqR4vN8tLZbWyHJa",
    "name": "Sunset Apartments",
    "street": "1234 Market St",
    "unit": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "94103",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "applicant": {
    "id": "ap_F3hQ7wEsLp2xBnVcRuMyTk",
    "full_name": "Jane Public",
    "email": "jane@example.com",
    "first_name": "string",
    "last_name": "string",
    "dob": "1990-05-14",
    "phone_number": "+15551234567",
    "ssn": "XXX-XX-6789",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "canceled_at": "2019-08-24T14:15:22Z"
}