Create Case

curl --request POST \
  --url https://app.sphinxhq.com/api/cases/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": 123,
  "webhook_url": "<string>",
  "checks": [
    {
      "input_details": {},
      "document_ids": [
        123
      ],
      "delete_after": 123
    }
  ],
  "document_ids": [
    123
  ],
  "delete_after": 123,
  "assignee": "jsmith@example.com",
  "metadata": {},
  "sync_platforms": {},
  "case_config": "<string>",
  "auto_start": true,
  "external_id": "<string>"
}
'

import requests

url = "https://app.sphinxhq.com/api/cases/"

payload = {
    "customer_id": 123,
    "webhook_url": "<string>",
    "checks": [
        {
            "input_details": {},
            "document_ids": [123],
            "delete_after": 123
        }
    ],
    "document_ids": [123],
    "delete_after": 123,
    "assignee": "jsmith@example.com",
    "metadata": {},
    "sync_platforms": {},
    "case_config": "<string>",
    "auto_start": True,
    "external_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: 123,
    webhook_url: '<string>',
    checks: [{input_details: {}, document_ids: [123], delete_after: 123}],
    document_ids: [123],
    delete_after: 123,
    assignee: 'jsmith@example.com',
    metadata: {},
    sync_platforms: {},
    case_config: '<string>',
    auto_start: true,
    external_id: '<string>'
  })
};

fetch('https://app.sphinxhq.com/api/cases/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sphinxhq.com/api/cases/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => 123,
    'webhook_url' => '<string>',
    'checks' => [
        [
                'input_details' => [
                                
                ],
                'document_ids' => [
                                123
                ],
                'delete_after' => 123
        ]
    ],
    'document_ids' => [
        123
    ],
    'delete_after' => 123,
    'assignee' => 'jsmith@example.com',
    'metadata' => [
        
    ],
    'sync_platforms' => [
        
    ],
    'case_config' => '<string>',
    'auto_start' => true,
    'external_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sphinxhq.com/api/cases/"

	payload := strings.NewReader("{\n  \"customer_id\": 123,\n  \"webhook_url\": \"<string>\",\n  \"checks\": [\n    {\n      \"input_details\": {},\n      \"document_ids\": [\n        123\n      ],\n      \"delete_after\": 123\n    }\n  ],\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123,\n  \"assignee\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"sync_platforms\": {},\n  \"case_config\": \"<string>\",\n  \"auto_start\": true,\n  \"external_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sphinxhq.com/api/cases/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": 123,\n  \"webhook_url\": \"<string>\",\n  \"checks\": [\n    {\n      \"input_details\": {},\n      \"document_ids\": [\n        123\n      ],\n      \"delete_after\": 123\n    }\n  ],\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123,\n  \"assignee\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"sync_platforms\": {},\n  \"case_config\": \"<string>\",\n  \"auto_start\": true,\n  \"external_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sphinxhq.com/api/cases/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": 123,\n  \"webhook_url\": \"<string>\",\n  \"checks\": [\n    {\n      \"input_details\": {},\n      \"document_ids\": [\n        123\n      ],\n      \"delete_after\": 123\n    }\n  ],\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123,\n  \"assignee\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"sync_platforms\": {},\n  \"case_config\": \"<string>\",\n  \"auto_start\": true,\n  \"external_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "customer": {
    "external_id": "cust-jane-doe-1990",
    "full_name": "Jane Doe",
    "customer_type": "INDIVIDUAL",
    "input_details": {
      "dob": "1990-05-15",
      "nationality": "US"
    }
  },
  "case_config": "standard-kyc",
  "webhook_url": "https://example.com/webhook/case-complete"
}

Cases

Create Case

Create a new case for a customer. You can either provide an existing customer_id or create a new customer inline. By default, the case is automatically started after creation (equivalent to calling POST /cases//start/). Set auto_start=false to create without starting.

Customer matching: If a customer with the same external_id already exists in your organization, the existing customer is updated. All of full_name, customer_type, and input_details are replaced — omitted fields are set to null. If you only want to reuse the customer without changing it, pass customer_id instead.

POST

api

cases

Create Case

curl --request POST \
  --url https://app.sphinxhq.com/api/cases/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": 123,
  "webhook_url": "<string>",
  "checks": [
    {
      "input_details": {},
      "document_ids": [
        123
      ],
      "delete_after": 123
    }
  ],
  "document_ids": [
    123
  ],
  "delete_after": 123,
  "assignee": "jsmith@example.com",
  "metadata": {},
  "sync_platforms": {},
  "case_config": "<string>",
  "auto_start": true,
  "external_id": "<string>"
}
'

import requests

url = "https://app.sphinxhq.com/api/cases/"

payload = {
    "customer_id": 123,
    "webhook_url": "<string>",
    "checks": [
        {
            "input_details": {},
            "document_ids": [123],
            "delete_after": 123
        }
    ],
    "document_ids": [123],
    "delete_after": 123,
    "assignee": "jsmith@example.com",
    "metadata": {},
    "sync_platforms": {},
    "case_config": "<string>",
    "auto_start": True,
    "external_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: 123,
    webhook_url: '<string>',
    checks: [{input_details: {}, document_ids: [123], delete_after: 123}],
    document_ids: [123],
    delete_after: 123,
    assignee: 'jsmith@example.com',
    metadata: {},
    sync_platforms: {},
    case_config: '<string>',
    auto_start: true,
    external_id: '<string>'
  })
};

