Anton.Docs
Dashboard (opens in a new tab)

Onboard a merchant

Screen a business before you let it onto your platform. Only a business can be evaluated, and the verdict comes back in the same response.

merchant_onboarding evaluates a company at the point you would accept it as a customer. The decision is in the response, so you can gate your own signup flow on it.

Before you begin

Name the business

entity.type must be business; person is a 422. One of name or vault_token_id is required. country and a document of type business_registration or tax_id, with its country and number, give the screening more to match the company on.

Send the evaluation

POST/v1/intelligence/evaluationsScreen the business

The response is 201 with status: "completed".

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-merchant-example-001" \
  -H "Content-Type: application/json" \
  -d '{
    "use_case": "merchant_onboarding",
    "client_reference_id": "merchant-example-001",
    "entity": {
      "type": "business",
      "reference_id": "merchant-example",
      "name": "Example Imports LLC",
      "country": "US",
      "document": {
        "type": "business_registration",
        "country": "US",
        "number": "TEST-REG-123"
      }
    }
  }'

The merchant object on the request is accepted but ignored today; don't depend on it. Put your own context in metadata.

Act on the decision

approve lets the business through. decline stops it. On review, reasons says why and required_actions may ask for provide_missing_information, which means resubmit the same business with more details, or verify_identity, which points to a verification subject for the people behind it. Decisions lists every value.

Next

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