List your verification subjects, newest first. Each row carries a summary of its current verification.
display_name is masked on every read (J•••••• D••). The true name is available only through the dashboard's audited reveal flow, never through the API.
You need the intelligence credential scope and account capability. An unknown type, status or query parameter is a 400, never an empty list.
Headers
Anton-VersionstringThe API version for this request, a date such as 2026-12-01. Optional. Without it, the request runs on your account's pinned version: the latest version when you created your first OAuth client, or the launch version (2026-12-01) if you have not created one. An unknown value returns 400 invalid_api_version. The header applies to one request and never changes your pinned version; move the pin from the dashboard. It does not apply to webhooks, which follow your pinned version. The response echoes the version used in the Anton-Version header.
"2026-12-01"Query parameters
typestringFilter by subject type.
personbusinessstatusstring | stringFilter by the subject's current verification status, or in_flight for any status still under way (created, sent, in_progress, processing, awaiting_owners).
qstringSearch by your own reference (case-insensitive prefix) or the subject id (exact). Names aren't searchable. Up to 100 characters. The search goes in the request URL, so use references that contain no personal data (no names or email addresses).
"CUST_10"created_afterstring (date-time)Inclusive lower bound on created_at, RFC 3339. Use RFC 3339 UTC with millisecond precision and a Z suffix, such as 2026-11-01T00:00:00.000Z. Anything else is a 400 invalid_request with param set.
"2026-04-15T14:30:00Z"created_beforestring (date-time)Exclusive upper bound on created_at, RFC 3339. Use RFC 3339 UTC with millisecond precision and a Z suffix, such as 2026-11-01T00:00:00.000Z. Anything else is a 400 invalid_request with param set.
"2026-04-15T14:30:00Z"limitintegerItems per page, 1 to 100. A value outside that range returns 400 invalid_limit.
cursorstringOpaque cursor returned by a previous list response. Omit for the first page.
Responses
200Page of verification subjects.
objectstring · requiredlistdataarray of object · requiredItem fields (14)
idstring · requiredSubject ID (vsub_...).
objectstring · requiredverification_subjectlivemodeboolean · requiredstatusstring · requiredWhere a verification attempt stands.
created: the attempt exists and the link is minted, but nothing is delivered yet (manual delivery, or email unavailable)sent: the hosted link was delivered to the subject by emailin_progress: the subject opened the flowprocessing: submitted, and provider checks are runningawaiting_owners: business only. The business case is done and owner (UBO) flows are outstandingreview: flagged for manual reviewapproved: verified (terminal)declined: failed verification (terminal)expired: the link or inquiry lapsed unused (terminal)revoked: cancelled by the merchant (terminal)
createdsentin_progressprocessingawaiting_ownersreviewapproveddeclinedexpiredrevokedtypestring · requiredpersonbusinessdisplay_namestring · requiredMasked display name.
emailstring · requiredMasked (a***@example.com); empty when the subject has no email; the fixed value unavailable when the stored address could not be read. The full address is available only to people with the identity-details permission, in the portal.
external_refstring | null · requiredYour identifier for this subject, echoed back verbatim.
countrystring · requiredISO 3166-1 alpha-2.
current_verification_idstring | null · requiredmetadataobject · requiredYour own key/value pairs, stored and returned as-is. At most 50 keys; keys up to 40 characters and values up to 500, all strings. On a beneficiary the key block_reason is reserved and is refused with 422. Anton never reads it, never logs or audits it, and never sends it to screening or risk checks, so it is not searchable. Never put personal data in it.
Do not store personal information, account numbers or credentials in metadata. Use the resource's own fields, which are tokenized.
created_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"updated_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"verificationsarray of objectItem fields (14)
idstring · requiredVerification ID (vrf_...).
objectstring · requiredverificationlivemodeboolean · requiredstatusstring · requiredWhere a verification attempt stands.
created: the attempt exists and the link is minted, but nothing is delivered yet (manual delivery, or email unavailable)sent: the hosted link was delivered to the subject by emailin_progress: the subject opened the flowprocessing: submitted, and provider checks are runningawaiting_owners: business only. The business case is done and owner (UBO) flows are outstandingreview: flagged for manual reviewapproved: verified (terminal)declined: failed verification (terminal)expired: the link or inquiry lapsed unused (terminal)revoked: cancelled by the merchant (terminal)
createdsentin_progressprocessingawaiting_ownersreviewapproveddeclinedexpiredrevokedsubject_idstring · requiredreasonstring · requiredWhy this verification was opened.
initialreverificationregeneratedscreeningobject | null · requirednull until the verification has been screened.
ownersarray of object · requiredBusiness verifications only; empty otherwise.
Item fields (8)
idstring · requiredOwner ID (vubo_...).
objectstring · requiredverification_ownerlivemodeboolean · requiredstatusstring · requiredWhere a verification attempt stands.
created: the attempt exists and the link is minted, but nothing is delivered yet (manual delivery, or email unavailable)sent: the hosted link was delivered to the subject by emailin_progress: the subject opened the flowprocessing: submitted, and provider checks are runningawaiting_owners: business only. The business case is done and owner (UBO) flows are outstandingreview: flagged for manual reviewapproved: verified (terminal)declined: failed verification (terminal)expired: the link or inquiry lapsed unused (terminal)revoked: cancelled by the merchant (terminal)
createdsentin_progressprocessingawaiting_ownersreviewapproveddeclinedexpiredrevokeddisplay_namestring · requiredMasked owner name.
emailstring · requiredMasked (m***@example.com). The full address is available only to people with the identity-details permission, in the portal.
ownership_percentageinteger · requiredDeclared ownership percentage.
completed_atstring (date-time) | null · requiredSet once the owner's flow reached a terminal outcome.
link_expires_atstring (date-time) | null · requiredWhen the current hosted link lapses.
completed_atstring (date-time) | null · requiredSet once the verification reached a terminal outcome.
metadataobject · requiredYour own key-value pairs for this verification, set in the body when you re-verify a subject. Returned as-is and never read by Anton. The first verification of a subject carries none; set metadata on the subject when you create it.
created_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"updated_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"hosted_linkstring | nullSecret-once hosted verification link. Present only on the response that minted it. A replay of that
request (same Idempotency-Key) returns the same resource with hosted_link null: the link is
returned once and never stored. Call regenerate to get a new link.
has_moreboolean · requirednext_cursorstring | null · requiredOpaque cursor. null on the last page.
400The request body could not be parsed or contains unknown fields, its `Content-Type` is not `application/json` (`invalid_content_type`), or t
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."401Missing, expired or invalid credentials (access token or DPoP proof). Carries `WWW-Authenticate`.
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."403The account capability or credential scope the call needs is missing.
The account capability or credential scope the call needs is missing.
capability_required: the merchant account does not hold the required capability (for example, an AI-compliance-only account calling a payout endpoint). insufficient_scope: the account holds it, but this credential was created without the matching scope. Effective access is always scopes ∩ capabilities. A sandbox credential used against production is key_environment_mismatch.
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."429Rate limit exceeded. See `Retry-After`. The `X-RateLimit-*` headers are on every authenticated API response, not only on 429s; they are docu
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."500Something went wrong on our end (`api_error`: 500 `internal_error`, 502 `upstream_error`, 503 `service_unavailable`). The message is always
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).
authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."