# Notabene API

> Notabene API on Apizie: 113 endpoints (Get upload URL, Register address, Get address ownership information, Get addresses registered, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/security:notabene/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:notabene`
- Category: Security
- Status: byok
- Source: https://notabene.id
- Page: https://apizie.tech/api/security/notabene
- OpenAPI: https://apizie.tech/api/security/notabene/openapi.json

The Notabene API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API accepts [JSON-encoded](http://www.json.org/) request bodies, returns…

## Endpoints

### Get upload URL
`GET https://apizie.tech/v1/security:notabene/address-book-request-upload-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |

### Register address
`POST https://apizie.tech/v1/security:notabene/address-book-register-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get address ownership information
`GET https://apizie.tech/v1/security:notabene/address-book-get-ownership-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| address | string | yes | Blockchain address |
| vasp_did | string | yes | VASP DID |
| asset | string | yes | Crypto currency |

### Get addresses registered
`GET https://apizie.tech/v1/security:notabene/address-book-get-registered-addresses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vasp_did | string | yes | VASP DID |
| source | string | yes | Blockchain address query sources available |
| source_type | string | no | Query source types (if not provided, it will return all addresses): * `INTERNAL` - **Internal address book**: addresses owned by a VASP.… |
| page | integer | no | Page number |
| per_page | integer | no | Records per page |

### Delete addresses
`POST https://apizie.tech/v1/security:notabene/address-book-remove-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| addresses | string | yes | Comma-separated list of addresses to delete |
| vasp_did | string | yes | VASP DID |

### Get customer access token
`POST https://apizie.tech/v1/security:notabene/authentication-get-customer-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update user
`POST https://apizie.tech/v1/security:notabene/authentication-update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get API credentials
`GET https://apizie.tech/v1/security:notabene/credentials-get-auth0-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Create new API credentials
`POST https://apizie.tech/v1/security:notabene/credentials-create-new-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete API credentials
`POST https://apizie.tech/v1/security:notabene/credentials-delete-auth0-api-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| clientid | string | no | auth0 clientId |

### List VASP users
`GET https://apizie.tech/v1/security:notabene/vasp-admin-list-vasp-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |

### Add user to VASP
`POST https://apizie.tech/v1/security:notabene/vasp-admin-add-user-to-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Remove user from VASP
`POST https://apizie.tech/v1/security:notabene/vasp-admin-remove-user-from-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create customer
`POST https://apizie.tech/v1/security:notabene/customer-create-new-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get customer
`GET https://apizie.tech/v1/security:notabene/customer-get-by-dids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| customerDID | string | yes | Customer DID |

### Register a Webhook for querying addresses
`POST https://apizie.tech/v1/security:notabene/address-webhook-register-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| body | object | no | JSON request body |

### Delete a Webhook for querying addresses
`POST https://apizie.tech/v1/security:notabene/address-webhook-delete-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |

### Get a notification webhook
`GET https://apizie.tech/v1/security:notabene/transaction-webhook-get-notification-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Get Third Party Providers
`GET https://apizie.tech/v1/security:notabene/providers-get-configured` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Chainalysis address info
`POST https://apizie.tech/v1/security:notabene/chainalysis-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check Chainalysis credentials
`GET https://apizie.tech/v1/security:notabene/chainalysis-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set Chainalysis credentials
`POST https://apizie.tech/v1/security:notabene/chainalysis-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete Chainalysis credentials
`POST https://apizie.tech/v1/security:notabene/chainalysis-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Chainalysis v2 address info
`POST https://apizie.tech/v1/security:notabene/chainalysis2-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check Chainalysis credentials
`GET https://apizie.tech/v1/security:notabene/chainalysis-check-credentials-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set Chainalysis credentials
`POST https://apizie.tech/v1/security:notabene/chainalysis-set-credentials-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete Chainalysis credentials
`POST https://apizie.tech/v1/security:notabene/chainalysis-delete-credentials-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### LexisNexis sanctions check
`POST https://apizie.tech/v1/security:notabene/lexis-nexis-perform-sanctions-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check LexisNexis credentials
`GET https://apizie.tech/v1/security:notabene/lexis-nexis-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set LexisNexis credentials
`POST https://apizie.tech/v1/security:notabene/lexis-nexis-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete LexisNexis credentials
`POST https://apizie.tech/v1/security:notabene/lexis-nexis-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### TRM address info
`POST https://apizie.tech/v1/security:notabene/trm-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check TRM credentials
`GET https://apizie.tech/v1/security:notabene/trm-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set TRM credentials
`POST https://apizie.tech/v1/security:notabene/trm-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete TRM credentials
`POST https://apizie.tech/v1/security:notabene/trm-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### TRMSanctions sanctions check
`POST https://apizie.tech/v1/security:notabene/trm-sanctions-sanctions-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check TRMSanctions credentials
`GET https://apizie.tech/v1/security:notabene/trm-sanctions-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set TRMSanctions credentials
`POST https://apizie.tech/v1/security:notabene/trm-sanctions-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete TRMSanctions credentials
`POST https://apizie.tech/v1/security:notabene/trm-sanctions-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Coinfirm address info
`POST https://apizie.tech/v1/security:notabene/coinfirm-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check Coinfirm credentials
`GET https://apizie.tech/v1/security:notabene/coinfirm-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set Coinfirm credentials
`POST https://apizie.tech/v1/security:notabene/coinfirm-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete Coinfirm credentials
`POST https://apizie.tech/v1/security:notabene/coinfirm-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Bitgo address info
`POST https://apizie.tech/v1/security:notabene/bitgo-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check Bitgo credentials
`GET https://apizie.tech/v1/security:notabene/bitgo-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set Bitgo credentials
`POST https://apizie.tech/v1/security:notabene/bitgo-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete Bitgo credentials
`POST https://apizie.tech/v1/security:notabene/bitgo-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### ComplyAdvantage sanctions check
`POST https://apizie.tech/v1/security:notabene/comply-advantage-sanctions-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check ComplyAdvantage credentials
`GET https://apizie.tech/v1/security:notabene/comply-advantage-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set ComplyAdvantage credentials
`POST https://apizie.tech/v1/security:notabene/comply-advantage-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete ComplyAdvantage credentials
`POST https://apizie.tech/v1/security:notabene/comply-advantage-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Refinitiv sanctions check
`POST https://apizie.tech/v1/security:notabene/refinitiv-sanctions-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check Refinitiv credentials
`GET https://apizie.tech/v1/security:notabene/refinitiv-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set Refinitiv credentials
`POST https://apizie.tech/v1/security:notabene/refinitiv-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete Refinitiv credentials
`POST https://apizie.tech/v1/security:notabene/refinitiv-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### MerkleScience address info
`POST https://apizie.tech/v1/security:notabene/merkle-science-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check MerkleScience credentials
`GET https://apizie.tech/v1/security:notabene/merkle-science-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set MerkleScience credentials
`POST https://apizie.tech/v1/security:notabene/merkle-science-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete MerkleScience credentials
`POST https://apizie.tech/v1/security:notabene/merkle-science-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Elliptic address info
`POST https://apizie.tech/v1/security:notabene/elliptic-get-address-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Check Elliptic credentials
`GET https://apizie.tech/v1/security:notabene/elliptic-check-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Set Elliptic credentials
`POST https://apizie.tech/v1/security:notabene/elliptic-set-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |
| body | object | no | JSON request body |

### Delete Elliptic credentials
`POST https://apizie.tech/v1/security:notabene/elliptic-delete-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Get the configured Protocol Agents for a given VASP
`GET https://apizie.tech/v1/security:notabene/protocol-agents-get-configured-protocol-agents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |

### Register a Protocol Agent for a given VASP
`POST https://apizie.tech/v1/security:notabene/protocol-agents-register-for-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Unregister a Protocol Agent for a given VASP
`POST https://apizie.tech/v1/security:notabene/protocol-agents-unregister-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Handle a Protocol Agent Message
`POST https://apizie.tech/v1/security:notabene/protocol-agents-handle-agent-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Address confirmation resolution
`POST https://apizie.tech/v1/security:notabene/protocol-gateways-address-confirmation-resolution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transactionId | string | yes | Transaction ID |
| body | object | no | JSON request body |

### Receive Transfer resolution
`POST https://apizie.tech/v1/security:notabene/protocol-gateways-receive-transfer-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transactionId | string | yes | Transaction ID |
| body | object | no | JSON request body |

### Get the registered multi-message Webhook URL for a given VASP.
`GET https://apizie.tech/v1/security:notabene/webhooks-get-registration-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | The VASP DID |

### Register the multi-message Webhook URL for a given VASP.
`POST https://apizie.tech/v1/security:notabene/webhooks-register-multi-message-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Unregister the multi-message Webhook for a given VASP.
`POST https://apizie.tech/v1/security:notabene/webhooks-unregister-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create VASP
`POST https://apizie.tech/v1/security:notabene/trust-framework-initiate-vasp-creation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| challengeToken | string | yes | ChallengeToken |
| body | object | no | JSON request body |

### Get VASP
`GET https://apizie.tech/v1/security:notabene/trust-framework-get-vasp-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| fields | string | no | csv of fields to return |
| reviewedByVaspDID | string | no | include reviewed vasps for specified did |
| showJurisdictionStatus | boolean | no | include jurisdiction status information |
| includeSubsidiaries | boolean | no | include subsidiaries of particular vasp |

### List VASPs
`GET https://apizie.tech/v1/security:notabene/trust-framework-list-vasps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | no | string to query |
| emailDomain | string | no | filter on email domain |
| chainalysisName | string | no | filter on chainalysis name |
| hasAdmin | boolean | no | filter on hasAdmin true or false |
| badge | string | no | filter by badge |
| jurisdictions | string | no | filter by jurisdictions |
| fields | string | no | csv of fields to return |
| page | integer | no | page number |
| per_page | integer | no | records per page |
| order | string | no | field to order by |
| all | boolean | no | return all records |
| listingType | string | no | Choose the way gateway VASPs and non-gateway VASPs are returned. By default, exclude_subsidiaries. |
| includeUncheckedVASPs | boolean | no | include vasps that have not been internally checked |
| includeActiveSendersOnly | boolean | no | include only those vasps that are sending transactions |
| includeActiveReceiversOnly | boolean | no | include only those vasps that are receiving transactions |
| regulatoryStatus | string | no | include only those vasps matching the specified regulatory status |
| asset | string | no | asset symbol, provide when filtering by wallet |
| reviewedByVaspDID | string | no | include reviewed vasps for specified did |
| showJurisdictionStatus | boolean | no | include jurisdiction status information |
| reviewValue | string | no | include reviewed vasps containing specified value |
| filterByJurisdictionStatus | string | no | filter by specified jurisdiction status |

### Get VASP Travel Rule protocols
`GET https://apizie.tech/v1/security:notabene/trust-framework-get-travel-rule-protocols` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |

### Update VASP
`POST https://apizie.tech/v1/security:notabene/trust-framework-update-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Delete VASP
`GET https://apizie.tech/v1/security:notabene/trust-framework-delete-vasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| redirectDID | string | no | VASP DID to redirect transactions to |

### Review VASP
`POST https://apizie.tech/v1/security:notabene/trust-framework-mark-vasp-review` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | The VASP who is adding to their review list |
| body | object | no | JSON request body |

### Get VASPs associated with user
`GET https://apizie.tech/v1/security:notabene/trust-framework-get-user-vasp-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | csv of fields to return |

### Create a VASP did
`POST https://apizie.tech/v1/security:notabene/trust-framework-create-vasp-did` (byok)

### Get top counterparty data
`GET https://apizie.tech/v1/security:notabene/trust-framework-get-top-counterparty-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | Decentralized Identifier |

### Update a VASP's settings
`POST https://apizie.tech/v1/security:notabene/settings-update-vasp-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| body | object | no | JSON request body |

### Get a VASP's settings
`GET https://apizie.tech/v1/security:notabene/settings-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |

### Get upload URL
`GET https://apizie.tech/v1/security:notabene/documents-get-upload-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| documentType | string | no | documentType |

### Get document
`GET https://apizie.tech/v1/security:notabene/documents-get-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| s3URL | string | no | S3 URL where the document is located |

### Delete document
`POST https://apizie.tech/v1/security:notabene/documents-delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | VASP DID |
| s3URL | string | no | S3 URL where the document is located |

### Get document requests
`GET https://apizie.tech/v1/security:notabene/documents-list-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | DID of the VASP who's doc is being requested |
| requestingVASPdid | string | no | (optional) DID of the VASP who is requesting the document |

### Request, Accept, Reject or Revoke Document Access
`POST https://apizie.tech/v1/security:notabene/documents-request-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | vaspDID of document owner |
| requestingVASPdid | string | yes | vaspDID of party subject to document access |
| documentType | string | yes | type of the document |
| accessAction | string | yes | access action |
| metadata | string | no | metadata (eg. reason for decline/revoke) |

### Get DDQ document of vaspDID
`GET https://apizie.tech/v1/security:notabene/documents-get-ddq-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | DID of the VASP who's doc is being requested |
| requestingVASPdid | string | no | DID of the VASP who is requesting the document |

### Get transfer
`GET https://apizie.tech/v1/security:notabene/transactions-get-transfer-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the Transfer |

### Search transfer
`GET https://apizie.tech/v1/security:notabene/transactions-search-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| txHash | string | no | Transaction txHash |
| destination | string | no | Destination Address |
| vout | string | no | Bitcoin vout |

### List the transactions of a VASP. The transactions are grouped by beneficiary and originator.
`GET https://apizie.tech/v1/security:notabene/transactions-list-beneficiary-originator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | vaspDID to get list for |

### List transactions
`GET https://apizie.tech/v1/security:notabene/transactions-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | vaspDID to get list for |
| sort | string | no | Pass one of the supported fields you want to sort and after the colon (:), the direction, ASC or DESC. |
| page | integer | no | Page number the user wants to retrieve, default value is 0 |
| resultsPerPage | integer | no | Number of records to show per page, default value is 100 |
| txGroup | string | no | Pass INBOX here to return only the transfers available on your inbox, or remove the param to return all transfers |
| transactionAsset | string | no | Filter your transfers by crypto currencies |
| transactionType | string | no | Filter your transfers by type |
| transactionRef | string | no |  |
| status | array | no | Filter your transactions by status |
| q | string | no | Search term for transactions |
| txDirection | string | no | Filter your transfers by direction, incoming, outgoing or internal transfers |
| decrypt | boolean | no | Decrypt PII data |
| csv | boolean | no | Get data in CSV format |
| includeActions | boolean | no | Include action data with the transactions |
| jurisdictions | array | no | Filter your transactions by jurisdictions |
| vasps | array | no | Filter your transactions by vasps |
| start | string | no | Filter your transactions created after the specified date (included) |
| end | string | no | Filter your transactions created before the specified date (included) |
| wallet | string | no | Filter your transactions by wallet address |

### Fully Validate transfer
`POST https://apizie.tech/v1/security:notabene/transactions-fully-validate-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create transfer
`POST https://apizie.tech/v1/security:notabene/transactions-create-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Approve transfer
`POST https://apizie.tech/v1/security:notabene/transactions-approve-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the Transfer |

### Cancel transfer
`POST https://apizie.tech/v1/security:notabene/transactions-cancel-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update transfer
`POST https://apizie.tech/v1/security:notabene/transactions-update-transfer-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Confirm transfer
`POST https://apizie.tech/v1/security:notabene/transactions-confirm-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no | Identifier of the Transfer |

### Notify transfer
`POST https://apizie.tech/v1/security:notabene/transactions-notify-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Reject transfer
`POST https://apizie.tech/v1/security:notabene/transactions-transfer-reject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Mark a transfer as not ready
`POST https://apizie.tech/v1/security:notabene/transactions-mark-not-ready` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Accept transfer
`POST https://apizie.tech/v1/security:notabene/transactions-accept-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the Transfer |

### Decline transfer
`POST https://apizie.tech/v1/security:notabene/transactions-decline-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Redirect transfer
`POST https://apizie.tech/v1/security:notabene/transactions-redirect-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the Transfer |
| to | string | yes | Decentralized Identifier |

### Bulk edit transfers
`POST https://apizie.tech/v1/security:notabene/transactions-bulk-edit-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Receive transfer
`POST https://apizie.tech/v1/security:notabene/transactions-receive-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update pending TR data
`POST https://apizie.tech/v1/security:notabene/transactions-update-pending-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List rules
`GET https://apizie.tech/v1/security:notabene/rules-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vaspDID | string | yes | vaspDID to get list of transfer rules |

### Set rules
`POST https://apizie.tech/v1/security:notabene/rules-set-direction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Deletes rules from the provided ids
`POST https://apizie.tech/v1/security:notabene/rules-delete-by-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List all Jurisdictions
`GET https://apizie.tech/v1/security:notabene/jurisdictions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| countryCode | string | no | Country code in ISO 3166-1 alpha-2 format |
| fallbackToFATF | boolean | no | If this is set to true, it will return FATF rules if no countryCode is found |
| division | string | no | Division in ISO 3166-1 alpha-2 format |

## Example
```
curl "https://apizie.tech/v1/security:notabene/address-book-request-upload-url" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Notabene API?
Create a free Apizie key, then send GET https://apizie.tech/v1/security:notabene/address-book-request-upload-url with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Notabene API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Notabene itself also needs your own key from api.notabene.id.

### Can AI agents use the Notabene API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:notabene.

### What is the status of the Notabene API?
Needs your own provider key (bring your own key)