Whitelist address

post/api/travel-rule/v1/whitelist

Unified CaaS-facing endpoint that absorbs the multi-step compliance orchestration (WP policy rule, VASP lookup or registration, PII storage) into a single declarative request. The server branches internally across policy-only, known-VASP and new-VASP flows.

Request Body

enterpriseId string required
Min length: >= 1 characters
walletId string required
Min length: >= 1 characters
coin string required
Min length: >= 1 characters
address string required
Min length: >= 1 characters
custodyType string required
Allowed values: hosted self
label string
vaspId string
Min length: >= 1 characters
newVasp object
domain string required
Min length: >= 1 characters
name string required
Min length: >= 1 characters
pii object
CaaS-facing PII payload. Optional on the request; the server skips storage entirely when the resolved VASP source is TRUST (TRUST handles PII out-of-band).
address string
businessName string
country string
firstName string
lastName string
ownershipType string required
Allowed values: self individual business

200 Response

whitelistId string required
Min length: >= 1 characters
status string required
Allowed values: approved pending_vasp pending_prodops_review

400 Response

name string
context object required
error string required
requestId string required

403 Response

name string
context object required
error string required
requestId string required

404 Response

name string
context object required
error string required
requestId string required

500 Response

name string
context object required
error string required
requestId string required