Create a Verification Subject

Creates a verification subject (a person or a business) and opens its first verification attempt. Anton mints a hosted verification link — a one-time Persona flow where the subject submits their government ID and selfie (person) or business details plus a UBO cascade (business). Identity documents live with the verification provider and Anton’s vault; they never touch your systems.

Link delivery. With delivery: "email", Anton emails the link to the subject and the attempt is created with status sent. If the environment cannot deliver email — or you choose delivery: "manual" — the status is created and YOU deliver the returned hosted_link through your own channel. Only trust sent as proof an email went out.

hosted_link is secret-once. It appears in this response (and on resend / regenerate / re-verify responses) and is never readable again. Treat it like a credential: it opens a flow that collects your customer’s identity documents.

Track progress via the verification.* webhook events or by polling the subject. Requires the intelligence credential scope and account capability.

POST

verification-subjects

curl --request POST \
  --url https://api.antonpayments.com/v1/verification-subjects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "type": "person",
  "display_name": "Ada Lovelace",
  "email": "ada@example.com",
  "external_ref": "customer_8841",
  "country": "CA",
  "delivery": "email",
  "message": "Hi Ada — please verify your identity so we can activate your account.",
  "link_expires_in_days": 7
}
'

{
  "data": {
    "subject": {
      "id": "<string>",
      "type": "person",
      "display_name": "<string>",
      "email": "<string>",
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "attempts": [
        {
          "id": "<string>",
          "status": "created",
          "reason": "initial",
          "created_at": "2023-11-07T05:31:56Z",
          "checks": [
            {
              "type": "<string>",
              "label": "<string>",
              "status": "passed",
              "detail": "<string>"
            }
          ],
          "completed_at": "2023-11-07T05:31:56Z",
          "link_expires_at": "2023-11-07T05:31:56Z",
          "screening": {
            "status": "clear",
            "lists_checked": [
              "<string>"
            ],
            "evaluation_id": "<string>",
            "detail": "<string>"
          },
          "ubos": [
            {
              "id": "<string>",
              "display_name": "<string>",
              "email": "<string>",
              "ownership_pct": 123,
              "status": "created",
              "completed_at": "2023-11-07T05:31:56Z"
            }
          ],
          "hosted_link": "<string>"
        }
      ],
      "external_ref": "<string>"
    },
    "verification": {
      "id": "<string>",
      "status": "created",
      "reason": "initial",
      "created_at": "2023-11-07T05:31:56Z",
      "checks": [
        {
          "type": "<string>",
          "label": "<string>",
          "status": "passed",
          "detail": "<string>"
        }
      ],
      "completed_at": "2023-11-07T05:31:56Z",
      "link_expires_at": "2023-11-07T05:31:56Z",
      "screening": {
        "status": "clear",
        "lists_checked": [
          "<string>"
        ],
        "evaluation_id": "<string>",
        "detail": "<string>"
      },
      "ubos": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "email": "<string>",
          "ownership_pct": 123,
          "status": "created",
          "completed_at": "2023-11-07T05:31:56Z"
        }
      ],
      "hosted_link": "<string>"
    }
  }
}

Authorizations

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Headers

Idempotency-Key

string

required

Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.

Maximum string length: 255

Body

application/json

type

enum<string>

required

Available options:

person,

business

display_name

string

required

The subject's legal name. Vault-tokenized at rest; masked on every read.

string

Where the hosted link is delivered (with delivery: "email"), and the address shown in the flow. Without an email on file, delivery cannot happen — the attempt stays created and you deliver the link yourself.

external_ref

string

Optional identifier from your systems, echoed back on reads.

country

string

ISO 3166-1 alpha-2. Recommended — it feeds sanctions screening disambiguation.

delivery

enum<string>

default:manual

email — Anton emails the hosted link to the subject. manual (the default when omitted) — you deliver the returned hosted_link yourself.

Available options:

email,

manual

message

string

Optional text shown in the delivery email, attributed to your business. Used for that one send and never persisted (it may carry incidental PII) — it cannot be read back.

Maximum string length: 500

link_expires_in_days

enum<integer>

default:7

Hosted-link lifetime.

Available options:

7,

14,

30

Response

Subject created; first verification attempt opened.

data

object

required

Show child attributes

⌘I

curl --request POST \
  --url https://api.antonpayments.com/v1/verification-subjects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "type": "person",
  "display_name": "Ada Lovelace",
  "email": "ada@example.com",
  "external_ref": "customer_8841",
  "country": "CA",
  "delivery": "email",
  "message": "Hi Ada — please verify your identity so we can activate your account.",
  "link_expires_in_days": 7
}
'

{
  "data": {
    "subject": {
      "id": "<string>",
      "type": "person",
      "display_name": "<string>",
      "email": "<string>",
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "attempts": [
        {
          "id": "<string>",
          "status": "created",
          "reason": "initial",
          "created_at": "2023-11-07T05:31:56Z",
          "checks": [
            {
              "type": "<string>",
              "label": "<string>",
              "status": "passed",
              "detail": "<string>"
            }
          ],
          "completed_at": "2023-11-07T05:31:56Z",
          "link_expires_at": "2023-11-07T05:31:56Z",
          "screening": {
            "status": "clear",
            "lists_checked": [
              "<string>"
            ],
            "evaluation_id": "<string>",
            "detail": "<string>"
          },
          "ubos": [
            {
              "id": "<string>",
              "display_name": "<string>",
              "email": "<string>",
              "ownership_pct": 123,
              "status": "created",
              "completed_at": "2023-11-07T05:31:56Z"
            }
          ],
          "hosted_link": "<string>"
        }
      ],
      "external_ref": "<string>"
    },
    "verification": {
      "id": "<string>",
      "status": "created",
      "reason": "initial",
      "created_at": "2023-11-07T05:31:56Z",
      "checks": [
        {
          "type": "<string>",
          "label": "<string>",
          "status": "passed",
          "detail": "<string>"
        }
      ],
      "completed_at": "2023-11-07T05:31:56Z",
      "link_expires_at": "2023-11-07T05:31:56Z",
      "screening": {
        "status": "clear",
        "lists_checked": [
          "<string>"
        ],
        "evaluation_id": "<string>",
        "detail": "<string>"
      },
      "ubos": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "email": "<string>",
          "ownership_pct": 123,
          "status": "created",
          "completed_at": "2023-11-07T05:31:56Z"
        }
      ],
      "hosted_link": "<string>"
    }
  }
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Create a Verification Subject

Authorizations

Headers

Body

Response