Skip to content

Price of one provider (v2)

GET
/screening/price

The price of one check from one provider, and whether the balance covers it. Replaces GET /apiv2/aml/price.

provider is required and has no default: in version 1 it defaulted to Elliptic, so a caller who omitted it was quoted a price for a provider they had not named.

A provider that is not open for the account answers 403 with code 4002. BitOK is granted per account; such an account does not see it in the provider list or in the price list either, so this error only reaches a caller who asked for the provider by name. Access is requested through support.

can_afford is a convenience, not a reservation — the rate moves and the balance can be spent elsewhere. The authoritative answer is the check itself, which refuses with 1004 and states both amounts. Amounts are quoted to six decimal places because that is the precision at which TRX is taken from the balance.

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)

Parameters

Query Parameters

provider*
Type
string
Required
Example"elliptic"

Responses

The price and whether the balance covers it.

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

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI