API reference

Every route of the Anis Partner API, generated from the contract the gateway publishes. Each page says what the route is for, the permission it needs, how it is signed, the fields it takes and returns, and every refusal it can give.

Your application

GETRead your profile
/v1/profile
profile:read

Wallets

GETList wallets
/v1/wallets
wallets:read
GETRead a wallet
/v1/wallets/{walletId}
wallets:read

Catalogue

GETList catalogue categories
/v1/wallets/{walletId}/catalog/categories
catalogue:read
GETList subcategories of a category
/v1/wallets/{walletId}/catalog/categories/{categoryId}/subcategories
catalogue:read
GETRead a subcategory
/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}
catalogue:read
GETList cards for sale
/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}/cards
catalogue:read

Orders

POSTPlace an order
/v1/wallets/{walletId}/orders
orders:create
GETRead an order
/v1/orders/{operationId}
orders:read

Owned cards

GETList owned cards
/v1/wallets/{walletId}/cards
cards:read
GETRead an owned card
/v1/wallets/{walletId}/cards/{soldCardId}
cards:read
POSTReveal a card
/v1/wallets/{walletId}/cards/{soldCardId}/reveal
cards:reveal
POSTReveal an invoice
/v1/wallets/{walletId}/invoices/{invoiceId}/cards/reveal
cards:reveal

Diagnostics

POSTCheck your signature
/v1/diagnostics/signature
diagnostics:use

Enrolment

GETRead an invitation
/v1/enrollments/{invitationId}
None
POSTSubmit a public key
/v1/enrollments/{invitationId}/keys
None
POSTProve you hold the key
/v1/enrollments/{invitationId}/proof
None
GETRead enrolment status
/v1/enrollments/{invitationId}/status
None

Anis signing keys

GETAnis’s public signing keys
/.well-known/partner-signing-keys.json
None