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 · requiredReview ID.
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"Responses
200The review.
idstring · required"irv_01JB8QK2"objectstring · requiredreviewlivemodeboolean · requiredstatusstring · requiredopenwaiting_on_customerawaiting_approvalclosednumberstring · required"RV-0142"kindstring · requiredpayout_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_ruleprioritystring · requiredhighmediumlowoutcomestring | null · requiredHow the review closed; null while it is open.
sourcestring · requiredevaluationmanualmonitoringlist_screeningpayout_ruleevaluation_idstring | null · requiredThe evaluation of yours that opened the review.
linked_evaluation_idstring | null · requiredlinked_review_idstring | null · requiredsubjectobject · requiredFields (3)
typestring · requiredpersonbusinessaccounttransaction_patternunknowndisplaystring · requiredMasked (first letter of each word).
"V*** S***"referencestring | null · requiredYour own reference for the subject.
"cust_7731"open_reasonstring | null · requiredunusual_activitydue_diligence_refreshexternal_referralscreening_follow_upotheropened_byobject · requiredFields (2)
typestring · requireduserapi_clientsystemidstringThe user id or your API credential's client id. Absent for system.
owner_idstring | null · requireddue_atstring (date-time) | null · requiredpaused_atstring (date-time) | null · requiredoverdueboolean · requiredclosed_atstring (date-time) | null · requiredcreated_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"matched_entriesinteger · requiredHow many list entries the source screening matched.
opening_note_recordedboolean · requiredpending_decision_idstring | null · requiredThe decision waiting for a second approver, if any.
decisionsarray of object · requiredItem fields (13)
idstring · required"ird_01JB9A"objectstring · requiredreview_decisionlivemodeboolean · requiredreview_idstring · required"irv_01JB8QK2"decisionstring · requiredThe 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_confirmedreleasecancelapprovedrejectedexpiredreason_codestring · requiredAccepted 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_breachothernote_recordedboolean · requiredproposed_byobject · requiredFields (2)
typestring · requireduserapi_clientsystemidstringThe user id or your API credential's client id. Absent for system.
requires_approvalboolean · requiredapproval_rulestring | null · requiredWhy a second approver is needed; null when none is.
sanctions_pepallapi_clearanceapprovalobject | null · requiredThe approver's answer; null until there is one.
Fields (5)
idstring · requiredoutcomestring · requiredapprovedsent_backwithdrawnbyobject · requiredFields (2)
typestring · requireduserapi_clientsystemidstringThe user id or your API credential's client id. Absent for system.
note_recordedboolean · requiredcreated_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"2026-04-15T14:30:00Z"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"notesarray of object · requiredItem fields (7)
idstring · required"irn_01JB9C"objectstring · requiredreview_notelivemodeboolean · requiredreview_idstring · requiredauthorobject · requiredFields (2)
typestring · requireduserapi_clientsystemidstringThe user id or your API credential's client id. Absent for system.
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"eventsarray of object · requiredItem fields (4)
kindstring · requiredactorobject · requiredFields (2)
typestring · requireduserapi_clientsystemidstringThe user id or your API credential's client id. Absent for system.
summarystring · requiredcreated_atstring (date-time) · requiredRFC 3339 / ISO 8601 timestamp in UTC.
"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 · 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."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 · 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."404The resource does not exist, or belongs to a different merchant.
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."