Skip to content

Providers, prices, networks and scales (v2)

GET
/screening/providers

Providers available to this account, with prices, the networks each one covers and the scale its score is measured on. Replaces GET /apiv2/aml/providers.

The provider field of a check is a free-form string rather than an enumeration so that a new provider is not a breaking change; the consequence is that the current list lives in data, and this is where to read it. The pairing with networks matters: ordering a check for a pair the provider does not cover returns 4004 before anything is charged.

A provider this account cannot use is not listed at all: BitOK is granted per account rather than to everyone, and an account without access does not see it here, does not see it in GET /apiv2/pricing, and is refused at GET /apiv2/screening/price and POST /apiv2/screening with 4002. All four answers agree on purpose — what the list shows is what the account can order. Access is requested through support; Elliptic is available to every account. Sub-user markup is included in price_trx, exactly as it is included in the amount charged.

Version 1 also returns supported_formats. That field belongs to the version 1 request model, where the representation was fixed when the order was created; in version 2 the representation is chosen when reading the result, so the list is gone. Until 13 September 2026 that list named four formats of which two were ever produced — asking for pdf returned ordinary full, silently; both endpoints now name only what they actually return.

Authorizations

ApiKeyAuth

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.

Type
API Key (header: X-API-KEY)

Responses

The providers available to this account.

application/json
JSON
{
  
"schema_version": 2,
  
"providers": [
  
  
{
  
  
  
"provider": "elliptic",
  
  
  
"price_usdt": "0.9634087310611608",
  
  
  
"price_trx": "string",
  
  
  
"available": true,
  
  
  
"reason": "string",
  
  
  
"networks": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"score_scale": {
  
  
  
  
"min": 0,
  
  
  
  
"max": 0
  
  
  
},
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"trx_rate_usd": "string",
  
"supported_languages": [
  
  
"string"
  
],
  
"additionalProperties": "string"
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI