API Reference
Portal

Submit Travel Rule information

post
https://api.cert.zerohash.com/travel-rule/submit

Submits Travel Rule information about the owner of a crypto address, either for a deposit (send deposit_id) or for a withdrawal address (send address). Requires an API key with travel_rule write permission. The caller must operate for participant_code. Requests are rate limited to 60 per minute per participant across all /travel-rule endpoints. A successful submission returns 200 with an empty body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Travel Rule information for a deposit or a withdrawal address.

  • Deposit mode: send deposit_id and do not send address.
  • Withdrawal mode: send address and do not send deposit_id.

Rules that depend on other fields:

  • casp_did is required when wallet_type is hosted, and must not be sent when it is self_custody.
  • When address_belongs_to is third_party, send individual_pii for an individual owner or business_pii for a business owner.
  • When address_belongs_to is zh_participant, do not send individual_pii or business_pii. zerohash fills them in from the participant's KYC data.
  • individual_pii and business_pii cannot be sent together.

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

The participant the Travel Rule information is submitted for. 6 uppercase alphanumeric characters.

string
length ≥ 1

The on-chain address the information applies to. Required in withdrawal mode and not allowed in deposit mode.

uuid

The crypto deposit the information applies to. Sending it selects deposit mode. The deposit must belong to participant_code.

string
enum
required

Whether the address belongs to the participant (zh_participant) or to someone else (third_party).

Allowed:
string
enum
required

Whether the address owner is a person or a business.

Allowed:
string
enum
required

Whether the wallet is self-custodied or hosted by a VASP.

Allowed:
string
length ≥ 1

The id of the VASP hosting the wallet, from GET /travel-rule/vasps. Required when wallet_type is hosted, and not allowed when it is self_custody.

individual_pii
object

Identity of an individual owner. Required when address_owner_type is individual and address_belongs_to is third_party.

business_pii
object

Identity of a business owner. Required when address_owner_type is business and address_belongs_to is third_party.

wallet_proof_of_ownership
object

A document proving the owner controls the wallet. The decoded document must not exceed 10 MB.

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
200

Travel Rule information accepted. The response body is empty.

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?