Create Monitor

post/v1/monitors

Create Monitor

Authentication

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

Request body

JSON · required

applicant_id

stringrequired

No additional field description.

datasets

AmlDataset[] | null

No additional field description.

external_id

string | null

No additional field description.

run_immediately

boolean

No additional field description.

subjects

CheckSubjectIn[]required

No additional field description.

Example request

cURL

curl --request POST \
  --url 'https://api.fideralabs.com/v1/monitors' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "applicant_id": "00000000-0000-0000-0000-000000000000",
  "datasets": [
    "string"
  ],
  "external_id": "string",
  "run_immediately": true,
  "subjects": [
    {
      "aliases": [
        {}
      ],
      "country": {},
      "date_of_birth": {},
      "identifiers": {},
      "imo_number": {},
      "mmsi": {},
      "name": {},
      "nationality": {},
      "reference_id": {},
      "registration_number": {},
      "role": "customer",
      "type": "string"
    }
  ]
}'

Responses

201Successful Response

applicant_id

stringrequired

No additional field description.

created_at

stringrequired

No additional field description.

datasets

string[]required

No additional field description.

external_id

string | nullrequired

No additional field description.

failure_reason

string | nullrequired

No additional field description.

id

stringrequired

No additional field description.

last_check_id

string | nullrequired

No additional field description.

last_checked_at

string | nullrequired

No additional field description.

last_dataset_partition

string | nullrequired

No additional field description.

next_due_at

string | nullrequired

No additional field description.

policy_version

stringrequired

No additional field description.

status

MonitorStatusrequired

No additional field description.

subjects

object[]required

No additional field description.

updated_at

stringrequired

No additional field description.

use_case

CheckUseCaserequired

No additional field description.

application/json

{
  "applicant_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-07-29T12:00:00Z",
  "datasets": [
    "string"
  ],
  "external_id": "string",
  "failure_reason": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_check_id": "00000000-0000-0000-0000-000000000000",
  "last_checked_at": "2026-07-29T12:00:00Z",
  "last_dataset_partition": "string",
  "next_due_at": "2026-07-29T12:00:00Z",
  "policy_version": "string",
  "status": "string"
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

create_monitor_v1_monitors_post