Skip to main content
POST
/
api
/
cases
/
{id}
/
start
Start or Rerun Case
curl --request POST \
  --url https://app.sphinxhq.com/api/cases/{id}/start/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "customer": {
    "id": 123,
    "full_name": "<string>",
    "external_id": "<string>",
    "customer_type": "INDIVIDUAL"
  },
  "note": "<string>",
  "risk_score": 123,
  "outcome": "ACCEPTED",
  "is_complete": true,
  "failed": true,
  "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": {},
      "check_type": "UBO_RESOLUTION",
      "delete_after": -1
    }
  ],
  "rfi": {
    "body": "<string>",
    "title": "<string>",
    "details": {}
  },
  "webhook_url": "<string>",
  "delete_after": -1
}

Authorizations

Authorization
string
header
required

OAuth2 access token obtained from POST /api/oauth/token/ using client credentials.

Path Parameters

id
integer
required

A unique integer value identifying this generic case.

Response

Read-only serializer for GenericCase with related objects.

id
integer
required
customer
object
required

Nested customer serializer for GenericCase responses.

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

Risk score (max of check risk scores for the case).

outcome
enum<string> | null
required
  • ACCEPTED - Accepted
  • REJECTED - Rejected
  • PENDING - Pending
Available options:
ACCEPTED,
REJECTED,
PENDING,
null
is_complete
boolean
required
failed
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
checks
object[]
required
rfi
object
required
webhook_url
string | null

Webhook sent on case completion.

Maximum string length: 511
delete_after
integer

Days until deletion. -1 means never delete.

Required range: -2147483648 <= x <= 2147483647