Create Check

post/v1/checks

Run a single AML check inline and return the graded row — the atomic 'one API call' unit, creatable from the dashboard or a secret key.

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

Idempotency-Key

header · optional

No additional parameter description.

Request body

JSON · required

applicant

ApplicantIn

No additional field description.

applicant_id

string | null

Screen an existing applicant by Fidera id (their stored identity fields feed the query). Mutually exclusive with ``applicant`` — when set, the inline payload is ignored. ``applicant.external_id`` offers the same linkage by your own identifier.

categories

string[] | null

adverse_media only: which news categories to grade (violent_crime, terrorism, regulatory, financial_crime, organized_crime). Unset grades all adverse categories; 'political' is always informational.

datasets

AmlDataset[] | null

No additional field description.

mode

CheckMode

No additional field description.

reference_id

string | null

No additional field description.

subjects

CheckSubjectIn[] | null

No additional field description.

type

CheckType

No additional field description.

use_case

CheckUseCase

No additional field description.

Example request

cURL

curl --request POST \
  --url 'https://api.fideralabs.com/v1/checks' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "applicant": {
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "address_region": "string",
    "business_name": "string",
    "consent": {
      "biometric": {},
      "policy_version": {}
    },
    "custom_attributes": {},
    "dob": "string",
    "email": "string",
    "entity_type": "individual"
  },
  "applicant_id": "00000000-0000-0000-0000-000000000000",
  "categories": [
    "string"
  ],
  "datasets": [
    "string"
  ],
  "mode": "sync",
  "reference_id": "string",
  "subjects": [
    {
      "aliases": {},
      "country": {},
      "date_of_birth": {},
      "identifiers": {},
      "imo_number": {},
      "mmsi": {},
      "name": {},
      "nationality": {},
      "reference_id": {},
      "registration_number": {},
      "role": {},
      "type": {}
    }
  ],
  "type": "aml_screen",
  "use_case": "ad_hoc"
}'

Responses

201Successful Response

alert_count

integer

No additional field description.

applicant_id

string | null

No additional field description.

applicant_name

string | null

No additional field description.

check_type

CheckTyperequired

No additional field description.

completed_at

string | null

No additional field description.

created_at

stringrequired

No additional field description.

dataset_versions

object[]

No additional field description.

datasets

string[] | null

No additional field description.

decision

CheckDecision | null

No additional field description.

error

string | nullrequired

No additional field description.

evidence

object

No additional field description.

flow_id

string | null

No additional field description.

id

stringrequired

No additional field description.

input_ref

string | null

No additional field description.

latency_ms

integer | null

No additional field description.

mode

CheckMode

No additional field description.

normalized_query

object

No additional field description.

output

objectrequired

No additional field description.

policy_snapshot

object

No additional field description.

policy_version

string | null

No additional field description.

reason_codes

string[]required

No additional field description.

result

CheckResultrequired

No additional field description.

source_versions

object[]

No additional field description.

status

CheckStatusrequired

No additional field description.

submission_id

string | null

No additional field description.

use_case

CheckUseCase

No additional field description.

application/json

{
  "alert_count": 0,
  "applicant_id": "00000000-0000-0000-0000-000000000000",
  "applicant_name": "string",
  "check_type": "string",
  "completed_at": "2026-07-29T12:00:00Z",
  "created_at": "2026-07-29T12:00:00Z",
  "dataset_versions": [
    {}
  ],
  "datasets": [
    "string"
  ],
  "decision": "string",
  "error": "string",
  "evidence": {},
  "flow_id": "00000000-0000-0000-0000-000000000000"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

create_check_v1_checks_post