Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Deposits

Submit Travel Rule information for a crypto deposit

Submits originator (sender) Travel Rule information for a crypto deposit held for compliance review. Forwards the collected data and optional wallet screenshot to the Travel Rule service, which decides whether the compliance hold is released. Returns the resulting submission status.

post/deposits/crypto/{deposit_id}/travel-rule

Path parameters

deposit_idstring required

The unique identifier of the crypto deposit

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.

Request body

sender_type'me_to_me' | 'you_to_me' required

Whether the deposit originates from the customer's own wallet (me_to_me) or a third party (you_to_me).

wallet_type'exchange' | 'self_custody' required

Whether the source wallet is hosted by an exchange/CASP or self-custodied.

casp_didstring

Decentralized identifier of the originating CASP. Applicable when wallet_type is exchange.

submitted_source_addressstring

On-chain source address of the deposit. Applicable when wallet_type is self_custody.

screenshotstring byte

Base64-encoded wallet screenshot. Required by the Travel Rule service above a jurisdictional notional threshold for self-custody deposits.

screenshot_mime_typestring

MIME type of the screenshot. Required when screenshot is provided.

Example request

{
  "sender_type": "me_to_me",
  "wallet_type": "self_custody",
  "casp_did": "did:example:abc",
  "submitted_source_address": "0xabc",
  "sender_pii": {
    "first_name": "Alice",
    "last_name": "Doe",
    "address": "123 Main St, Springfield"
  },
  "screenshot_mime_type": "image/png"
}

Response

Successfully submitted Travel Rule information. Returns the resulting submission status.

Example response

{
  "message": {
    "status": "approved"
  }
}