Skip to main content
POST
/
api
/
cases
Create Case
curl --request POST \
  --url https://api.example.com/api/cases/ \
  --header 'Content-Type: application/json' \
  --cookie sessionid= \
  --data '
{
  "customer_id": 123,
  "customer": {
    "full_name": "<string>",
    "external_id": "<string>",
    "customer_type": "INDIVIDUAL",
    "input_details": "<unknown>",
    "delete_after": 123
  },
  "webhook_url": "<string>",
  "notes": "<string>",
  "rfi": "<string>",
  "checks": [
    {
      "check_type": "PEP",
      "input_details": "<unknown>",
      "document_ids": [
        123
      ],
      "delete_after": 123
    }
  ],
  "document_ids": [
    123
  ],
  "delete_after": 123
}
'
{
  "customer_id": 123,
  "webhook_url": "https://example.com/webhook/case-complete",
  "delete_after": 30
}

Authorizations

​
sessionid
string
cookie
required

Body

Write serializer for GenericCase creation.

​
customer_id
integer

ID of an existing customer for this case

​
customer
object

Customer data to create a new customer with this case

​
webhook_url
string | null

Webhook sent on case completion.

Maximum string length: 511
​
notes
string

Notes for the case.

​
rfi
string | null

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

​
checks
object[]

A list of checks to create with this case.

​
document_ids
integer[]

List of document IDs to link to this case

​
delete_after
integer

Number of days until deletion. Max 365. For immediate deletion, use 0.

Response

201 - application/json

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.