Anton.Docs
Dashboard (opens in a new tab)
API referenceIntelligence

Create an intelligence evaluation

POST/v1/intelligence/evaluationsIdempotency-Key required

Walked through inAct on a decisionScreen an account or walletOnboard a merchantMonitor over timeScreen a payeeScreen a payoutIntelligence quickstart

Example

Run payee, instrument, payout, merchant onboarding, or monitoring inputs through Anton Intelligence. A payout_screening evaluation returns before it finishes; every other use case returns the finished evaluation.

The request contract is strict and uses fixed enums, so you can generate SDKs safely. You can send direct PII over TLS or have Anton recover it from a vault token. Anton uses it in memory for the evaluation and persists only redacted decision evidence.

Required fields per use case. Beyond the always-required use_case and entity.type, each use case adds requirements (a 422 validation_error otherwise):

  • payee_registration: entity.name OR entity.vault_token_id.
  • merchant_onboarding: entity.type must be business, plus entity.name OR entity.vault_token_id.
  • instrument_screening: an instrument block.
  • payout_screening: a payout block, plus searchable entity or instrument data.
  • monitoring: searchable entity or instrument data.

The static required arrays below can't express these conditions, so they are listed here.

Authentication. You need OAuth+DPoP credentials; a request without them is refused with 401. The evaluation is stored under YOUR merchant account (retrievable through the scoped reads below), and the Idempotency-Key header is REQUIRED. The credential must carry the intelligence scope and the account the intelligence capability. Vault-token enrichment only accepts tokens owned by the calling merchant.

The status follows the use case. A payout_screening evaluation runs the full AI panel and can take up to ~20 seconds, so it is accepted asynchronously: 202 Accepted with the evaluation in status: pending and a Location header. Poll GET /v1/intelligence/evaluations/{id} until status is completed or failed, or subscribe to the intelligence.evaluation.completed and intelligence.evaluation.failed webhook events. Every other use case is decided before the response: 201 Created with the completed evaluation. How you authenticate never changes the status.

metadata is yours: up to 50 keys (keys up to 40 characters, values up to 500), strings only. It is stored and returned on the evaluation, never searched, and never sent to screening.

Headers

Anton-Versionstring

The API version for this request, a date such as 2026-12-01. Optional. Without it, the request runs on your account's pinned version: the latest version when you created your first OAuth client, or the launch version (2026-12-01) if you have not created one. An unknown value returns 400 invalid_api_version. The header applies to one request and never changes your pinned version; move the pin from the dashboard. It does not apply to webhooks, which follow your pinned version. The response echoes the version used in the Anton-Version header.

Example: "2026-12-01"
Idempotency-Keystring · required

Required. Retries with the same key return the original response. If the body also carries idempotency_key, the header wins.

Body application/json

use_casestring · required
payee_registrationinstrument_screeningpayout_screeningmerchant_onboardingmonitoring
entityobject · required
Fields (11)
typestring · required
personbusiness
reference_idstring
namestring
countrystring

ISO 3166-1 alpha-2 country code.

Example: "US"
birth_datestring (date)
addressobject
Fields (6)
line_1string
line_2string
citystring
statestring
postal_codestring
countrystring

ISO 3166-1 alpha-2 country code.

Example: "US"
emailstring (email)
phonestring
nationalityarray of string
documentobject
Fields (3)
typestring · required
passportnational_iddrivers_licensetax_idbusiness_registrationother
countrystring

ISO 3166-1 alpha-2 country code.

Example: "US"
numberstring
vault_token_idstring

Vault token containing PII to detokenize in memory.

client_reference_idstring

Client-supplied reference for reconciliation. Not used for merchant scoping.

idempotency_keystring

Body fallback for testing. Prefer the Idempotency-Key header.

instrumentobject
Fields (9)
typestring · required
bank_accountcrypto_walletcardiban
reference_idstring
countrystring

ISO 3166-1 alpha-2 country code.

Example: "US"
currencystring

Uppercase currency or asset code, ISO 4217 for fiat (USD) and the published asset code for stablecoins and crypto (USDC). GET /v1/currencies lists them.

Example: "USD"
bank_accountobject
Fields (3)
routing_numberstring
account_numberstring
account_typestring
checkingsavingsbusiness_checkingother
crypto_walletobject
Fields (2)
networkstring
bitcoinethereumsolanapolygontronother
addressstring
cardobject
Fields (3)
fingerprintstring
binstring
last4string
ibanobject
Fields (2)
ibanstring
bicstring
vault_token_idstring
payoutobject
Fields (5)
amountobject · required
Fields (2)
valuestring · required

Decimal amount as a string, never a float. Up to 12 whole digits.

Example: "1234.56"
currencystring · required

Uppercase supported fiat currency or crypto asset code.

source_countrystring · required

ISO 3166-1 alpha-2 country code.

Example: "US"
destination_countrystring · required

ISO 3166-1 alpha-2 country code.

Example: "US"
reference_idstring
railstring
bankcardcryptowalletinternalother
merchantobject

