Get a check
GET/v1/checks/{check_id}
Parameters
| Field | Type | Required |
|---|---|---|
check_idpath | string (uuid) | yes |
Responses
200CheckResult400401403404409412413415422428429503
API reference
Checks
Individual checks of a case with outcomes, reasons and evidence.
Get a screening explanation
GET/v1/checks/{check_id}/screening-explanation
Parameters
| Field | Type | Required |
|---|---|---|
check_idpath | string (uuid) | yes |
Responses
200ScreeningExplanation400401403404409412413415422428429503
Rerun a screening check
POST/v1/cases/{case_id}/checks/{kind}/rerun
Repeats screening of a case under manual review without refuting a match, for example when the list snapshot became stale before the decision. Only a screening kind executed by the case policy; If-Match is the case ETag. Creates a new attempt over the current active snapshots with its own explanation package; the review task stays open and an approval still requires the new result to pass.
Parameters
| Field | Type | Required |
|---|---|---|
case_idpath | string (uuid) | yes |
kindpath | enum: person_screening, company_screening | yes |
Request bodyReasonAction
| Field | Type | Required |
|---|---|---|
reason_code | string | yes |
note | string | no |
Responses
201CheckResult400401403404409412413415422428429503