POST /screenings

Screens a guest without creating a verification against a reservation.

Before integrating

Five things to watch out for

  1. A screening carries a guest and nothing else. There is no company, listing, reservation or protection. Because there is no reservation there is no channel, so none of the OTA rules described on Create a verification request apply here.
  2. Supply an email address, a telephone number, or both. That is the whole contact rule. It does not vary by anything.
  3. A screening that is rejected or flagged still returns HTTP 200. The status code says whether the request was processed, not what the outcome was. The outcome is carried by verification.status, which is Approved, Rejected or Flagged.
  4. A screening cannot be modified or cancelled. It can be read back with Retrieve a verification request, using the verificationId the response returns, which is also the reference to quote when support is needed.
  5. echoToken is shared with every other operation. A token used on a create, modify or cancel cannot be reused here, and vice versa: there is one idempotency space across the whole API.

Request

Content-Type: application/json, with the subscription key in the Ocp-Apim-Subscription-Key header.

The body carries two objects, both required: metadata and guest.

For a string field, the Format column below describes what the value must contain, not the JSON type it must be sent as.

timeStamp is the only date field on this contract, and is matched exactly as yyyy-MM-ddTHH:mm:ss.ff, with no timezone designator, exactly two fractional-second digits, T as the separator.

metadata

Level Field Name Required Format Value Set Description
1 metadata True object Carries timeStamp and echoToken. Sent on every request and echoed on every response and error.
2 timeStamp True date-time yyyy-MM-ddTHH:mm:ss.ff Timestamp in ISO format yyyy-MM-ddTHH:mm:ss.ff, for example 2026-09-03T14:31:07.42. On a request this is the client's; on a response and on an error it is the server's.
2 echoToken True string 36 Char A GUID of exactly 36 characters, unique to the request. Reusing one returns 400, which makes retries safe. Responses and errors echo back the token the client sent, or 'Unknown' when it could not be read (a body the parser rejects, or one without metadata) and on some unexpected errors (500).

guest

Level Field Name Required Format Value Set Description
1 guest True object The guest being screened.
2 firstName True string 1-100 Char Guest's first name. 1-100 characters.
2 lastName True string 1-100 Char Guest's last name. 1-100 characters.
2 email Conditional string 6-254 Char Guest's email address, 6-254 characters. Required only when no telephoneNumber is supplied.
2 telephoneNumber Conditional string 6-20 Char Guest's telephone number. The leading + is optional, and must not be used with a number starting 0. At least 6 digits, and at most 20 characters including the + when present. Required only when no email is supplied.

A value that is empty or made only of spaces counts as not supplied. A valid email address together with a blank telephone number is accepted.

Example request