Screen an address for AML
Orders an AML screening and returns one response shape for every provider and every state of the order.
Without wait_for_result the response is 202 Accepted with a Location header pointing at the order; with it the response waits for the result for up to 15 seconds and returns 200 OK. An address with no blockchain activity returns 200 OK with status skipped and is not charged, and so is a result reused from a check made within the last 60 seconds.
Numbers that come from a provider — scores, shares, USD volumes and every amount in billing — are decimal strings. Parsing them as JSON numbers loses precision in any language with binary floating point.
Shares are expressed once, as share_fraction between 0 and 1, whatever units the provider used. Scores are not rescaled: the provider's own scale arrives in risk.scale.
The field set does not depend on the provider or on the state of the order. Fields you do not recognise must be ignored: they are added without a new version. The shape of provider_data follows the provider and is not part of the contract.
Authorizations
API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.
Request Body
Responses
The result is in the response: the check finished, a recent result was reused, or the address has no activity.