Notabene logo
API docs by Redocly

Notabene (1.0.0)

Download OpenAPI specification:Download

API Support: [email protected] URL: https://doc.notabene.id

The Notabene API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP status codes and verbs.

All requests to the Notabene API should be made to one of the following root URLs:

All API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail - see the Authentication section for information on correctly authenticating calls to the Notabene API.

Just getting started?

Check out our DevX guides for more information about how best to integrate with Notabene.

DIDs

The Notabene API takes advantage of Decentralized Identifiers (DIDs) that enable verifiable, decentralized digital identity.

Errors

Errors in the Notabene API follow conventional HTTP response codes to indicate errors. Generally, 2xx response codes indicate success, 4xx response codes indicate client error, and 5xx errors indicate errors with the Notabene API.

Response Code Summary

  • 200 - OK - The request was successfully handled
  • 400 - Bad Request - The API could not process the request due to an incorrect request
  • 401 - Unauthorized - The user of the API was not authenticated
  • 403 - Forbidden - The user of the API was not authorized to make the request
  • 404 - Not Found - The requested resource could not be found
  • 500, 502, 503, 504 - Server Errors - Something went wrong with the Notabene API

Authentication

The Notabene API uses API tokens to authenticate requests.

Authentication to the API is performed via bearer auth, so require an Authorization: Bearer TOKEN HTTP header.

Get customer access token

Get a Notabene API access token on behalf of a customer

Authorizations:
bearerAuth
Request Body schema: application/json

Customer Token information

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

customerRef
required
string

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "customerRef": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "scope": "string"
}

Update user

Updates the currently authenticated user

Authorizations:
bearerAuth
Request Body schema: application/json

User Info update information

did
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
Array of objects (common_IdentityFields)

List of fields

Responses

Request samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "fields": [
    ],
  • "vasps": [
    ]
}

VASP Administration

VASPs can be administered using the Notabene API. Users can be added or removed from a VASP allowing them to login to the Notabene Dashboard to manage transfers, rules, integrations and more.

VASP

did
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

Array of objects (common_IdentityFields)

List of fields

Array of objects (common_Documents)

List of documents

hasAdmin
boolean
isActiveSender
boolean
isActiveReceiver
boolean
{
  • "did": "did:methd:identifier",
  • "fields": [
    ],
  • "documents": [
    ],
  • "hasAdmin": true,
  • "isActiveSender": true,
  • "isActiveReceiver": true
}

List VASP users

Returns an array of users and their roles that have been added to manage a VASP.

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add user to VASP

Adds a user to a VASP by email. Added users will be sent an email to accept the invite.

Authorizations:
bearerAuth
Request Body schema: application/json

New user information"

email
required
string <email>
vasp
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

role
string
callbackExtra
string

Responses

Request samples

Content type
application/json
{
  • "email": "[email protected]",
  • "vasp": "did:methd:identifier",
  • "role": "string",
  • "callbackExtra": "string"
}

Remove user from VASP

Remove a user from a VASP. The removed user will no longer be able to login to the dashboard to manage the VASP.

Authorizations:
bearerAuth
Request Body schema: application/json

Remove user data

userDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

vasp
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

Responses

Request samples

Content type
application/json
{
  • "userDID": "did:methd:identifier",
  • "vasp": "did:methd:identifier"
}

Customer

The customer represents the originator of the transfer.

Create customer

Creates a new customer

Authorizations:
bearerAuth
Request Body schema: application/json

Customer info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

customerRef
string

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "customerRef": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "did": "did:methd:identifier",
  • "vaspDID": "did:methd:identifier",
  • "customerRef": "string"
}

Get customer

Returns a customer of a VASP by customer DID

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

customerDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

Customer DID

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "did": "did:methd:identifier",
  • "vaspDID": "did:methd:identifier",
  • "customerRef": "string"
}

Transactions

Transfers represent blockchain transfers sent by or to your VASP.

IVMS101

Notabene utilizes the IVMS 101 interVASP messaging standard to transmit required originator and beneficiary information.

More information: IVMS 101

object (ivms101_Originator)

The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.

object (ivms101_Beneficiary)

The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.

object (OriginatingVASP)

The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator.

object (BeneficiaryVASP)

The beneficiary is defined in Section 1.1 as the VASP which receives the transfer of a virtual asset from the originating VASP directly or through an intermediary VASP and makes the funds available to the beneficiary.

object (TransferPath)

The transfer path refers to the intermediary VASP(s) participating in a serial chain that receive(s) and retransmit(s) a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number.

object (PayloadMetadata)

Data describing the contents of the payload.

{
  • "originator": {
    },
  • "beneficiary": {
    },
  • "originatingVASP": {
    },
  • "beneficiaryVASP": {
    },
  • "transferPath": {
    },
  • "payloadMetadata": {
    }
}

Get transfer

Gets the detail of a transfer that has been created based on the passed transfer ID.

Authorizations:
bearerAuth
query Parameters
id
required
string <uuid> (TransactionID)
Example: id=123e4567-e89b-12d3-a456-426614174000

Identifier of the Transfer

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Search transfer

Searches for transfers based on transfer hash, destination blockchain address or Bitcoin vout.

Authorizations:
bearerAuth
query Parameters
txHash
string

Transaction txHash

destination
string

Destination Address

vout
string

Bitcoin vout

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List the transactions of a VASP. The transactions are grouped by beneficiary and originator.

Fetches a list of transactions belonging to a VASP. The transactions will be grouped showing when the VASP is beneficiary and/or originator.

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

vaspDID to get list for

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "paginateInfo": {
    }
}

List transactions

Fetches a list of transactions belonging to a VASP. Transactions can be sorted, filtered, and searched and results are paginated.

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

vaspDID to get list for

sort
string (Sort)
Enum: "transactionAmount:ASC" "transactionAmount:DESC" "updatedAt:ASC" "updatedAt:DESC" "createdAt:ASC" "createdAt:DESC"

Pass one of the supported fields you want to sort and after the colon (:), the direction, ASC or DESC.

page
integer >= 0

Page number the user wants to retrieve, default value is 0

resultsPerPage
integer <= 100
Example: resultsPerPage=100

Number of records to show per page, default value is 100

txGroup
string (Group)
Example: txGroup=INBOX

Pass INBOX here to return only the transfers available on your inbox, or remove the param to return all transfers

transactionAsset
string (TransactionAsset)
Example: transactionAsset=ETH

Filter your transfers by crypto currencies

transactionType
string (common_TransactionType)
Enum: "TRAVELRULE" "BELOW_THRESHOLD" "NON_CUSTODIAL" "UNKNOWN"

Filter your transfers by type

transactionRef
string
status
Array of strings

Filter your transactions by status

q
string

Search term for transactions

txDirection
string (Direction)
Enum: "incoming" "outgoing" "internal"

Filter your transfers by direction, incoming, outgoing or internal transfers

decrypt
boolean
Default: false

Decrypt PII data

csv
boolean

Get data in CSV format

includeActions
boolean

Include action data with the transactions

jurisdictions
Array of strings

Filter your transactions by jurisdictions

vasps
Array of strings

Filter your transactions by vasps

start
string <date> (common_Date)
Example: start=2023-07-20

Filter your transactions created after the specified date (included)

end
string <date> (common_Date)
Example: end=2023-07-20

Filter your transactions created before the specified date (included)

wallet
string

Filter your transactions by wallet address

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "paginateInfo": {
    }
}

Validate transfer Deprecated

Due to varying implementations of the Travel Rule across jurisdictions, transfers can be validated ahead of time to evaluate which transfer fields are required.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Validations Information

transactionAsset
required
string

Asset symbol (BTC,ETH)

destination
required
string

Destination Address

transactionAmount
required
string^0*[1-9][0-9]*$

Amount in base unit of the asset (satoshi, wei, etc)

originatorVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

originatorEqualsBeneficiary
required
boolean

Originator and Benefiary are the same person?

beneficiaryVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPname
string

Beneficiary VASP Name

beneficiaryName
string

Beneficiary Name

beneficiaryAccountNumber
string

Beneficiary Account Number

object (ivms101_Address)
CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

travelRuleBehavior
boolean

Should consider beneficiary's jurisdiction in determining if a transfer is of type TRAVEL_RULE

network
string

Chainalysis network

Responses

Request samples

Content type
application/json
{
  • "transactionAsset": "ETH",
  • "destination": "0x00000000219ab540356cbb839cbe05303d7705fa",
  • "transactionAmount": "1000000000",
  • "originatorVASPdid": "did:ethr:0xoriginatorDID",
  • "originatorEqualsBeneficiary": true
}

Response samples

Content type
application/json
{
  • "isValid": true,
  • "type": "BELOW_THRESHOLD",
  • "beneficiaryAddressType": "UNKNOWN",
  • "addressSource": "UNKNOWN",
  • "beneficiaryVASPname": "string",
  • "beneficiaryVASPdid": "string",
  • "errors": "beneficiaryNameMissing"
}

Fully Validate transfer

Fully Validate your transfer with this method

Authorizations:
bearerAuth
Request Body schema: application/json

Full transfer Validations Information

transactionAsset
required
string

Asset symbol (BTC,ETH)

transactionAmount
required
string^0*[1-9][0-9]*$

Amount in base unit of the asset (satoshi, wei, etc)

transactionAssetDecimals
number

Asset decimals

originatorDid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryDid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

originatorVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPname
string

Beneficiary VASP Name

required
object (TransactionBlockchainInfo)

Information about the transaction on the blockchain

object (ivms101_Originator)

The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.

object (ivms101_Beneficiary)

The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.

encrypted
string

Encrypted Personal Identificable Information (obscure schema-less value)

protocol
string (tr_TravelRuleProtocol)
Enum: "TRLight" "TRP" "OpenVASP"
targetProtocol
string (TargetProtocol)
Value: "GTR"
notificationEmail
string

Beneficiary VASP Notification Email

skipBeneficiaryDataValidation
boolean

Disable beneficiary data validation (opportunistic compliance)

travelRuleBehavior
boolean

Should consider beneficiary's jurisdiction in determining if a transfer is of type TRAVEL_RULE

CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

object (PII_IVMS)
network
string

Chainalysis network

validatePartyFields
string (ValidatePartyFields)
Enum: "BENEFICIARY" "ORIGINATOR" "ALL"

Validate transfers based on party

onBehalfOfMyself
boolean

Autopopulate originator and beneficiary fields with institution's information

Responses

Request samples

