Anton.Docs
Dashboard (opens in a new tab)

Act on a decision

An evaluation returns one of three decisions, but only a review has more to say. A clean approval comes back with no reasons and nothing to do.

Branch on decision. It is approve, review or decline, and it sits with a score from 0 to 1000 where higher is worse. Anton does not return how it reached the decision, so what you act on is the decision, the reasons and the actions.

The result fields exist only once status is completed. A payout_screening evaluation answers 202 with status: pending and no result; the rest answer 201 already decided.

Before you begin

Get a decision

POST/v1/intelligence/evaluationsEvaluate a payee

The use_case fixes the required fields. A payee_registration needs an entity.name or an entity.vault_token_id.

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

For payout_screening, poll GET /v1/intelligence/evaluations/{id} until status is completed or failed, or subscribe to intelligence.evaluation.completed and intelligence.evaluation.failed. A failed evaluation carries failure_reason: evaluation_failed and no decision. That is not an approval, so do not treat it as one.

Branch on the decision

DecisionWhat it tells you
approveGo on. reasons and required_actions are empty for a clean approval.
reviewThe decision is not a plain approval. reasons says why and required_actions says what you can do.
declineStop. Don't create the payee or send the payout.

A review in your queue can name the evaluation that opened it in evaluation_id. Work the review queue covers it.

coverage says how much of the screening panel answered: complete, partial or error. Read it alongside the decision.

Read the score and tier

score is an integer from 0 to 1000. tier is low, medium, high or critical. Store both, and branch on decision rather than a score threshold of your own.

Reasons and required actions

ReasonMeaning
watchlist_reviewA possible or confirmed list match needs review.
identity_unverifiedThe identity could not be confirmed.
information_incompleteDetails needed for a confident answer were missing.
elevated_riskThe risk is elevated, or the reason is not one of the others.
ActionWhat to do
provide_missing_informationResubmit with the missing details.
verify_identityVerify the subject's identity with a verification subject.

Both lists can gain values. Treat one you do not know as the generic case: elevated_risk for a reason, and no action for an unknown action.

Decisions a person makes later

An evaluation's decision is Anton's. When it opens a review, your team records its own decisions on that review: not_a_match, confirmed_match, no_concern and the rest. Those are a separate object, and one your API credential proposes that clears the subject returns requires_approval: true with approval_rule: api_clearance, so it waits for an independent person. Record and approve a decision covers it.

When it goes wrong

422validation_error
The request is missing what its use_case requires, or a value is not valid.
400unknown_field
The body has a field outside the contract, at any depth.
400invalid_request
A filter on the list endpoint used a value it does not know.
404resource_missing
An evaluation id that is not yours is a 404, the same as one that does not exist.

Next

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

Next in the core pathWork the review queue