Quickstart

You need a tenant secret key beginning with tnk_. If you don't have one, create an account — signup is self-serve and takes a few minutes.

Store it in your secret manager and expose it only to trusted backend services.

export FIDERA_API_KEY="tnk_..."

1. Create a Check

This example screens a customer and transaction receiver in one immutable Check. external_id links or creates the Applicant using your stable customer identifier. reference_id links the Check to your payment.

curl https://api.fideralabs.com/v1/checks \
  --request POST \
  --header "Authorization: Bearer $FIDERA_API_KEY" \
  --header "Idempotency-Key: payment-9842-screen-v1" \
  --header "Content-Type: application/json" \
  --data '{
    "type": "aml_screen",
    "use_case": "transaction",
    "mode": "sync",
    "reference_id": "payment-9842",
    "applicant": {
      "external_id": "customer-481",
      "legal_name_first": "Jane",
      "legal_name_last": "Example"
    },
    "datasets": ["sanctions", "pep", "crypto_wallets"],
    "subjects": [
      {
        "reference_id": "customer-481",
        "type": "person",
        "role": "sender",
        "name": "Jane Example",
        "date_of_birth": "1990-01-01",
        "nationality": "US"
      },
      {
        "reference_id": "party-receiver",
        "type": "company",
        "role": "receiver",
        "name": "Example Trading Ltd",
        "country": "GB",
        "registration_number": "01234567"
      }
    ]
  }'

Persist these response fields:

• id — the immutable Fidera Check ID;
• applicant_id — the Fidera Applicant that owns the Check;
• input_ref — the normalized reconciliation reference;
• decision — clear, review, hold, or error;
• match_count — source matches present when the Check completed;
• origin and lineage IDs — whether the Check came from a direct request, Flow, Batch, or Monitor.

For a transaction, an actionable hit produces hold. Required screening data being unavailable does not produce clear.

2. Read the Check

Async Checks return before evaluation finishes. Poll the Check until its status is terminal, or react to the corresponding webhook.

curl "https://api.fideralabs.com/v1/checks/$CHECK_ID" \
  --header "Authorization: Bearer $FIDERA_API_KEY"

The response preserves normalized queries, source and dataset versions, policy version and snapshot, match explanations, timings, lineage, and match counts.

Request the same Check as Markdown by changing the representation header, not the resource URL:

curl "https://api.fideralabs.com/v1/checks/$CHECK_ID" \
  --header "Authorization: Bearer $FIDERA_API_KEY" \
  --header "Accept: text/markdown"

JSON remains the default and is explicit with Accept: application/json. Responses include Vary: Accept. In the Fidera dashboard origin, /checks/{check_id}.json, /checks/{check_id}.md, and /checks/{check_id}.pdf are convenience URLs that translate their suffix into the same API request. They are not separate public API endpoints.

3. Read match evidence

Match evidence is meaningful only in the evaluation that produced it, so it is nested in the Check response:

{
  "id": "check-id",
  "match_count": 1,
  "match_change_counts": {"observed": 1},
  "matches": [
    {
      "key": "stable-monitor-comparison-key",
      "material_hash": "evidence-version-hash",
      "subject_ref": "party-receiver",
      "source_entity_id": "provider-entity-id",
      "change_type": "observed",
      "present": true,
      "score": 0.91,
      "datasets": ["sanctions"],
      "categories": ["sanction"],
      "evidence": {}
    }
  ]
}

An entry in matches is screening evidence, not a work item or independently addressable resource. Your investigation can retain the Fidera check_id, the nested key, and material_hash while keeping assignment, SLA, disposition, and approval in your own system.

4. Choose a representation

Request a portable PDF from the same Check resource:

curl "https://api.fideralabs.com/v1/checks/$CHECK_ID" \
  --header "Authorization: Bearer $FIDERA_API_KEY" \
  --header "Accept: application/pdf" \
  --output check-evidence.pdf

JSON, Markdown, and PDF are supported. An unsupported media type returns 406. The Check resource remains the source of truth.

Next steps

• Model Applicants and Checks.
• Add idempotency and cursor pagination.
• Receive signed webhook events.
• Reconcile Check evidence into your workflow.