Content type
application/json
{
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "transactionAssetDecimals": "18 (ETH)",
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "beneficiaryVASPname": "string",
  • "transactionBlockchainInfo": {
    },
  • "originator": {
    },
  • "beneficiary": {
    },
  • "encrypted": "string",
  • "protocol": "TRLight",
  • "targetProtocol": "GTR",
  • "notificationEmail": "string",
  • "skipBeneficiaryDataValidation": true,
  • "travelRuleBehavior": true,
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "pii": {
    },
  • "network": "string",
  • "validatePartyFields": "BENEFICIARY",
  • "onBehalfOfMyself": true
}

Response samples

Content type
application/json
{
  • "isValid": true,
  • "type": "BELOW_THRESHOLD",
  • "beneficiaryAddressType": "UNKNOWN",
  • "addressSource": "UNKNOWN",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "beneficiaryVASPname": "string",
  • "errors": [
    ],
  • "warnings": [
    ]
}

Create transfer

Creates a new transfer. The fields required in a transfer differ depending on the jurisdiction of the originating VASP. Additional data may be provided to the beneficiary VASP depending on their jurisdiction.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfers Information

transactionRef
string

Idempotency key: to prevent duplicate transactions and proactively manage disruptions arising from the idempotency key becoming mandatory in the future, it is highly recommended to populate this field with a unique identifier for the transfer

required
string or CAIP19 (object) or CoingeckoIdAndNetwork (object)
transactionAmount
required
string^0*[1-9][0-9]*$

Amount in base unit of the asset (satoshi, wei, etc)

transactionAssetDecimals
number

Asset decimals

object or object (CustomAssetPrice)

Object containing custom asset price if not available in Notabene

originatorDid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryDid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryRef
string
originatorRef
string
originatorVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPname
string

Beneficiary VASP Name - If you do not have this data, we will try to resolve it.

beneficiaryVASPwebsite
string

Beneficiary VASP Website - If the VASP does not already have one, it is required to provide it.

required
object (TransactionBlockchainInfo)

Information about the transaction on the blockchain

object (ivms101_Originator)

The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.

object (ivms101_Beneficiary)

The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.

encrypted
string

Encrypted Personal Identificable Information (obscure schema-less value)

protocol
string (tr_TravelRuleProtocol)
Enum: "TRLight" "TRP" "OpenVASP"
targetProtocol
string (TargetProtocol)
Value: "GTR"
notificationEmail
string

Beneficiary VASP Notification Email

skipBeneficiaryDataValidation
boolean

Disable beneficiary data validation (opportunistic compliance)

travelRuleBehavior
boolean

Should consider beneficiary's jurisdiction in determining if a transfer is of type TRAVEL_RULE

CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

object (PII_IVMS)
network
string

Chainalysis network

onBehalfOfMyself
boolean

Autopopulate originator and beneficiary fields with institution's information

blockchainTransactionTimestamp
string <date-time> (DateTime)

Responses

Request samples

Content type
application/json
{
  • "transactionRef": "a4de3f3f-668f-4844-995a-03ad1b73a54e",
  • "transactionAsset": "ETH",
  • "transactionAmount": "10000000000000000",
  • "originatorVASPdid": "did:ethr:0xoriginatorDID",
  • "beneficiaryVASPdid": "did:ethr:0xbeneficiaryVASPdid",
  • "transactionBlockchainInfo": {
    },
  • "originator": {
    },
  • "beneficiary": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Approve transfer

Approves an outgoing transfer. If the VASP is present in the Notabene Directory, approving a transfer will send the transfer to them and set the transfer status to SENT. If the VASP is not in the Notabene Directory, approving the transfer will set the status to WAITING_FOR_INFORMATION.

Authorizations:
bearerAuth
query Parameters
id
required
string <uuid> (TransactionID)
Example: id=123e4567-e89b-12d3-a456-426614174000

Identifier of the Transfer

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Cancel transfer

Cancels the transfer and sets the status to CANCELLED.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Cancel Information

id
required
string <uuid> (TransactionID)

Identifier of the Transfer

vasp_did
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

reason
string

Cancel reason

Responses

Request samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "vasp_did": "did:methd:identifier",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Update transfer

Update a transfer with the passed parameters.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Update Information

id
required
string <uuid> (TransactionID)

Identifier of the Transfer

notificationEmail
string <email>

Beneficiary VASP Notification Email

txHash
string

Transaction txHash

destination
string

Destination Blockchain Address

origin
string

Origin Blockchain Address

beneficiaryDid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

originatorVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPname
string

Beneficiary VASP Name

object (ivms101_Beneficiary)

The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.

CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

originatorDid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryRef
string
originatorRef
string
object (ivms101_Originator)

The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.

CryptographicalProof (object) or ScreenshotProof (object) or SelfDeclarationProof (object) or MicroTransferProof (object) or OtherProof (object) (OwnershipProof)

Ownership Proof, which can be an CryptographicalProof, ScreenshotProof, SelfDeclarationProof or MicroTransferProof

protocol
string (tr_TravelRuleProtocol)
Enum: "TRLight" "TRP" "OpenVASP"
targetProtocol
string (TargetProtocol)
Value: "GTR"
skipBeneficiaryDataValidation
boolean

Disable beneficiary data validation (opportunistic compliance)

isNonCustodial
boolean

Is a Non Custodial Transfer

object (PII_IVMS)
onBehalfOfMyself
boolean

Autopopulate originator and beneficiary fields with institution's information

blockchainTransactionTimestamp
string <date-time> (DateTime)
comment
string

Transaction comment

Responses

Request samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "notificationEmail": "[email protected]",
  • "txHash": "string",
  • "destination": "string",
  • "origin": "string",
  • "beneficiaryDid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPname": "string",
  • "beneficiary": {
    },
  • "beneficiaryProof": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryRef": "string",
  • "originatorRef": "string",
  • "originator": {
    },
  • "originatorProof": {
    },
  • "protocol": "TRLight",
  • "targetProtocol": "GTR",
  • "skipBeneficiaryDataValidation": true,
  • "isNonCustodial": true,
  • "pii": {
    },
  • "onBehalfOfMyself": true,
  • "blockchainTransactionTimestamp": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Confirm transfer

Confirms that the blockchain address of the transfer belongs to the beneficiary VASP. Confirming sets the status of a transfer to ACK.

Authorizations:
bearerAuth
query Parameters
id
string <uuid> (TransactionID)
Example: id=123e4567-e89b-12d3-a456-426614174000

Identifier of the Transfer

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Notify transfer

Notifies the originator VASP of an incoming transfer on the blockchain.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Notify Information

txHash
required
string^[^\s]+$

Transaction hash

transactionAmount
required
string^0*[1-9][0-9]*$

Amount in base unit of the asset (satoshi, wei, etc)

required
string or CAIP19 (object) or CoingeckoIdAndNetwork (object)
transactionAssetDecimals
number

Asset decimals

beneficiaryVASPdid
required
string

BeneficiaryVASP did

destination
required
string non-empty

Destination Address

origin
string non-empty

Origin Address

customerRef
string

VASP Customer Reference Id

network
string

Chainalysis network

targetProtocol
string (TargetProtocol)
Value: "GTR"
encrypted
string

Encrypted data

Responses

Request samples

Content type
application/json
{
  • "txHash": "string",
  • "transactionAmount": "string",
  • "transactionAsset": "string",
  • "transactionAssetDecimals": "18 (ETH)",
  • "beneficiaryVASPdid": "string",
  • "destination": "string",
  • "origin": "string",
  • "customerRef": "string",
  • "network": "string",
  • "targetProtocol": "GTR",
  • "encrypted": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Reject transfer

Rejects a transfer indicating that the blockchain address is not owned by the beneficiary VASP. Rejecting sets the transfer status to REJECTED.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Reject Information

id
required
string <uuid> (TransactionID)

Identifier of the Transfer

reason
string

Reject reason

Responses

Request samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Mark a transfer as not ready

Marks a transfer as not ready, as the VASP is not ready yet to respond. The transfer status is NOT_READY.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Information

id
required
string <uuid> (TransactionID)

Identifier of the Transfer

reason
string

Reason to mark the transfer as not ready

Responses

Request samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Accept transfer

Accepts a transfer setting the status to ACCEPTED. Transfers can be automatically accepted by setting rules in the rules engine or manually using this endpoint.

Authorizations:
bearerAuth
query Parameters
id
required
string <uuid> (TransactionID)
Example: id=123e4567-e89b-12d3-a456-426614174000

Identifier of the Transfer

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Decline transfer

Declines a transfer setting the status to DECLINED. Transfers can be automatically declined by setting rules in the rules engine or manually using this endpoint.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Decline Information

id
required
string <uuid> (TransactionID)

Identifier of the Transfer

reason
string

Decline reason

Responses

Request samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Redirect transfer

Redirecting transfer allows beneficiary VASPs to route incoming transfers from one subsidiary to another.

Authorizations:
bearerAuth
query Parameters
id
required
string <uuid> (TransactionID)
Example: id=123e4567-e89b-12d3-a456-426614174000

Identifier of the Transfer

to
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: to=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Bulk edit transfers

Actions can be performed on transfers in bulk such as approving, cancelling, confirming, rejecting etc.

Authorizations:
bearerAuth
Request Body schema: application/json

Bulk Transfer Input

action
required
string (BulkAction)
Enum: "accept" "approve" "cancel" "confirm" "decline" "reject" "notReady" "redirect"

Available bulk actions to take on transactions

originatorVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

originAddress
string

(Optional) Limit bulk operations to transactions originating from specified blockchain address

destinationAddress
string

(Optional) Limit bulk operations to transactions being sent to specified blockchain address

reason
string

(Optional) Cancel/Decline/Reject reason

beneficiaryVASPdidTo
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

Responses

Request samples

Content type
application/json
{
  • "action": "accept",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "originAddress": "string",
  • "destinationAddress": "string",
  • "reason": "string",
  • "beneficiaryVASPdidTo": "did:methd:identifier"
}

Response samples

Content type
application/json
[
  • {
    }
]

Receive transfer

Receive a transfer from a segregated node.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Receive Request

transactionId
required
string

Transaction id

address
required
string

Blockchain address

required
string or CAIP19 (object) or CoingeckoIdAndNetwork (object)
originatorVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

Responses

Request samples

Content type
application/json
{
  • "transactionId": "string",
  • "address": "string",
  • "asset": "string",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

Update pending TR data

Update a transfer coming from another node.

Authorizations:
bearerAuth
Request Body schema: application/json

Transfer Update TR Request

transactionId
required
string

Transaction id

destinationAddress
required
string

Blockchain address

assetType
required
string

Notabene Asset Symbol

amount
required
string

Transaction amount

object (PII_IVMS)
originatorVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

beneficiaryVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

Responses

Request samples

Content type
application/json
{
  • "transactionId": "string",
  • "destinationAddress": "string",
  • "assetType": "string",
  • "amount": "string",
  • "pii": {
    },
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "status": "SAVED",
  • "transactionType": "BELOW_THRESHOLD",
  • "transactionAsset": "ETH",
  • "transactionAmount": "string",
  • "chargedQuantity": 0,
  • "amountInLocalCurrency": {
    },
  • "beneficiaryAmountInLocalCurrency": {
    },
  • "originatorDid": "did:methd:identifier",
  • "beneficiaryDid": "did:methd:identifier",
  • "originatorVASPdid": "did:methd:identifier",
  • "beneficiaryVASPdid": "did:methd:identifier",
  • "transactionBlockchainInfo": {
    },
  • "ivms101": {
    },
  • "ivms101Encrypted": "string",
  • "protocol": "TRLight",
  • "protocolData": {
    },
  • "originatorProof": {
    },
  • "beneficiaryProof": {
    },
  • "actions": [
    ],
  • "pii": {
    },
  • "comments": [
    ]
}

TrustFramework

The Notabene Trust Framework refers to the network of VASPs that send and receive transfers.

You can browse through the Notabene Directory to see more information about which VASPs are receiving Travel Rule transfers and the protocols they follow.

Create VASP

To begin accepting transactions as a VASP, you first create a VASP.

query Parameters
challengeToken
required
string

ChallengeToken

Request Body schema: application/json

Create User and VASP through light onboarding

object (common_VaspFields)

List of VASP fields

object (common_UserFields)

List of User fields

Responses

Request samples

Content type
application/json
{
  • "vaspFields": {
    },
  • "userFields": {
    }
}

Response samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "fields": [
    ],
  • "documents": [
    ],
  • "hasAdmin": true,
  • "isActiveSender": true,
  • "isActiveReceiver": true
}

Get VASP

Returns information about a VASP that has the specified DID.

Authorizations:
bearerAuthNone
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

query Parameters
fields
string

csv of fields to return

reviewedByVaspDID
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: reviewedByVaspDID=did:methd:identifier

include reviewed vasps for specified did

showJurisdictionStatus
boolean

include jurisdiction status information

includeSubsidiaries
boolean

include subsidiaries of particular vasp

includeDeletedVASPs
boolean
Default: false

include vasp even if it has been deleted

Responses

Response samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "name": "string",
  • "website": "string",
  • "logo": "string",
  • "incorporationCountry": "string",
  • "documents": "string",
  • "hasAdmin": true,
  • "isNotifiable": true,
  • "isActiveSender": true,
  • "isActiveReceiver": true,
  • "issuers": "string"
}

List VASPs

Returns a list of VASPs. VASPs can be searched and sorted and results are paginated.

Authorizations:
bearerAuthNone
query Parameters
q
string

string to query

emailDomain
string

filter on email domain

chainalysisName
string

filter on chainalysis name

hasAdmin
boolean

filter on hasAdmin true or false

badge
string
Enum: "super_vasp" "verified" "in_network" "claimed"

filter by badge

jurisdictions
string

filter by jurisdictions

fields
string

csv of fields to return

page
integer

page number

per_page
integer

records per page

order
string^([ A-Za-z]+(:(ASC|DESC))?(:NULLS (FIRST|LAST...

field to order by

all
boolean

return all records

listingType
string
Enum: "exclude_subsidiaries" "exclude_gateways" "all"

Choose the way gateway VASPs and non-gateway VASPs are returned. By default, exclude_subsidiaries.

includeUncheckedVASPs
boolean
Default: false

include vasps that have not been internally checked

includeDeletedVASPs
boolean
Default: false

include vasps that have been deleted

includeActiveSendersOnly
boolean
Default: false

include only those vasps that are sending transactions

includeActiveReceiversOnly
boolean
Default: false

include only those vasps that are receiving transactions

regulatoryStatus
string
Default: false
Enum: "Exempt" "No longer exempt" "Not Regulated" "No longer regulated" "Pending" "Regulated"

include only those vasps matching the specified regulatory status

networkStatus
string
Default: false
Enum: "Pending" "Verified" "Unverified"

include only those vasps matching the specified network status

asset
string

asset symbol, provide when filtering by wallet

reviewedByVaspDID
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: reviewedByVaspDID=did:methd:identifier

include reviewed vasps for specified did

showJurisdictionStatus
boolean

include jurisdiction status information

reviewValue
string
Enum: "TRUSTED" "BLOCKED" "MANUAL" "NULL"

include reviewed vasps containing specified value

reviewIncludeInWidget
Array of strings
Items Enum: "YES" "NO" "UNDECIDED"

include vasps with included in widget or not

filterByJurisdictionStatus
string
Enum: "inForce" "gracePeriodOngoing" "limitedScope" "plansAnnounced" "notAvailable"

filter by specified jurisdiction status

Responses

Response samples

Content type
application/json
{
  • "vasps": [
    ],
  • "pagination": {
    }
}

List VASPs that closely match the specified name

Authorizations:
bearerAuthNone
query Parameters
name
string

VASP name

Responses

Response samples

Content type
application/json
{
  • "did": "string"
}

Get VASP Travel Rule protocols

Returns the Travel Rule protocols the VASP uses.

path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Responses

Response samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "fields": [
    ],
  • "documents": [
    ],
  • "hasAdmin": true,
  • "isActiveSender": true,
  • "isActiveReceiver": true
}

Update VASP

Updates a VASP with the provided parameters.

Authorizations:
bearerAuth
Request Body schema: application/json

VASP update information

did
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
Array of objects (common_IdentityFields)

List of fields

Responses

Request samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "did": "did:methd:identifier",
  • "fields": [
    ],
  • "documents": [
    ],
  • "hasAdmin": true,
  • "isActiveSender": true,
  • "isActiveReceiver": true
}

Delete VASP

Deletes a VASP that has the specified DID.

Authorizations:
bearerAuthNone
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

query Parameters
redirectDID
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: redirectDID=did:methd:identifier

VASP DID to redirect transactions to

Responses

Response samples

Content type
application/json
{
  • "deletedVASP": true,
  • "message": "string"
}

Review VASP

Mark a VASP as TRUSTED, BLOCKED, or MANUAL

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

The VASP who is adding to their review list

Request Body schema: application/json
reviewedVaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

reviewValue
required
string
Enum: "TRUSTED" "BLOCKED" "MANUAL"

The review value

note
string

Review note

includeInWidget
string
Default: "UNDECIDED"
Enum: "YES" "NO" "UNDECIDED"

Include this VASP in widget

Responses

Request samples

Content type
application/json
{
  • "reviewedVaspDID": "did:methd:identifier",
  • "reviewValue": "TRUSTED",
  • "note": "string",
  • "includeInWidget": "YES"
}

Response samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "reviewedVaspDID": "did:methd:identifier",
  • "reviewValue": "string",
  • "note": "string",
  • "includeInWidget": "string",
  • "createdAt": "string",
  • "createdBy": "did:methd:identifier"
}

Create a VASP did

Generate a VASP did.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "did": "did:methd:identifier"
}

