Sign-up

Has the owner answered that verification email yet?

One word — pending, verified, issued, cancelled — about one sign-up, so a page that has just sent somebody an email can finish the job itself instead of asking them to press a button again when they get back.

It has no side effects. It mints nothing, mails nothing, verifies nothing and consumes nothing, and it is not a step in getting a key: the key still comes from create_account, after the owner confirms the request on the page the email links to, once. This only says when that call is worth making.

It never returns an address. The token is a public id, and a public id is handed out by existing_account, so an address here would undo that answer's redaction.

No key. The token is the account.id that create_account returned with pending_verification, which the caller that started the sign-up holds and nobody else does.

Poll every poll_after_seconds. This has its own budget — thirty checks a minute per token — so polling here never spends the three-per-hour create_account budget, which is the whole reason it exists.

get/v1/signup/status

Request

  • Base URL: https://api.galleyrender.com
  • URL: https://api.galleyrender.com/v1/signup/status
  • Auth: none required

Query parameters

tokenstring required
Example:acct_7hq2m4x8k1bv

The account.id from the create_account call that started this sign-up.

Response

Where this sign-up has got to.

object'signup_status' required
status'pending' | 'verified' | 'issued' | 'cancelled' required

pending — the email is out and the owner hasn't answered it. verified — the owner confirmed this request; the next create_account from the client that made it hands over the key, and no other client's does. issued — the key is out, collected by that call or shown to the owner on the verify page; keys are shown once. cancelled — the owner said the request wasn't theirs, or verified the address from another request; stop polling.

poll_after_secondsinteger required
next_stepstring required

Example response

{
  "poll_after_seconds": 5
}

Changes

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