Create Check

curl --request POST \
  --url https://app.sphinxhq.com/api/checks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "case_id": 123,
  "input_details": {},
  "document_ids": [
    123
  ],
  "delete_after": 123
}
'

import requests

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

payload = {
    "case_id": 123,
    "input_details": {},
    "document_ids": [123],
    "delete_after": 123
}
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({case_id: 123, input_details: {}, document_ids: [123], delete_after: 123})
};

fetch('https://app.sphinxhq.com/api/checks/', 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/checks/",
  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([
    'case_id' => 123,
    'input_details' => [
        
    ],
    'document_ids' => [
        123
    ],
    'delete_after' => 123
  ]),
  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/checks/"

	payload := strings.NewReader("{\n  \"case_id\": 123,\n  \"input_details\": {},\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123\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/checks/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"case_id\": 123,\n  \"input_details\": {},\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"case_id\": 123,\n  \"input_details\": {},\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123\n}"

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

{
  "case_id": 123,
  "check_type": "PEP",
  "input_details": {
    "person_name": "Mustafa Nüvit Özkan",
    "match_type": "Exact name match",
    "institution_type": "International Representatives",
    "position": "Honorary Consul",
    "country": "Turkey",
    "nationality": "Norway",
    "source": "1. Turkey Foreign Diplomatic Missions - Norway",
    "source_url": "https://cd.mfa.gov.tr/mission/mission-list?clickedId=3"
  }
}

POST

api

checks

Create Check

curl --request POST \
  --url https://app.sphinxhq.com/api/checks/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "case_id": 123,
  "input_details": {},
  "document_ids": [
    123
  ],
  "delete_after": 123
}
'

import requests

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

payload = {
    "case_id": 123,
    "input_details": {},
    "document_ids": [123],
    "delete_after": 123
}
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({case_id: 123, input_details: {}, document_ids: [123], delete_after: 123})
};

