Jump to Content
Arianee Protocol Documentation
Home
Documentation
Recipes
API Reference
Changelog
Arianee Custodial Legacy
NFT Management Platform, POAP, Token Gating Legacy
v2.1
Arianee Protocol Documentation
Log In
API Reference
Log In
v2.1
Home
Documentation
Recipes
API Reference
Changelog
Get client account address
All
Pages
Start typing to search…
JUMP TO
🖥️ Passport Management API
Test API
Test API
get
Create Digital Passports
Create Digital Passport
post
Mint Digital Passport
post
Create Digital Passport Batch using CSV
post
Create Digital Passport Group
Create Digital Passport Group
post
Mint Digital Passport Group
post
Fetch Digital Passport
Fetch Owner Profile using Product ID
get
Fetch On-Chain Data using Product ID
get
Fetch Data using Product ID
get
Fetch Data using Token ID
get
Fetch CSV File
get
Fetch Digital Passport Group
Fetch Statistics using ProductGroup ID
get
Fetch Data using ProductGroup ID
get
Lost & Stolen
Fetch Digital Passport Missing Status
post
Fetch Digital Passport Stolen Status
post
Set/Remove Digital Passport Missing Status
post
Set/Remove Digital Passport Stolen Status
post
Manage Digital Passport
Transfer Digital Passport
post
Recover Digital Passport
post
Destroy Digital Passport
post
Keys Management
Manage Digital Passport Transferability
post
Tags
Get Tags List
get
Update Digital Passport
Update Complete JSON Schema
put
Update JSON Schema Property & Metadata
patch
Update One JSON Schema Property
put
Remove One Property in the JSON Schema
del
Update One Property in Extra-language JSON Schema
put
Remove One Property in Extra-languages JSON Schema
del
Update Digital Passport Group
Update Complete JSON Schema
put
Update JSON Schema & Metadata
patch
Update One JSON Schema Property
put
Remove One Property in the JSON Schema
del
Update One Property in Extra-language JSON Schema
put
Remove One Property in Extra-languages JSON Schema
del
🔑 Client accounts in NMP
Identity Management
Create Identity
post
Fetch Identity
get
Get client account address
get
Update Identity
post
NFT Management
Claim NFT
post
Transfer NFT
post
Event Management
Create a delegated Event
post
🎨 Digital Passports Utilities
Assets
Upload Asset
post
Fetch Asset
get
Auto-Event Campaign
Create Auto-Event Campaign
post
Fetch All Auto-Event Campaigns
get
Update Auto-Event Campaign
put
Fetch an Auto-Event Campaign
get
Delete Auto-Event Campaign
del
Auto-Message Campaigns
Create Auto-Message Campaign
post
Fetch All Auto-Message Campaigns
get
Update Auto-Message Campaign
put
Fetch an Auto-Message Campaign
get
Delete Auto-Message Campaign
del
Manage Audience Segmentation
Create Audience
post
Update Audience
patch
Fetch an Audience
get
Fetch All Audiences
get
Fetch Countries List
get
Once-Off Event Campaign
Create Once-Off Event Campaign
post
Fetch All Once-Off Event Campaigns
get
Update Once-Off Event Campaign
put
Fetch an Once-Off Event Campaign
get
Delete Once-Off Event Campaign
del
Once-Off Message Campaign
Create Once-Message Campaign Draft
post
Fetch All Once-Off Message Campaigns
get
Send Once-Off Message Campaign
post
Update Once-Off Message Campaign
put
Fetch an Once-Off Message Campaign
get
Delete Once-Off Message Campaign
del
🛰️ Client Account Wallet
Arianee Access Token
Create Digital Passport's Arianee Access Token
post
Create Wallet's Arianee Access Token
get
Check Arianee Access Token
post
Claim Digital Passports
Claim Digital Passport
post
Create Wallet
Create Wallet
post
Display Digital Passports
Fetch Owned Digital Passports
post
Fetch Digital Passport using Token ID
post
Fetch Digital Passport Information using Link
post
Fetch Identities
Fetch Identity using Issuer Address
post
Fetch Identities on Network
post
Fetch & Read Messages
Fetch Received Messages
post
Fetch Message using ID
post
Mark Message as Read
post
Fetch Wallet Information
Fetch Wallet Owner Information
get
Fetch Wallet Address
get
Manage Proof of Ownership
Generate a Proof of Ownership
post
Check Proof of Ownership
post
Transfer Digital Passport to Another Wallet
Transfer Digital Passport using Link
post
Transfer Digital Passport to Target Wallet Address
post
Transfer Permit
Generate SST
post
Check SST
post
Fetch Digital Passport Details from SST
post
Transfer Digital Passport using SST
post
🔍 NMP Searching
Digital Passports Search
Fetch Digital Passport On-Chain Data using Token ID
post
Search for Digital Passports using Data
get
Count Digital Passports using Data
get
📈 Analytics
Analytics
Report Distributed Digital Passports using Tags
post
Report Digital Passports Transfers
get
👨💻 NMP User Management
Profile Management
Create Profile
post
Fetch All Profiles
get
Update Profile
put
Fetch a Profile
get
Delete Profile
del
Users Management
Create User
post
Update User
post
Generate/Update User's API Key
put
Fetch All Users
get
Delete User
post
🪢 Pairing App
Create Template
Create Template
post
Update Template
put
Manage Templates
Fetch All Templates
get
Fetch a Template
get
Delete Template
del
Arianee Event Template
Create Arianee Event Template
post
Update Arianee Event Template
put
Fetch All Arianee Events
get
Fetch Arianee Event Template
get
Delete Arianee Event Template
del
Powered by
Get client account address
Ask AI
get
https://{url}/account/
{accountId}
/address
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
nmp_endpoint
/account/{accountId}/address
Response
Click
Try It!
to start a request and see the response here!
