Submit VASP counterparty customer information

Stores per-transaction originator PII for a declared VASP counterparty on a Travel Rule–held incoming deposit.

The counterpartyId must reference a DECLARED VASP counterparty owned by the same user/application as the held transaction identified by txHash.

Accepts HMAC application auth or a valid widget session token.

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

Per-transaction originator PII for a declared VASP counterparty on an incoming deposit held for Travel Rule.

Provide exactly one of:

  • self: true — the beneficiary is the account owner (server resolves PII from the user profile);
  • firstName and lastName — natural person at the VASP;
  • legalName — legal entity at the VASP.

Optional accountNumber is stored as customerIdentificationNumber on the IVMS payload when provided.

string
required

Declared VASP counterparty id from POST /counterparty/vasp.

string
required

On-chain transaction hash of the held incoming deposit. Must match a transaction in COMPLIANCE_REVIEW_REQUIRED with Travel Rule hold (onTRhold).

boolean

When true, originator is the account owner; no name fields required.

string

Customer id at the VASP (stored as customerIdentificationNumber when non-empty after trim).

string

Given name (natural person at VASP).

string

Family name (natural person at VASP).

string

Country code (natural or legal person).

string

Date of birth (natural person).

string

Place of birth (natural person).

string

Registered name (legal entity at VASP).

string

Legal entity identifier (legal entity).

Responses

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