Create Screen

Runs a risk screen on one person and returns the result. Requires the Screen API to be enabled for your organization. Include interstitial.redirect_url to run the screen in interstitial mode instead: the response has status requires_action and a next_action.url to send the person to; poll GET /screens/{id} for the verdict once they finish. Send an Idempotency-Key to make retries safe: a repeated key returns the original screen with a 201, a repeated key whose screen is still running returns a 409 (retry later), a repeated key with a different external_id returns a 422, and a repeated key whose original request failed returns the same error status as that request. A request rejected before the screen is created (invalid input, 422) creates nothing, so the same key can be retried once corrected. All fields go in the JSON body; a request with a query string is rejected with a 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Your identifier for this screen. Required, 1-255 characters. Returned unchanged on every read.

identity
object
required
interstitial
object | null
Headers
string

Optional, 1-255 characters. Reusing a key returns the screen created by the first request, a 409 while it is still processing, a 422 if the external_id differs, or the original error status if that request failed.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json