Anton.Docs
Dashboard (opens in a new tab)

Screen an account or wallet

A clean payee can still own a bad account. Screen the bank account, IBAN, card or wallet the money will go to, and get the verdict in the response.

instrument_screening evaluates one payment instrument alongside the person or business that owns it. It decides before it answers. It does not store the instrument; to save one for payouts, see Register an instrument.

Before you begin

Say what kind of instrument it is

instrument.type is bank_account, crypto_wallet, card or iban, and the details go in the block of the same name. A mismatch, such as type: "crypto_wallet" with a bank_account block, is a 422 validation_error. The entity is still required: it is the owner, with type set to person or business.

An IBAN goes in iban as iban and an optional bic. A card goes in card as a fingerprint, bin or last4, never a full card number. If the details already sit in your vault, send vault_token_id on the instrument instead of the block. country and currency take uppercase codes, such as US and BTC.

Send the evaluation

POST/v1/intelligence/evaluationsScreen the instrument

The response is 201, already decided.

Reference
Not yet tested in sandbox
curl -X POST \
  https://api.antonpayments.dev/v1/intelligence/evaluations \
  -H "Authorization: DPoP $ANTON_ACCESS_TOKEN" \
  -H "DPoP: $DPOP_PROOF" \
  -H "Idempotency-Key: intel-wallet-john-doe-001" \
  -H "Content-Type: application/json" \
  -d '{
    "use_case": "instrument_screening",
    "entity": {
      "type": "person",
      "reference_id": "payee-john-doe",
      "name": "John Doe",
      "country": "US"
    },
    "instrument": {
      "type": "crypto_wallet",
      "country": "US",
      "currency": "BTC",
      "crypto_wallet": {
        "network": "bitcoin",
        "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
      }
    }
  }'

Account numbers and wallet addresses are used in memory for the evaluation. Anton keeps redacted evidence, not the values, as PII and vault tokens explains.

Read the result

decision, score, tier, reasons and required_actions work as they do for a payee; Decisions lists the values. A review on an account you were about to pay is a reason to hold the payout, not to retry with different details.

When it goes wrong

422validation_error
The instrument block is missing, or its nested payload does not match instrument.type.
400unknown_field
A field is outside the contract. The contract is strict at every depth.

Next

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