Skip to main content
GET
/
api
/
checks
/
{id}
Get Check
curl --request GET \
  --url https://api.example.com/api/checks/{id}/ \
  --cookie sessionid=
{
  "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
}

Authorizations

​
sessionid
string
cookie
required

Path Parameters

​
id
integer
required

Response

200 - application/json

Read-only serializer for Check with related objects.

​
id
integer
required
​
case
object
required

Nested case serializer for Check responses.

​
risk_score
number<double> | null
required

Risk score from 0.0 to 1.0, typically used for automated actions.

​
title
string | null
required

Short title generated by the check. For a watchlist hit, this typically corresponds to the name of the hit indvidual.

​
note
string | null
required

1-2 paragraph case note for audit purposes, Markdown format

​
reasoning
string | null
required

Detailed reasoning steps, in Markdown. More comprehensive than the note.

​
outcome
required

The agent's decision.

  • ACCEPTED - Accepted
  • REJECTED - Rejected
  • PENDING - Pending
Available options:
ACCEPTED,
REJECTED,
PENDING
​
status
enum<string>
required
  • PENDING - Pending
  • PROCESSING - Processing
  • COMPLETED - Completed
  • ERROR - Error
Available options:
PENDING,
PROCESSING,
COMPLETED,
ERROR
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
input_details
any | null

Flexible JSON format. For example, for a sanctions hit, this would include the name, date of birth, etc of the watchlist individual. Absolutely no customer details may be present here.

​
check_type
  • PEP - Pep
  • SANCTION - Sanction
  • BLACKLIST - Blacklist
  • ADVERSE_MEDIA - Adverse Media
  • IDV - IDV
  • WEB_PRESENCE - Web Presence
  • UBO_RESOLUTION - UBO Resolution
  • THREE_MONTHS_BANK_STATEMENT - Three Months Bank Statement
  • INCORPORATION_DOC - Incorporation Document
  • PROOF_OF_ADDRESS - Proof of Address
  • PROOF_OF_FUNDS - Proof of Funds
  • SIGNATURE_AUTH - Signature Authorization
  • FINANCIAL_STATEMENTS - Financial Statements
  • UNDERWRITING - Underwriting
  • TRANSACTION_MONITORING - Transaction Monitoring
Available options:
PEP,
SANCTION,
BLACKLIST,
ADVERSE_MEDIA,
IDV,
WEB_PRESENCE,
UBO_RESOLUTION,
THREE_MONTHS_BANK_STATEMENT,
INCORPORATION_DOC,
PROOF_OF_ADDRESS,
PROOF_OF_FUNDS,
SIGNATURE_AUTH,
FINANCIAL_STATEMENTS,
UNDERWRITING,
TRANSACTION_MONITORING
​
delete_after
integer

Days until deletion.

Required range: -2147483648 <= x <= 2147483647