Get top counterparty data

Get VASP data for top 20 counterparties

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "lastUpdated": "string",
  • "results": [
    ]
}

Documents

Various documents can be uploaded using the Notabene API such as certificates of incorporation, due-dilligence questionnaires etc.

Get upload URL

To upload a document you must first request a URL to upload to. Upload URLs are short-lived AWS S3 bucket upload URLs.

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

query Parameters
documentType
string

documentType

Responses

Response samples

Content type
application/json
{
  • "uploadUrl": "string",
  • "uploadFields": [
    ]
}

Get document

Returns the location of the uploaded document stored in AWS S3

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

query Parameters
s3URL
string

S3 URL where the document is located

Responses

Response samples

Content type
application/json
{
  • "message": null
}

Delete document

Deletes the document stored in AWS S3

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

query Parameters
s3URL
string

S3 URL where the document is located

Responses

Response samples

Content type
application/json
{
  • "message": null
}

Request, Accept, Reject or Revoke Document Access

Request, Accept, Reject or Revoke Document Access. For example, you can use this API endpoint to request access to a counterparty VASPs due-dilligence document.

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

vaspDID of document owner

query Parameters
requestingVASPdid
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: requestingVASPdid=did:methd:identifier

vaspDID of party subject to document access

documentType
required
string (DocumentType)
Value: "DDQ for Travel Rule Data Sharing"

