API Reference
Portal

Get Travel Rule approval state

get
https://api.cert.zerohash.com/travel-rule/state-approval

Returns whether a deposit or a planned withdrawal can go ahead under the Travel Rule and, if it cannot, what information is still needed.

  • Deposit mode (intention_action=deposit): send deposit_id. No other parameters are allowed.
  • Withdrawal mode (intention_action=withdrawal): send participant_code and wallet_address. deposit_id is not allowed. You can also send asset and crypto_amount, or notional_amount and notional_symbol, to describe the planned amount.

Requires an API key with travel_rule read permission. The caller must operate for participant_code. When status is action_required, send the missing information with POST /travel-rule/submit. Requests are rate limited to 60 per minute per participant across all /travel-rule endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Whether to check a deposit or a planned withdrawal.

Allowed:
uuid

The crypto deposit to check. Required in deposit mode and not allowed in withdrawal mode.

string
^[A-Z0-9]{6}$

The participant making the withdrawal. 6 uppercase alphanumeric characters. Required in withdrawal mode and not allowed in deposit mode.

string
length ≥ 1

The destination address of the withdrawal. Required in withdrawal mode and not allowed in deposit mode.

string
length ≥ 1

The asset being withdrawn, e.g. ETH. Required when crypto_amount is sent. Withdrawal mode only.

string
^\d+(\.\d+)?$

The planned withdrawal amount in asset, as a numeric string. Requires asset. Withdrawal mode only.

string
^\d+(\.\d+)?$

The planned withdrawal amount in fiat, as a numeric string. Must be sent together with notional_symbol. Withdrawal mode only.

string
length ≥ 1

The fiat currency of notional_amount, e.g. EUR. Must be sent together with notional_amount. Withdrawal mode only.

Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

429

Rate limit exceeded. Retry after the number of seconds in the RateLimit-Reset header.

Updated about 1 hour ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?