Skip to main content
Version: v1
Legacy — API v1

This documents the legacy v1 API. New integrations should use API v2.

Risk Management & Pre-screening

Risk management and compliance endpoints for trusted crypto providers.

Pre-screen User Data for Order Creation Eligibility

Validate user data for order creation eligibility before creating orders. This endpoint helps trusted providers screen users based on IP, addresses, and trading parameters.

Trusted Providers Only

This endpoint requires a trusted referral token header and is only available to approved crypto providers.

Request

POST /pre_screening/

Required Headers:

HeaderRequiredDescription
x-referral-tokenYesTrusted referral token for identification

Request Body Fields:

FieldTypeRequiredDescription
ipstringYesUser's IP address (IPv4 format)
sender_addressstringNoCryptocurrency sender address
withdraw_addressstringNoUser's withdraw address
pairstringNoTrading pair (e.g., BTCUSDC)
amount_basestringNoBase amount for the trading pair
amount_quotestringNoQuote amount for the trading pair

Example Request:

{
"ip": "203.0.113.10",
"sender_address": "0x1234567890abcdef1234567890abcdef12345678",
"withdraw_address": "0xabcdef1234567890abcdef1234567890abcdef12",
"pair": "BTCUSDC",
"amount_base": "1.0"
}

Response

Returns pre-screening results.

Example Responses:

Pre-screening passed:

{
"detail": "Pre-screening passed"
}

Basic pre-screening passed:

{
"detail": "Pre-screening passed"
}

Validation Features

IP Address Validation

The pre-screening endpoint automatically checks if a user's IP address is from a blocked country or region. This helps with compliance requirements.

Address Validation

Sender and withdrawal addresses are validated against various risk databases to prevent:

  • Money laundering
  • Terrorist financing
  • Sanctioned entity transactions
  • Known malicious addresses

Transaction Monitoring

Trading amounts and patterns are monitored for:

  • Unusual transaction sizes
  • Rapid succession of trades
  • Suspicious trading patterns
  • AML/KYC threshold breaches

Error Responses

400 Bad Request

Invalid input data.

Example:

{
"detail": "Only one of amount_quote or amount_base can be provided"
}

401 Unauthorized

Unauthorized to use this endpoint.

Example:

{
"detail": "Pre-screening not applicable"
}

200 OK (status=failed)

Pre-screening failed.

Example:

{
"status": "failed",
"message": "The country of the user's IP is blocked."
}

404 Not Found

Endpoint not found (missing referral token or configuration issue).

Example:

{
"detail": "Not found"
}

Compliance Features

Regulatory Compliance

The pre-screening system helps ensure compliance with:

  • Anti-Money Laundering (AML) regulations
  • Know Your Customer (KYC) requirements
  • Sanctions and illicit-activity screening — addresses and IPs are screened against sanctions and illicit-activity sources; the specific data sources, lists and risk criteria are not published
  • Regional trading restrictions
  • Risk-based transaction monitoring

Next Steps