type of the document

accessAction
required
string (DocumentAccessAction)
Enum: "REQUEST" "APPROVE" "DECLINE" "REVOKE"

access action

metadata
string

metadata (eg. reason for decline/revoke)

Responses

Response samples

Content type
application/json
{
  • "message": null,
  • "status": "WAITING_FOR_INFORMATION"
}

Get document requests

Lists all requests from counterparty VASPS to your documents

Authorizations:
bearerAuth
path Parameters
required
common_DID (string) or OutgoingRequests (string)

DID of the VASP who's doc is being requested

query Parameters
requestingVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: requestingVASPdid=did:methd:identifier

(optional) DID of the VASP who is requesting the document

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get DDQ document of vaspDID

Get DDQ document of vaspDID

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

DID of the VASP who's doc is being requested

query Parameters
requestingVASPdid
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: requestingVASPdid=did:methd:identifier

DID of the VASP who is requesting the document

Responses

Response samples

Content type
application/json
{ }

S3 image retrieval endpoint

Authorizations:
bearerAuthNone
query Parameters
s3Key
required
string^(did:ethr:|did:web:)

S3 key for which a presigned URL will be generated. Must start with did:ethr: or did:web:.

Responses

Response samples

Content type
application/json
{
  • "expiresSeconds": 0,
  • "presignedUrl": "string"
}

Address Book

Get upload URL

To upload an address book you must first request a URL to uploda to. Upload URLs are short-lived AWS S3 bucket URLs.

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Responses

Response samples

Content type
application/json
{
  • "uploadUrl": "string",
  • "uploadFields": [
    ]
}

Register address

Registers the blockchain address of a customer in your address book.

Authorizations:
bearerAuth
Request Body schema: application/json

Customer Address Info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

string or CAIP19 (object) or CoingeckoIdAndNetwork (object)
address
required
string non-empty
customerRef
required
string

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "asset": "ETH",
  • "address": "string",
  • "customerRef": "string"
}

Get address ownership information

Get the ownership information about a customer blockchain address.

Authorizations:
bearerAuth
path Parameters
address
required
string (BlockchainAddress)
Example: 0x489c818ca8b9251b393131b08a736a67ccb19298

Blockchain address

query Parameters
vasp_did
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vasp_did=did:methd:identifier

VASP DID

asset
required
string (Asset)
Example: asset=ETH

Crypto currency

Responses

Response samples

