Skip to main content
GET
/
api
/
checks
List Checks
curl --request GET \
  --url https://api.example.com/api/checks/ \
  --cookie sessionid=
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "case": {
        "id": 123,
        "customer": {
          "id": 123,
          "full_name": "<string>",
          "external_id": "<string>",
          "customer_type": "INDIVIDUAL"
        },
        "outcome": "ACCEPTED",
        "risk_score": 0.5
      },
      "risk_score": 123,
      "title": "<string>",
      "note": "<string>",
      "reasoning": "<string>",
      "outcome": "ACCEPTED",
      "status": "PENDING",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "input_details": "<unknown>",
      "check_type": "PEP",
      "delete_after": -1
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

sessionid
string
cookie
required

Query Parameters

case_id
integer

Filter by case ID

check_type
enum<string>

Filter by check type

Available options:
ADVERSE_MEDIA,
BLACKLIST,
FINANCIAL_STATEMENTS,
IDV,
INCORPORATION_DOC,
PEP,
PROOF_OF_ADDRESS,
PROOF_OF_FUNDS,
SANCTION,
SIGNATURE_AUTH,
THREE_MONTHS_BANK_STATEMENT,
TRANSACTION_MONITORING,
UBO_RESOLUTION,
UNDERWRITING,
WEB_PRESENCE
max_risk_score
number<float>

Maximum risk score

min_risk_score
number<float>

Minimum risk score

outcome
enum<string>

Filter by outcome

Available options:
ACCEPTED,
PENDING,
REJECTED
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"