API reference
Public reads, integration resources and requests available to card owners.
Browser access labels describe cross-origin fetch. Widgets use frames, and links open normally. Calls that require signatures or private codes keep their access requirements. Staff-only administration APIs are outside this integration reference.
Find people and cards#
- Look up a card
GET /v1/lookupBrowser fetch supported - Read a person’s card
GET /u/{card}.jsonBrowser fetch supported - Read an organisation’s card
GET /o/{card}.jsonBrowser fetch supported - Read a small card summary
GET /v1/identities/{n}/summaryBrowser fetch supported - Read a card’s account alerts
GET /v1/identities/{n}/alertsBrowser fetch supported - Read a card’s statements
GET /{kind}/{card}/statements.jsonBrowser fetch supported - Read one statement
GET /v1/statements/{id}Browser fetch supported - Resolve or check an alias
GET /v1/aliases/{kind}/{alias}Browser fetch supported - List account platforms
GET /v1/platformsBrowser fetch supported
Keys and signatures#
- Find the owner of a key
GET /v1/keys/{key}Browser fetch supported - Check when a key could sign
GET /v1/keys/{key}/active-atBrowser fetch supported - Verify a message
POST /v1/verifyBrowser fetch supported - Verify a file or a release
POST /v1/verifyBrowser fetch supported - Read the account-proof key
GET /v1/grant-keyBrowser fetch supported - Get a card’s public keys from elsewhere as a file
GET /u/{card}/keys.txtBrowser fetch supported
Versions and changes#
- Read signed versions
GET /v1/identities/{n}/versionsBrowser fetch supported - Read card history
GET /v1/identities/{n}/historyBrowser fetch supported - Read a version’s proof
GET /v1/identities/{n}/versions/{k}/proofBrowser fetch supported - Read account events
GET /v1/identities/{n}/eventsBrowser fetch supported - Read account transfers
GET /v1/takeoversBrowser fetch supported - Read authority versions
GET /v1/identities/{n}/authorityBrowser fetch supported - Read the chain of statements
GET /v1/identities/{n}/statementsBrowser fetch supported - Read version labels
GET /v1/identities/{n}/labelsBrowser fetch supported - Read one version
GET /v1/identities/{n}/versions/{v}Browser fetch supported - Read the path of a state item
GET /v1/identities/{n}/sets/{set}/pathBrowser fetch supported
Organisations and public status#
- Read memberships and invitations
GET /v1/identities/{n}/orgsBrowser fetch supported - Read Veil’s public role matrix
GET /v1/staffBrowser fetch supported - Read a card’s moderation state
GET /v1/identities/{n}/moderationBrowser fetch supported - Read public moderation entries
GET /v1/moderation/entriesBrowser fetch supported - Read available badge types
GET /v1/badges/catalogueBrowser fetch supported - Read a card’s badges
GET /v1/identities/{n}/badgesBrowser fetch supported - Read organisation members by page
GET /v1/organizations/{n}/membersBrowser fetch supported - Read the warrant canary
GET /v1/canaryBrowser fetch supported - Open the warrant canary
GET /canaryOpen as a page
Transparency log#
- Read the directory’s log state
GET /v1/logBrowser fetch supported - Read a log’s public details
GET /{log}/Open as a page - Read a signed checkpoint
GET /{log}/checkpointBrowser fetch supported - Read a witness policy
GET /{log}/policyBrowser fetch supported - Read witness cosignatures
GET /{log}/witnessesBrowser fetch supported - Read Merkle hash tiles
GET /{log}/tile/{level}/{index}Browser fetch supported - Read entry bundles
GET /{log}/tile/entries/{index}Browser fetch supported
Developer API keys#
- Read an API owner account
GET /v1/developer/accounts/{n}Local or server client - List integration keys
GET /v1/developer/accounts/{n}/keysLocal or server client - Create an integration key
POST /v1/developer/accounts/{n}/keysLocal or server client - Revoke an integration key
DELETE /v1/developer/accounts/{n}/keys/{id}Local or server client - Read private API-key activity
GET /v1/developer/accounts/{n}/auditLocal or server client - Check an API key’s allowance
GET /v1/rate-limitLocal or server client
Manage a card#
- Create a person’s card
POST /v1/identitiesLocal or server client - Publish a person’s next version
POST /v1/identities/{n}/versionsLocal or server client - Create an organisation
POST /v1/organizationsLocal or server client - Publish an organisation’s next version
POST /v1/organizations/{n}/versionsLocal or server client - Request a first-version salt ticket
POST /v1/salt-ticketsLocal or server client - Start an account proof
POST /v1/links/startLocal or server client - Complete an account proof
POST /v1/links/{state}/completeLocal or server client - Read a private proof state
GET /v1/links/{state}Local or server client - Return from an OAuth provider
GET /v1/links/callback/{platform}Local or server client - Request device pairing
POST /v1/device-requestsLocal or server client - Read a pairing request
GET /v1/device-requests/{code}Local or server client - Accept an organisation invitation
POST /v1/orgs/{n}/invites/{id}/acceptLocal or server client - Decline an organisation invitation
POST /v1/orgs/{n}/invites/{id}/declineLocal or server client - Cancel an incoming account transfer
POST /v1/takeovers/{id}/cancelLocal or server client - Read a card’s email notices
GET /v1/identities/{n}/noticesLocal or server client - Turn a card’s email notices on or off
PUT /v1/identities/{n}/noticesLocal or server client - Stop the email notices from an email’s link
POST /v1/notices/unsubscribeLocal or server client - Open an email’s stop link
GET /notices/stopLocal or server client - Check an image before publishing
POST /v1/logo-previewsLocal or server client - Read a private image preview
GET /v1/logo-previews/{hash}.{format}Local or server client - Request card erasure
POST /v1/identities/{n}/eraseLocal or server client - Cancel pending card erasure
POST /v1/identities/{n}/erase/cancelLocal or server client - Declare an account stolen, abandoned or moved
POST /v1/identities/{n}/alertsLocal or server client - Publish a signed statement
POST /v1/identities/{n}/statementsLocal or server client - Report a card
POST /v1/identities/{n}/reportsLocal or server client