Exchange a verification code for an account key

Consumes the code POST /v1/signups sent, creates the account when the address has none, and mints an arc_sk_ key on it: the read scope, the free plan's 1,000 credits a month, no expiry. A wrong, expired, or spent code is 400 signup_code_invalid on param code, naming the attempts left; its unlock action is a new send. Send { "email": "agent@example.com", "code": "482913" }.

post/v1/signups/verify

Request

Base URL: https://api.arcmira.com
URL: https://api.arcmira.com/v1/signups/verify
Auth: none required

Request body

emailstring required

The address the code was sent to.

codestring required

The six digit code from the email. Ten minutes, five attempts, then a new send is required.

Response

Account key minted

keystring required

The arc_sk_ account key. Shown once. Send it as Authorization: Bearer.

key_idstring required

The key id. Appears on funnel events and in the dashboard; never a secret.

headerstring required

The pasteable request header line: Authorization: Bearer arc_sk_...

scopesstring[] required

Always ["read"]. Create an Admin key in the dashboard for account write access.

tierstring required

The plan the account is on: free for a new account, its plan when the address already had one.

rows_allottedinteger required

Plan credits a month, in rows (a row is 4 credits), on a paid plan. On the free plan, the account's allotment from before credits (1,000 for a new account). The free plan has 1,000 credits a month; read the balance from usage.credits on GET /v1/me.

nextstring required

A curl command for the first call: GET /v1/me with the key.

docs_urlstring required

Sign-up documentation.

Changes

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