Assess a transfer before creating it

post

https://sandbox.notabene.id/api/v1/transfers/assess

Reports whether the travel rule applies to a prospective transfer, which PII it requires, and which institutions sit on each side. Nothing is created and no counterparty is contacted.

Required permission: read:transfer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Used in these guides:

Query Params

skip_agent_discovery

boolean

Skip discovery of the originator's and beneficiary's institutions from the supplied addresses.

include_pubkeys

boolean

Defaults to false

Include the beneficiary institution's encryption public key in the response.

Body Params

amount

string

required

The amount transferred, in the asset's whole units rather than its smallest unit. For example 1.5 ETH, not 1500000000000000000.

asset

string

required

The asset to assess, as a CAIP-19 identifier or a plain symbol such as BTC.

destinationAddress

string

The beneficiary's address, used to discover their institution. Accepts a bare address, a CAIP-10 identifier or a did:pkh; a bare address is interpreted on the asset's chain.

fiatAmountUsd

string

Your own fiat valuation, as a decimal string in USD. Required for an asset we cannot price.

sourceAddress

string

The originator's address, used to discover their institution. Accepts a bare address, a CAIP-10 identifier or a did:pkh; a bare address is interpreted on the asset's chain.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

400Bad Request. A missing or invalid field or parameter is listed under errors, with the field when it can be named. Any other reason comes as a problem document, with the reason in detail.

401Unauthorized: the access token is missing, malformed or expired. Request a new one, as Authentication explains.

403Forbidden: the token cannot make this call. It lacks the permission named above.

defaultAny other error, as a problem document.