Anton.Docs
Dashboard (opens in a new tab)

Screen a payee

Screen a person or business before you pay them, or without ever paying them. The verdict comes back in the same response.

payee_registration screens one subject and decides before it answers, so you can gate the signup or the payee record on the result. It does not create a payee in Anton; it only evaluates. To store the payee for payouts, see Register a payee.

Before you begin

Choose how the details reach Anton

The subject is the entity. Either you send the details in the request, or you send a vault_token_id and Anton reads them in memory from your vault. One of name or vault_token_id is required; without either the call is a 422 validation_error.

type is person or business. Everything else on the entity narrows the match: country, birth_date, address, email, phone, nationality, and a document with a type such as passport or business_registration. Countries are uppercase two-letter codes and dates are YYYY-MM-DD; a malformed one is a 422.

Send the evaluation

POST/v1/intelligence/evaluationsScreen the payee

The response is 201 with status: "completed", and the verdict in decision.

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-payee-john-doe-001" \
  -H "Content-Type: application/json" \
  -d '{
    "use_case": "payee_registration",
    "client_reference_id": "payee-john-doe-001",
    "entity": {
      "type": "person",
      "reference_id": "payee-john-doe",
      "name": "John Doe",
      "country": "US",
      "birth_date": "1979-12-30"
    }
  }'

reference_id ties the subject to your own record, and client_reference_id ties this evaluation to your own request. Build the Idempotency-Key from the same record, so a retry after a timeout returns the evaluation you already have.

Act on the decision

approve means go on. decline means stop; don't create the payee. review means a person at your end decides, and required_actions may tell you what would settle it: provide_missing_information means resubmit with more details, and verify_identity points to a verification.

Next

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

Next in the core pathAct on a decision