Content type
application/json
{
  • "owner_vasp_did": "string",
  • "owner_vasp_name": "string",
  • "address": "0x489c818ca8b9251b393131b08a736a67ccb19298",
  • "address_type": "HOSTED",
  • "asset": "ETH",
  • "source": "UNKNOWN"
}

Get addresses registered

Get the addresses registered for a VASP.

Authorizations:
bearerAuth
query Parameters
vasp_did
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vasp_did=did:methd:identifier

VASP DID

source
required
string (BlockchainAddressQuerySource)
Value: "ADDRESS_GRAPH"

Blockchain address query sources available

source_type
string (QuerySourceType)
Enum: "INTERNAL" "EXTERNAL"

Query source types (if not provided, it will return all addresses):

  • INTERNAL - Internal address book: addresses owned by a VASP. It can be populated by uploading a CSV, confirming incoming transfers, registering addresses. It is used to confirm transfers.
  • EXTERNAL - External address book: addresses owned by counterparty VASPs. It is populated only when a counterparty VASP confirms a transfer that another VASP sent them. It is used to identify counterparty VASP via Validate / Widget / Network Discovery flows.
page
integer (PaginationPage)

Page number

per_page
integer (PaginationPerPage)

Records per page

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "metadata": {
    },
  • "data": [
    ]
}

Delete addresses

Delete addresses previously added to the address book.

Authorizations:
bearerAuth
query Parameters
addresses
required
string^([^,]+,)*([^,]+)$
Example: addresses=0x123,0x456

Comma-separated list of addresses to delete

vasp_did
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vasp_did=did:methd:identifier

VASP DID

Responses

Response samples

Content type
application/json
{
  • "message": "Deleting 10 addresses."
}

Rules

Setting up transfer rules makes accepting and declining incoming transfers manageable at scale. Rules can be setup to automatically accept or decline transfers based on sanctions checks, wallet address queries and more.

List rules

Returns a list of transfer rules that have been setup.

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

vaspDID to get list of transfer rules

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set rules

Sets the transfer rules to be applied to transactions.

Authorizations:
bearerAuth
Request Body schema: application/json

Set rules to rules engine input with direction

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Incoming and Outgoing set of rules

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "ruleSet": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Deletes rules from the provided ids

Deletes rules and Returns a list of transfer rules that have been setup.

Authorizations:
bearerAuth
Request Body schema: application/json

Delete ids array

vaspDID
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Settings

Update a VASP's settings

Update a VASP's settings.

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Request Body schema: application/json

Settings to be updated

autoconfirm
boolean
statusToProcessBlockchain
any
Enum: "CREATED" "SENT" "ACK" "ACCEPTED" null
vaspDiscoverability
boolean
autoredirect
boolean
requestTrackingForMissingData
boolean
useLocalCurrencyInAnalytics
boolean
autoDecryption
boolean

Responses

Request samples

Content type
application/json
{
  • "autoconfirm": true,
  • "statusToProcessBlockchain": "CREATED",
  • "vaspDiscoverability": true,
  • "autoredirect": true,
  • "requestTrackingForMissingData": true,
  • "useLocalCurrencyInAnalytics": true,
  • "autoDecryption": true
}

Response samples

Content type
application/json
{
  • "autoconfirm": true,
  • "statusToProcessBlockchain": "CREATED",
  • "vaspDiscoverability": true,
  • "autoredirect": true,
  • "requestTrackingForMissingData": true,
  • "useLocalCurrencyInAnalytics": true,
  • "autoDecryption": true
}

Get a VASP's settings

Get a VASP's settings

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Responses

Response samples

Content type
application/json
{
  • "autoconfirm": true,
  • "statusToProcessBlockchain": "CREATED",
  • "vaspDiscoverability": true,
  • "autoredirect": true,
  • "requestTrackingForMissingData": true,
  • "useLocalCurrencyInAnalytics": true,
  • "autoDecryption": true
}

Transaction webhook

Create a notification webhook Deprecated

Creates a webhook for the passed callback URL that will be notified every time a transfer changes state.

Authorizations:
bearerAuth
Request Body schema: application/json

Tx Notification Config Information

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

callbackUrl
required
string

Callback URL

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "callbackUrl": "string"
}

Get a notification webhook

Returns a webhook that has been setup for your account.

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "callbackUrl": "string"
}

Address webhook

Register a Webhook for querying addresses

Register a Webhook for querying addresses

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Request Body schema: application/json

Register Webhook Input

url
required
string

A URL with HTTPS protocol

params
required
string^\?([\w-]+(=[\w-]*)?(&[\w-]+(=[\w-]*)?)*)?$

All of the query params needed appended in string format

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "params": "string"
}

Response samples

Content type
application/json
{
  • "secret": "string"
}

Delete a Webhook for querying addresses

Delete a Webhook for querying addresses

Authorizations:
bearerAuth
path Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: did:methd:identifier

VASP DID

Responses

Response samples

Content type
application/json
{
  • "isDeleted": true,
  • "message": "string"
}

LexisNexis

LexisNexis sanctions check

LexisNexis sanctions check

Authorizations:
bearerAuth
Request Body schema: application/json

LexisNexis sanctions check

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasMatches": true,
  • "metadata": { },
  • "matches": [
    ]
}

Set LexisNexis credentials

Set LexisNexis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set LexisNexis credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete LexisNexis credentials

Delete LexisNexis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check LexisNexis credentials

Check LexisNexis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

Chainalysis

