Skip to main content
POST
Re-run the compliance screen of the payer’s source address for a payment and get the stored result. Screening also runs automatically when a payment is credited — this endpoint is the on-demand re-run. It’s read-only: it never blocks or moves funds by itself. This endpoint takes no request body — the payment is identified by the paymentId path parameter, so an empty playground body is expected.
Treat status: "unavailable" as a normal outcome, not a failure: it simply means there’s no deposit to trace yet (or the source address can’t be determined on that network). Don’t retry it in a loop.

​
Authorization

  • API-key scope: payments:read · JWT team permission: payments:view
  • Rate limit: 10/min.
​
string
required
24-hex payment id from create/list.

​
Response fields

​
string
Screening status. unavailable is a normal outcome when there is no deposit to trace, not an error. skipped means the screen was deliberately not run — see skipCause.
​
number
Risk score, when a screen result exists. (The wire field is riskScore, not risk.)
​
string
Coarse risk band derived from the score, when a screen result exists.
​
string
Severity classification of the result, when present.
​
string[]
Matched risk categories, when present.
​
string (ISO date)
When the screen ran.
​
string
Present only when status is skipped; explains why screening was not performed. Treat a skip as “not screened”, not as “clean”.

​
Errors

​
See also