Skip to main content
POST
/
api
/
cases
/
{id}
/
start
Start or Rerun Case
curl --request POST \
  --url https://api.example.com/api/cases/{id}/start/ \
  --cookie sessionid=
{
  "id": 123,
  "customer": {
    "id": 123,
    "full_name": "<string>",
    "external_id": "<string>",
    "customer_type": "INDIVIDUAL"
  },
  "notes": "<string>",
  "risk_score": 123,
  "outcome": "ACCEPTED",
  "status": "PENDING",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "checks": [
    {
      "id": 123,
      "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
    }
  ],
  "webhook_url": "<string>",
  "delete_after": -1,
  "rfi": "<string>"
}

Authorizations

sessionid
string
cookie
required

Path Parameters

id
integer
required

Response

Read-only serializer for GenericCase with related objects.

id
integer
required
customer
object
required

Nested customer serializer for GenericCase responses.

notes
string | null
required
risk_score
number<double> | null
required

Risk score from 0.0 to 1.0.

outcome
required
  • 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
checks
object[]
required
webhook_url
string | null

Webhook sent on case completion.

Maximum string length: 511
delete_after
integer

Days until deletion.

Required range: -2147483648 <= x <= 2147483647
rfi
string | null

Request for Information as text. Default to an email to be sent to the end user.