Anton.Docs
Dashboard (opens in a new tab)

Get a review

GET/v1/intelligence/reviews/{id}

A review with its decisions, approvals, notes and activity. Notes appear as presence only; the API never returns their text. Another account's review is a 404.

Path parameters

idstring · required

Review ID.

Headers

Anton-Versionstring

The 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.

Example: "2026-12-01"

Responses

200The review.
idstring · required
Example: "irv_01JB8QK2"
objectstring · required
review
livemodeboolean · required
statusstring · required
openwaiting_on_customerawaiting_approvalclosed
numberstring · required
Example: "RV-0142"
kindstring · required

payout_held_by_rule and payee_risk_by_rule are opened by your own payout rules; their money decision is made on the linked approval in the portal, not through this API.

possible_sanctions_matchpossible_pep_matchscreening_reviewmanualpayout_held_by_rulepayee_risk_by_rule
prioritystring · required
highmediumlow
outcomestring | null · required

How the review closed; null while it is open.

sourcestring · required
evaluationmanualmonitoringlist_screeningpayout_rule
evaluation_idstring | null · required

The evaluation of yours that opened the review.

linked_evaluation_idstring | null · required
linked_review_idstring | null · required
subjectobject · required
Fields (3)
typestring · required
personbusinessaccounttransaction_patternunknown
displaystring · required

Masked (first letter of each word).

Example: "V*** S***"
referencestring | null · required

Your own reference for the subject.

Example: "cust_7731"
open_reasonstring | null · required
unusual_activitydue_diligence_refreshexternal_referralscreening_follow_upother
opened_byobject · required
Fields (2)
typestring · required
userapi_clientsystem
idstring

The user id or your API credential's client id. Absent for system.

owner_idstring | null · required
due_atstring (date-time) | null · required
paused_atstring (date-time) | null · required
overdueboolean · required
closed_atstring (date-time) | null · required
created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
updated_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
matched_entriesinteger · required

How many list entries the source screening matched.

opening_note_recordedboolean · required
pending_decision_idstring | null · required

The decision waiting for a second approver, if any.

decisionsarray of object · required
Item fields (13)
idstring · required
Example: "ird_01JB9A"
objectstring · required
review_decision
livemodeboolean · required
review_idstring · required
Example: "irv_01JB8QK2"
decisionstring · required

The first five are decisions you can record through this API. release and cancel are votes on a payout your rule held, and approved, rejected and expired are how such a review can close; both are made in the portal.

waiting_on_customernot_a_matchconfirmed_matchno_concernconcern_confirmedreleasecancelapprovedrejectedexpired
reason_codestring · required

Accepted per decision: waiting_on_customer accepts dob_needed, id_document_needed, more_information_needed; not_a_match accepts dob_differs, nationality_differs, id_document_verified, different_entity_type, location_differs; confirmed_match accepts identity_confirmed, exact_identifier_match, customer_confirmed; no_concern accepts activity_explained, documents_verified; concern_confirmed accepts suspicious_activity, policy_breach; other goes with any decision.

dob_neededid_document_neededmore_information_neededdob_differsnationality_differsid_document_verifieddifferent_entity_typelocation_differsidentity_confirmedexact_identifier_matchcustomer_confirmedactivity_explaineddocuments_verifiedsuspicious_activitypolicy_breachother
note_recordedboolean · required
proposed_byobject · required
Fields (2)
typestring · required
userapi_clientsystem
idstring

The user id or your API credential's client id. Absent for system.

requires_approvalboolean · required
approval_rulestring | null · required

Why a second approver is needed; null when none is.

sanctions_pepallapi_clearance
approvalobject | null · required

The approver's answer; null until there is one.

Fields (5)
idstring · required
outcomestring · required
approvedsent_backwithdrawn
byobject · required
Fields (2)
typestring · required
userapi_clientsystem
idstring

The user id or your API credential's client id. Absent for system.

note_recordedboolean · required
created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
updated_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
notesarray of object · required
Item fields (7)
idstring · required
Example: "irn_01JB9C"
objectstring · required
review_note
livemodeboolean · required
review_idstring · required
authorobject · required
Fields (2)
typestring · required
userapi_clientsystem
idstring

The user id or your API credential's client id. Absent for system.

created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
updated_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
eventsarray of object · required
Item fields (4)
kindstring · required
actorobject · required
Fields (2)
typestring · required
userapi_clientsystem
idstring

The user id or your API credential's client id. Absent for system.

summarystring · required
created_atstring (date-time) · required

RFC 3339 / ISO 8601 timestamp in UTC.

Example: "2026-04-15T14:30:00Z"
400The request body could not be parsed or contains unknown fields, its `Content-Type` is not `application/json` (`invalid_content_type`), or t
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The 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_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
401Missing, expired or invalid credentials (access token or DPoP proof). Carries `WWW-Authenticate`.
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The 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_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
403`module_not_enabled`: your account does not have the add-on the call needs (the Reviews API and Webhooks add-on, or the Audit Pack for expor
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The 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_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
404The resource does not exist, or belongs to a different merchant.
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The 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_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "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 · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The 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_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "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 · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The 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_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."

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