Accepted for future compatibility; currently ignored.

contextobject
Fields (5)
velocityobject
fingerprintsobject
historyobject
industryobject
metadataobject
metadataobject

Your own key/value pairs, stored and returned as-is. At most 50 keys; keys up to 40 characters and values up to 500, all strings. On a beneficiary the key block_reason is reserved and is refused with 422. Anton never reads it, never logs or audits it, and never sends it to screening or risk checks, so it is not searchable. Never put personal data in it.

Do not store personal information, account numbers or credentials in metadata. Use the resource's own fields, which are tokenized.

Responses

201The evaluation, decided (every use case except `payout_screening`).
idstring · required
objectstring · required
evaluation
livemodeboolean · required
statusstring · required
pendingprocessingcompletedfailed
use_casestring | null · required
payee_registrationinstrument_screeningpayout_screeningmerchant_onboardingmonitoring
metadataobject · required

Your own key/value pairs, stored and returned as-is. At most 50 keys; keys up to 40 characters and values up to 500, all strings. On a beneficiary the key block_reason is reserved and is refused with 422. Anton never reads it, never logs or audits it, and never sends it to screening or risk checks, so it is not searchable. Never put personal data in it.

Do not store personal information, account numbers or credentials in metadata. Use the resource's own fields, which are tokenized.

created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
updated_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
failure_reasonstring

Present only when status is failed.

evaluation_failed
coveragestring

How much of the screening panel answered.

completepartialerror
decisionstring
approvereviewdecline
scoreinteger

Risk score, 0 to 1000. Higher is worse.

tierstring
lowmediumhighcritical
reasonsarray of string

Why the decision is not a plain approval. watchlist_review: a possible or confirmed list match needs review. identity_unverified: the identity could not be confirmed. information_incomplete: details needed for a confident answer were missing. elevated_risk: the risk is elevated, or the reason is not one of the others. Empty for a clean approval.

required_actionsarray of string

What you can do about it. provide_missing_information: resubmit with the missing details. verify_identity: verify the subject's identity (see verification subjects).

202The evaluation, accepted for asynchronous processing (`payout_screening`): `status` is `pending` and

The evaluation, accepted for asynchronous processing (payout_screening): status is pending and only the envelope fields are present. Poll the Location URL or subscribe to intelligence.evaluation.completed.

idstring · required
objectstring · required
evaluation
livemodeboolean · required
statusstring · required
pendingprocessingcompletedfailed
use_casestring | null · required
payee_registrationinstrument_screeningpayout_screeningmerchant_onboardingmonitoring
metadataobject · required

Your own key/value pairs, stored and returned as-is. At most 50 keys; keys up to 40 characters and values up to 500, all strings. On a beneficiary the key block_reason is reserved and is refused with 422. Anton never reads it, never logs or audits it, and never sends it to screening or risk checks, so it is not searchable. Never put personal data in it.

Do not store personal information, account numbers or credentials in metadata. Use the resource's own fields, which are tokenized.

created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
updated_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
failure_reasonstring

Present only when status is failed.

evaluation_failed
coveragestring

How much of the screening panel answered.

completepartialerror
decisionstring
approvereviewdecline
scoreinteger

Risk score, 0 to 1000. Higher is worse.

tierstring
lowmediumhighcritical
reasonsarray of string

Why the decision is not a plain approval. watchlist_review: a possible or confirmed list match needs review. identity_unverified: the identity could not be confirmed. information_incomplete: details needed for a confident answer were missing. elevated_risk: the risk is elevated, or the reason is not one of the others. Empty for a clean approval.

required_actionsarray of string

What you can do about it. provide_missing_information: resubmit with the missing details. verify_identity: verify the subject's identity (see verification subjects).

400The request body could not be parsed or contains unknown fields, its `Content-Type` is not `application/json` (`invalid_content_type`), or t
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
401Missing, expired or invalid credentials (access token or DPoP proof). Carries `WWW-Authenticate`.
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
403The account capability or credential scope the call needs is missing.

The account capability or credential scope the call needs is missing.

capability_required: the merchant account does not hold the required capability (for example, an AI-compliance-only account calling a payout endpoint). insufficient_scope: the account holds it, but this credential was created without the matching scope. Effective access is always scopes ∩ capabilities. A sandbox credential used against production is key_environment_mismatch.

errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
409`idempotency_in_flight`: another request with the same `Idempotency-Key` is still being processed. Retry after it completes, and the complet
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
422The request failed validation (`validation_error`, or a more specific code such as `amount_precision_invalid`). `details` lists every failin
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
detailsarray of object · required

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
429Rate limit exceeded. See `Retry-After`. The `X-RateLimit-*` headers are on every authenticated API response, not only on 429s; they are docu
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
500Something went wrong on our end (`api_error`: 500 `internal_error`, 502 `upstream_error`, 503 `service_unavailable`). The message is always
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."

Something wrong or missing here? Open an issue (opens GitHub in a new tab) ↗