List screening runs for a case

get

https://example.com/v1/cases/{id}/screenings

About this API

To get the ins and outs of this API, please refer to our documentation page here

Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.

How to use this page?

Pick a preferred language on the right.
Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
Enter the required parameters below or try something yourself!
Click the Try It! button!

📘
You can also click one of the HTTP response codes at the bottom to see an example of that specific response!

Path Params

uuid

required

Case id (uuid). A non-uuid value yields 400 invalid_id with source.parameter id.

Query Params

filter[entityId]

uuid

Runs for one case entity only. A non-uuid value yields 400 invalid_parameter.

filter[entityType]

string

enum

Restrict to runs whose screened entity is of this type — serves the split Persons / Organisations views. unknown is not offered: an entity of unknown type cannot be screened, so no run can exist for one. Any other value yields 400 invalid_parameter.

Allowed:

filter[status]

string

enum

Run execution state. The provider layer of a run freezes once this reaches succeeded/failed; re-screening appends a new run and never mutates an old one.

Allowed:

filter[outcome]

string

enum

Filters on the computed outcome — e.g. needs_review for the officer's triage queue.

Allowed:

filter[resolution]

string

enum

The officer verdict itself, as stored. Distinct from filter[outcome], which composes status and match count in as well — resolution=pending includes runs still executing, outcome=needs_review does not.

Allowed:

page[number]

integer

≥ 1

Defaults to 1

1-based page number. A non-integer or out-of-range value yields 400 invalid_pagination.

page[size]

integer

1 to 100

Defaults to 20

Page size, 1 to 100. A non-integer or out-of-range value yields 400 invalid_pagination.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200Page of screening runs, newest first

400Non-uuid id (title invalid_id); an invalid filter value (title invalid_parameter, source.parameter names the offending filter); or non-integer / out-of-range pagination (title invalid_pagination).

401Missing CI-Subject-URN or CI-Request-Id, absent CI-Role header, or a subject URN not provisioned as a KYC user (title unauthenticated, source.header names the offending header).

404The resource does not exist — or belongs to another tenant, which is indistinguishable (title not_found).

500Unexpected server error (title internal_error).