fetch('https://app.sphinxhq.com/api/cases/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sphinxhq.com/api/cases/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => 123,
    'webhook_url' => '<string>',
    'checks' => [
        [
                'input_details' => [
                                
                ],
                'document_ids' => [
                                123
                ],
                'delete_after' => 123
        ]
    ],
    'document_ids' => [
        123
    ],
    'delete_after' => 123,
    'assignee' => 'jsmith@example.com',
    'metadata' => [
        
    ],
    'sync_platforms' => [
        
    ],
    'case_config' => '<string>',
    'auto_start' => true,
    'external_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sphinxhq.com/api/cases/"

	payload := strings.NewReader("{\n  \"customer_id\": 123,\n  \"webhook_url\": \"<string>\",\n  \"checks\": [\n    {\n      \"input_details\": {},\n      \"document_ids\": [\n        123\n      ],\n      \"delete_after\": 123\n    }\n  ],\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123,\n  \"assignee\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"sync_platforms\": {},\n  \"case_config\": \"<string>\",\n  \"auto_start\": true,\n  \"external_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sphinxhq.com/api/cases/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": 123,\n  \"webhook_url\": \"<string>\",\n  \"checks\": [\n    {\n      \"input_details\": {},\n      \"document_ids\": [\n        123\n      ],\n      \"delete_after\": 123\n    }\n  ],\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123,\n  \"assignee\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"sync_platforms\": {},\n  \"case_config\": \"<string>\",\n  \"auto_start\": true,\n  \"external_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sphinxhq.com/api/cases/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": 123,\n  \"webhook_url\": \"<string>\",\n  \"checks\": [\n    {\n      \"input_details\": {},\n      \"document_ids\": [\n        123\n      ],\n      \"delete_after\": 123\n    }\n  ],\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123,\n  \"assignee\": \"jsmith@example.com\",\n  \"metadata\": {},\n  \"sync_platforms\": {},\n  \"case_config\": \"<string>\",\n  \"auto_start\": true,\n  \"external_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "customer": {
    "external_id": "cust-jane-doe-1990",
    "full_name": "Jane Doe",
    "customer_type": "INDIVIDUAL",
    "input_details": {
      "dob": "1990-05-15",
      "nationality": "US"
    }
  },
  "case_config": "standard-kyc",
  "webhook_url": "https://example.com/webhook/case-complete"
}

Authorizations

Authorization

string

header

required

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

Body

Write serializer for GenericCase creation.

customer_id

integer

write-only

ID of an existing customer for this case

customer

object

Customer data to create a new customer with this case

Show child attributes

webhook_url

string | null

Webhook sent on case completion.

Maximum string length: 511

checks

object[]

write-only

A list of checks to create with this case.

Show child attributes

document_ids

integer[]

write-only

List of document IDs to link to this case

delete_after

integer

Number of days until deletion. Use 0 for immediate deletion, or -1 for indefinite retention (never delete). Defaults to -1.

assignee

string<email> | null

write-only

Email of the user to assign this case to. Must be a member of the organization.

metadata

object | null

Case-specific details for display in UI. Flexible JSON object.

sync_platforms

object | null

External platform references for outbound sync. List of dicts, e.g. [{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}]

case_config

string

write-only

Slug of a CaseConfig or DualCaseConfig. For a CaseConfig, auto-generates checks from the config. Cannot be used together with 'checks'. For a DualCaseConfig (pairs KYB + KYC configs), creates a parent KYB case; when started, child KYC cases are auto-created for each shareholder extracted from documents.

auto_start

boolean

write-only

Whether to automatically start processing the case after creation. Defaults to true. Set to false to create a case without starting it (you can start it later via POST /cases/{id}/start/).

external_id

string | null

External ID for the case. Auto-generated UUID if not provided. Stable across reruns.

Maximum string length: 512

Response

201 - application/json

Read-only serializer for GenericCase with related objects.

integer

required

read-only

external_id

string

required

read-only

External ID for the case. Auto-generated UUID if not provided. Stable across reruns.

origin_url

string | null

required

read-only

Deprecated alias for external_id.

customer

object

required

Nested customer serializer for GenericCase responses.

Show child attributes

note

string | null

required

read-only

risk_score

number<double> | null

required

read-only

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

outcome

enum<string> | null

required

read-only

ACCEPTED - Accepted
REJECTED - Rejected
PENDING - Pending

Available options:

ACCEPTED,

REJECTED,

PENDING,

null

is_started

boolean

required

read-only

is_complete

boolean

required

read-only

failed

boolean

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

checks

object[]

required

read-only

Show child attributes

rfi

object | null

required

read-only

Show child attributes

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

metadata

object | null

Case-specific metadata in JSON format.

sync_platforms

object | null

External platform references for outbound sync. List of dicts, e.g. [{"domain": "bofi--dev.sandbox.my.salesforce.com", "id": "500WA..."}]

List Cases Get Case

⌘I

Start

Models

Cases

Checks

Customers

Documents

Events

oauth

Create Case

Authorizations

Body

Response