Crypto Beneficiaries (Travel Rule)

Under the Travel Rule, transfers between virtual asset service providers must carry information about who is receiving the funds. On SpectroCoin you supply that information once by saving a beneficiary, then reference it when you withdraw.

Endpoint overview

HTTP Request	Description
`POST` `/public/withdrawals/crypto/beneficiaries`	Save a new beneficiary.
`GET` `/public/withdrawals/crypto/beneficiaries`	List your saved beneficiaries.
`GET` `/public/withdrawals/crypto/beneficiaries/{id}`	Retrieve a single beneficiary.
`PATCH` `/public/withdrawals/crypto/beneficiaries/{id}`	Update a beneficiary.
`DELETE` `/public/withdrawals/crypto/beneficiaries/{id}`	Remove a beneficiary.
`GET` `/public/crypto-travel-rule/vasps`	Look up the VASP DID of the receiving provider.

Creating a beneficiary

Two questions determine the shape of the request: where the funds are going, and who owns the destination.

Where — `beneficiaryVaspType`

Value	Meaning	Also required
`VASP_DID`	The destination is another registered provider (an exchange, a custodian).	`beneficiaryVaspDid` — look it up with Get VASP DID.
`UNHOSTED`	The destination is a self-custody wallet.	`beneficiaryUnhostedWalletProof`, evidence that the wallet is controlled by the beneficiary.

Who — `beneficiaryType`

Value	Also required
`INDIVIDUAL`	the `individual` object
`COMPANY`	the `company` object

Request body

Field	Required	Description
`networkCode`	yes	Blockchain network of the destination address. See Supported networks.
`address`	yes	Destination address.
`beneficiaryVaspType`	yes	`VASP_DID` or `UNHOSTED`, as above.
`beneficiaryType`	yes	`INDIVIDUAL` or `COMPANY`, as above.
`beneficiaryVaspDid`	conditional	Required when `beneficiaryVaspType` is `VASP_DID`.
`beneficiaryUnhostedWalletProof`	conditional	Available when `beneficiaryVaspType` is `UNHOSTED`.
`individual` / `company`	conditional	Whichever matches `beneficiaryType`.
`label`	no	Your own name for the beneficiary.
`message`	no	Free-text note.

Using a beneficiary

Saved beneficiaries are referenced by id when creating a crypto withdrawal, so the Travel Rule information travels with the transfer without being re-entered each time. See Creating a crypto withdrawal.

Scopes

Scope	Grants
`crypto-beneficiary:read`	List and retrieve beneficiaries.
`crypto-beneficiary:create`	Save new beneficiaries.
`crypto-beneficiary:write`	Update an existing beneficiary.
`crypto-beneficiary:delete`	Remove a beneficiary.

See Scopes and Generating API keys.