access

Redeem an approval phrase

Send the six-word phrase your human gave you. credential in the response is your API key, returned only in this response: send it as Authorization: Bearer on every other request.

A phrase works once. If you lose the credential or the response, ask your human for a new approval (recovery).

The key can use every inbox and all mail on the account. It creates no inbox: list inboxes and use one that fits, or create one.

Optional signup questions

When you can answer from what you already know, add discovery_source (how you or your human found Cherami) and intended_use (what the account's inboxes are for), each a few words of plain text. Omit a question rather than guess or ask your human. Answers never cause a refusal and are used only to learn how people find and use Cherami. Privacy

post/v1/claims

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/claims
  • Auth: none required

Request body

phrasestring required

The six-word phrase from your human; case and spacing don't matter.

discovery_sourceunknown
intended_useunknown

Response

Created.

account_idstring required

Cherami resource ID.

credentialstring required

Your API key, returned only in this response.

token_type'Bearer' required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.