ZEzerohash
Travel Rule

Get Travel Rule approval state

Changed on

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.

get/travel-rule/state-approval

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/travel-rule/state-approval
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Query parameters

intention_action'deposit' | 'withdrawal' required

Whether to check a deposit or a planned withdrawal.

deposit_idstring uuid

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

participant_codestring

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

wallet_addressstring

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

assetstring

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

crypto_amountstring

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

notional_amountstring

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

notional_symbolstring

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

Headers

X-SCX-SIGNEDstring required

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

X-SCX-TIMESTAMPstring required
Example:1678901234

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

Response

Successfully retrieved Travel Rule approval state.

Example response

{
  "message": {
    "status": "action_required",
    "status_reasons": [
      "info_required"
    ]
  }
}

Changes