API reference — anon

The API is a REST control plane served at /v1. Requests are authenticated with a Cognito ID token except where noted — see Authentication and the Tenancy model.

Get the account profile

Update the account profile

Delete the account

Set the default recipient

Count unused recovery codes

Generate recovery codes

Reset a password with a recovery code

Attach one recipient to an alias

Replace the recipients of an alias

Detach a recipient from an alias

List aliases

Create an alias

Get an alias

Update an alias

Delete an alias

Start a card checkout

Open the card billing portal

Start a crypto checkout

List recipients

Create a recipient

Get a recipient

Update a recipient

Delete a recipient

Resend a recipient verification email

Verify a recipient from a magic link

Get the subscription

Get monthly usage meters

Health check

List alias domains and the default alias format