fetch('https://app.sphinxhq.com/api/checks/', 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/checks/",
  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([
    'case_id' => 123,
    'input_details' => [
        
    ],
    'document_ids' => [
        123
    ],
    'delete_after' => 123
  ]),
  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/checks/"

	payload := strings.NewReader("{\n  \"case_id\": 123,\n  \"input_details\": {},\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123\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/checks/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"case_id\": 123,\n  \"input_details\": {},\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"case_id\": 123,\n  \"input_details\": {},\n  \"document_ids\": [\n    123\n  ],\n  \"delete_after\": 123\n}"

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

{
  "case_id": 123,
  "check_type": "PEP",
  "input_details": {
    "person_name": "Mustafa Nüvit Özkan",
    "match_type": "Exact name match",
    "institution_type": "International Representatives",
    "position": "Honorary Consul",
    "country": "Turkey",
    "nationality": "Norway",
    "source": "1. Turkey Foreign Diplomatic Missions - Norway",
    "source_url": "https://cd.mfa.gov.tr/mission/mission-list?clickedId=3"
  }
}

Authorizations

Authorization

string

header

required

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

Body

Write serializer for Check creation.

case_id

integer

required

write-only

ID of the case for this check

check_type

enum<string> | null

UBO_RESOLUTION - UBO Resolution
SIGNING_AUTHORITY - Signing Authority
BANK_STATEMENT - Bank Statements
BALANCE_SHEETS - Balance Sheets
INCOME_STATEMENTS - Income Statements
TAX_DOCUMENTS - Tax Documents
AUTHORIZATION_FORM - Authorization Form
ARTICLES_OF_ASSOCIATION - Articles of Association
COMMERCIAL_EXTRACT - Commercial Extract
ONBOARDING_FORM - Onboarding Form
SHAREHOLDER_LIST - Shareholder List
EDD_QUESTIONNAIRE - Enhanced Due Diligence Questionnaire
USER_RISK_REPORT - User Risk Report
RISK_DECISION - Risk Decision
INCORPORATION_DOCUMENT - Incorporation Document
MEETING_MINUTES - Meeting Minutes
PROOF_OF_IDENTITY - Proof of Identity
FULL_IDV - Full IDV
SOURCE_OF_FUNDS - Source of Funds
NAME_CHECK - Name Check
PROOF_OF_ADDRESS - Proof of Address
RDC_VERIFICATION - RDC Verification
KYB_PROOF_OF_IDENTITY - Proof of Identity
KYB_BANK_STATEMENT - Bank Statements
KYB_PROOF_OF_ADDRESS - Proof of Address
KYB_TAX_DOCUMENTS - Tax Documents
CLEAN_SCREENING - Clean Screening
CRA - Customer Risk Assessment
WEB_PRESENCE - Web Presence
FINANCIAL_LICENSE - Financial License
AML_POLICY - AML Policy Documents
WOLFSBERG_QUESTIONNAIRE - Wolfsberg Questionnaire
PEP - PEP
SANCTIONS - Sanctions
ADVERSE_MEDIA - Adverse Media
BLACKLIST - Blacklist
NAME_MATCHING - Name Matching
MULTI_WATCHLIST - Multi-Watchlist
PEP_SEARCH - PEP Search
SANCTIONS_SEARCH - Sanctions Search
ADVERSE_MEDIA_SEARCH - Adverse Media Search
BLACKLIST_SEARCH - Blacklist Search
DOCUMENT_FRAUD - Document Fraud
TM_CRYPTO - Transaction Monitoring (Crypto)
TM_CLASSIC - Transaction Monitoring (Fiat)
IDV - IDV
TRANSACTION_MONITORING - Transaction Monitoring
INFO_BLOCK - Information

Available options:

UBO_RESOLUTION,

SIGNING_AUTHORITY,

BANK_STATEMENT,

BALANCE_SHEETS,

INCOME_STATEMENTS,

TAX_DOCUMENTS,

AUTHORIZATION_FORM,

ARTICLES_OF_ASSOCIATION,

COMMERCIAL_EXTRACT,

ONBOARDING_FORM,

SHAREHOLDER_LIST,

EDD_QUESTIONNAIRE,

USER_RISK_REPORT,

RISK_DECISION,

INCORPORATION_DOCUMENT,

MEETING_MINUTES,

PROOF_OF_IDENTITY,

FULL_IDV,

SOURCE_OF_FUNDS,

NAME_CHECK,

PROOF_OF_ADDRESS,

RDC_VERIFICATION,

KYB_PROOF_OF_IDENTITY,

KYB_BANK_STATEMENT,

KYB_PROOF_OF_ADDRESS,

KYB_TAX_DOCUMENTS,

CLEAN_SCREENING,

CRA,

WEB_PRESENCE,

FINANCIAL_LICENSE,

AML_POLICY,

WOLFSBERG_QUESTIONNAIRE,

PEP,

SANCTIONS,

ADVERSE_MEDIA,

BLACKLIST,

NAME_MATCHING,

MULTI_WATCHLIST,

PEP_SEARCH,

SANCTIONS_SEARCH,

ADVERSE_MEDIA_SEARCH,

BLACKLIST_SEARCH,

DOCUMENT_FRAUD,

TM_CRYPTO,

TM_CLASSIC,

IDV,

TRANSACTION_MONITORING,

INFO_BLOCK,

null

input_details

object | null

Flexible JSON format. No customer details may be present here.

document_ids

integer[]

write-only

List of document IDs to link to this check

delete_after

integer

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

Response

201 - application/json

Read-only serializer for Check with related objects.

integer

required

read-only

case

object

required

Nested case serializer for Check responses.

Show child attributes

risk_score

number<double> | null

required

read-only

Risk score (total or average of CRA field scores, depending on aggregation method).

title

string | null

required

read-only

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

note

string | null

required

read-only

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

reasoning

string[] | null

required

read-only

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

outcome

enum<string> | null

required

read-only

The agent's decision.

ACCEPTED - Accepted
REJECTED - Rejected
PENDING - Pending

Available options:

ACCEPTED,

REJECTED,

PENDING,

null

status

enum<string>

required

read-only

PENDING - Pending
DECIDING - Deciding
DECIDED - Decided
SUBMITTED - Submitted
SKIPPED - Skipped
ERROR - Error

Available options:

PENDING,

DECIDING,

DECIDED,

SUBMITTED,

SKIPPED,

ERROR

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

input_details

object | null

Flexible JSON input data for this check, scoped to its own case: external-system data (e.g. the name and date of birth of a watchlist hit), ingested infractions, and enrichment-produced context — which may include this case's customer data such as transaction history. Must never contain data about other customers or cases, or any credentials/secrets. Note: this field is exposed via the case read API and webhooks.

check_type

enum<string> | null

UBO_RESOLUTION - UBO Resolution
SIGNING_AUTHORITY - Signing Authority
BANK_STATEMENT - Bank Statements
BALANCE_SHEETS - Balance Sheets
INCOME_STATEMENTS - Income Statements
TAX_DOCUMENTS - Tax Documents
AUTHORIZATION_FORM - Authorization Form
ARTICLES_OF_ASSOCIATION - Articles of Association
COMMERCIAL_EXTRACT - Commercial Extract
ONBOARDING_FORM - Onboarding Form
SHAREHOLDER_LIST - Shareholder List
EDD_QUESTIONNAIRE - Enhanced Due Diligence Questionnaire
USER_RISK_REPORT - User Risk Report
RISK_DECISION - Risk Decision
INCORPORATION_DOCUMENT - Incorporation Document
MEETING_MINUTES - Meeting Minutes
PROOF_OF_IDENTITY - Proof of Identity
FULL_IDV - Full IDV
SOURCE_OF_FUNDS - Source of Funds
NAME_CHECK - Name Check
PROOF_OF_ADDRESS - Proof of Address
RDC_VERIFICATION - RDC Verification
KYB_PROOF_OF_IDENTITY - Proof of Identity
KYB_BANK_STATEMENT - Bank Statements
KYB_PROOF_OF_ADDRESS - Proof of Address
KYB_TAX_DOCUMENTS - Tax Documents
CLEAN_SCREENING - Clean Screening
CRA - Customer Risk Assessment
WEB_PRESENCE - Web Presence
FINANCIAL_LICENSE - Financial License
AML_POLICY - AML Policy Documents
WOLFSBERG_QUESTIONNAIRE - Wolfsberg Questionnaire
PEP - PEP
SANCTIONS - Sanctions
ADVERSE_MEDIA - Adverse Media
BLACKLIST - Blacklist
NAME_MATCHING - Name Matching
MULTI_WATCHLIST - Multi-Watchlist
PEP_SEARCH - PEP Search
SANCTIONS_SEARCH - Sanctions Search
ADVERSE_MEDIA_SEARCH - Adverse Media Search
BLACKLIST_SEARCH - Blacklist Search
DOCUMENT_FRAUD - Document Fraud
TM_CRYPTO - Transaction Monitoring (Crypto)
TM_CLASSIC - Transaction Monitoring (Fiat)
IDV - IDV
TRANSACTION_MONITORING - Transaction Monitoring
INFO_BLOCK - Information

Available options:

UBO_RESOLUTION,

SIGNING_AUTHORITY,

BANK_STATEMENT,

BALANCE_SHEETS,

INCOME_STATEMENTS,

TAX_DOCUMENTS,

AUTHORIZATION_FORM,

ARTICLES_OF_ASSOCIATION,

COMMERCIAL_EXTRACT,

ONBOARDING_FORM,

SHAREHOLDER_LIST,

EDD_QUESTIONNAIRE,

USER_RISK_REPORT,

RISK_DECISION,

INCORPORATION_DOCUMENT,

MEETING_MINUTES,

PROOF_OF_IDENTITY,

FULL_IDV,

SOURCE_OF_FUNDS,

NAME_CHECK,

PROOF_OF_ADDRESS,

RDC_VERIFICATION,

KYB_PROOF_OF_IDENTITY,

KYB_BANK_STATEMENT,

KYB_PROOF_OF_ADDRESS,

KYB_TAX_DOCUMENTS,

CLEAN_SCREENING,

CRA,

WEB_PRESENCE,

FINANCIAL_LICENSE,

AML_POLICY,

WOLFSBERG_QUESTIONNAIRE,

PEP,

SANCTIONS,

ADVERSE_MEDIA,

BLACKLIST,

NAME_MATCHING,

MULTI_WATCHLIST,

PEP_SEARCH,

SANCTIONS_SEARCH,

ADVERSE_MEDIA_SEARCH,

BLACKLIST_SEARCH,

DOCUMENT_FRAUD,

TM_CRYPTO,

TM_CLASSIC,

IDV,

TRANSACTION_MONITORING,

INFO_BLOCK,

null

delete_after

integer

Days until deletion. -1 means never delete.

Required range: -2147483648 <= x <= 2147483647

List Checks Get Check

⌘I

Start

Models

Cases

Checks

Customers

Documents

Events

oauth

Create Check

Authorizations

Body

Response