VOvoygr
core

Swap a signup code for an API key

Changed on

Step 2 of POST /signup with delivery: "code", also without a key. Send the verification_id and the 6 digits the person got by email.

A code works for 10 minutes or 5 attempts, and only once. Entering it accepts the API Terms.

The key is in this response once and is not emailed, so store it straight away. A new address gets a new account. An address that already has one gets its key replaced: the old key stops working, and we try to email the address a notice with no key in it.

After a 503 the same code still works until it expires. Try again in a minute.

post/signup/verify

Request

  • Base URL
    https://api.voygr.tech
  • URL
    https://api.voygr.tech/signup/verify
  • Auth
    none required

Request body

verification_idstring required

From the POST /signup response.

codestring required

The 6 digits from the email. We ignore spaces and dashes.

Example request

{
  "verification_id": "Jq3x0bF5yW2mN7tL1cR9eH",
  "code": "123456"
}

Response

The key, sent with Cache-Control: no-store.

successboolean required
api_keystring required

Send it as X-API-Key. Store it now: it is not shown again.

createdboolean required

true: a new account was created.

replaced_previous_keyboolean required

true: the address already had an account, and its previous key no longer works.

opening_balanceinteger

Credits the new account starts with. Present only when created is true.

messagestring required

Example response

{
  "success": true,
  "api_key": "pk_live_...",
  "created": true,
  "replaced_previous_key": false,
  "opening_balance": 2500,
  "message": "Save this key now: it is shown once and is not emailed."
}

Changes