Chainalysis address info

Chainalysis address info

Authorizations:
bearerAuth
Request Body schema: application/json

Chainalysis address info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "addressType": "string",
  • "asset": "string",
  • "source": "string",
  • "metadata": { },
  • "custodialVASPdid": "string",
  • "custodialVASPname": "string",
  • "score": "string"
}

Set Chainalysis credentials

Set Chainalysis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set Chainalysis credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete Chainalysis credentials

Delete Chainalysis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check Chainalysis credentials

Check Chainalysis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

Set Chainalysis credentials

Set Chainalysis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set Chainalysis credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete Chainalysis credentials

Delete Chainalysis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check Chainalysis credentials

Check Chainalysis credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

Elliptic

Elliptic address info

Elliptic address info

Authorizations:
bearerAuth
Request Body schema: application/json

Elliptic address info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "addressType": "string",
  • "asset": "string",
  • "source": "string",
  • "metadata": { },
  • "custodialVASPdid": "string",
  • "custodialVASPname": "string",
  • "score": "string"
}

Set Elliptic credentials

Set Elliptic credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set Elliptic credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete Elliptic credentials

Delete Elliptic credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check Elliptic credentials

Check Elliptic credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

Refinitiv

Refinitiv sanctions check

Refinitiv sanctions check

Authorizations:
bearerAuth
Request Body schema: application/json

Refinitiv sanctions check

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasMatches": true,
  • "metadata": { },
  • "matches": [
    ]
}

Set Refinitiv credentials

Set Refinitiv credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set Refinitiv credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete Refinitiv credentials

Delete Refinitiv credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check Refinitiv credentials

Check Refinitiv credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

TRM

TRM address info

TRM address info

Authorizations:
bearerAuth
Request Body schema: application/json

TRM address info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "addressType": "string",
  • "asset": "string",
  • "source": "string",
  • "metadata": { },
  • "custodialVASPdid": "string",
  • "custodialVASPname": "string",
  • "score": "string"
}

Set TRM credentials

Set TRM credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set TRM credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete TRM credentials

Delete TRM credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check TRM credentials

Check TRM credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

TRMSanctions

TRMSanctions sanctions check

TRMSanctions sanctions check

Authorizations:
bearerAuth
Request Body schema: application/json

TRMSanctions sanctions check

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasMatches": true,
  • "metadata": { },
  • "matches": [
    ]
}

Set TRMSanctions credentials

Set TRMSanctions credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set TRMSanctions credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete TRMSanctions credentials

Delete TRMSanctions credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check TRMSanctions credentials

Check TRMSanctions credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

Coinfirm

Coinfirm address info

Coinfirm address info

Authorizations:
bearerAuth
Request Body schema: application/json

Coinfirm address info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "addressType": "string",
  • "asset": "string",
  • "source": "string",
  • "metadata": { },
  • "custodialVASPdid": "string",
  • "custodialVASPname": "string",
  • "score": "string"
}

Set Coinfirm credentials

Set Coinfirm credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set Coinfirm credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete Coinfirm credentials

Delete Coinfirm credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check Coinfirm credentials

Check Coinfirm credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

MerkleScience

MerkleScience address info

MerkleScience address info

Authorizations:
bearerAuth
Request Body schema: application/json

MerkleScience address info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "addressType": "string",
  • "asset": "string",
  • "source": "string",
  • "metadata": { },
  • "custodialVASPdid": "string",
  • "custodialVASPname": "string",
  • "score": "string"
}

Set MerkleScience credentials

Set MerkleScience credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set MerkleScience credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete MerkleScience credentials

Delete MerkleScience credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check MerkleScience credentials

Check MerkleScience credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

Bitgo

Bitgo address info

Bitgo address info

Authorizations:
bearerAuth
Request Body schema: application/json

Bitgo address info

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "addressType": "string",
  • "asset": "string",
  • "source": "string",
  • "metadata": { },
  • "custodialVASPdid": "string",
  • "custodialVASPname": "string"
}

Set Bitgo credentials

Set Bitgo credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set Bitgo credentials

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete Bitgo credentials

Delete Bitgo credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check Bitgo credentials

Check Bitgo credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}

ComplyAdvantage

ComplyAdvantage sanctions check

ComplyAdvantage sanctions check

Authorizations:
bearerAuth
Request Body schema: application/json

ComplyAdvantage sanctions check

vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$

Decentralized Identifier

required
object

Responses

Request samples

Content type
application/json
{
  • "vaspDID": "did:methd:identifier",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "hasMatches": true,
  • "metadata": { },
  • "matches": [
    ]
}

Set ComplyAdvantage credentials

Set ComplyAdvantage credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Request Body schema: application/json

Set ComplyAdvantage credentials

required
object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "hasCredentialsBeenStored": true,
  • "message": "string"
}

Delete ComplyAdvantage credentials

Delete ComplyAdvantage credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasCredentialsBeenDeleted": true,
  • "message": "string"
}

Check ComplyAdvantage credentials

Check ComplyAdvantage credentials

Authorizations:
bearerAuth
query Parameters
vaspDID
required
string (common_DID) ^did:[a-zA-Z0-9]*:.*$
Example: vaspDID=did:methd:identifier

Decentralized Identifier

Responses

Response samples

Content type
application/json
{
  • "hasApiCredentials": true,
  • "message": "string"
}