VOvoygr
core

Sign up for a free API key

Changed on

You do not need a key to call this. delivery decides how the person gets theirs.

  • email_key (the default) emails the key. The response never contains it. If the address already has an account, we send no new key: recover it at /recover.
  • code is for an agent signing someone up. We email them a 6-digit code and return a verification_id. Ask them for the code, then send both to POST /signup/verify within 10 minutes. We create nothing before then. We send at most 3 codes per address per 24 hours. Past that the response looks the same, but no email goes out.

In both modes, a 200 looks the same for every address. It does not tell you whether the address has an account. terms_presented only applies to email_key. With code, entering the code accepts the API Terms.

post/signup

Request

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

Request body

namestring required

The person's name.

emailstring email required

Their email address. We refuse disposable domains and domains that cannot receive mail.

srcstring nullable

Optional. Where the signup came from, for attribution.

terms_presentedboolean

email_key only. Set true only if, before submitting, you showed the person the API Terms and Privacy Policy and told them that continuing accepts them. Ignored for code, where entering the code accepts the API Terms.

delivery'email_key' | 'code'

email_key emails the key. code emails a 6-digit code to swap for the key at POST /signup/verify.

Example request

{
  "name": "Ada",
  "email": "ada@example.com",
  "delivery": "code"
}

Response

SignupKeyEmailed for email_key, SignupCodeSent for code.

OR

Example response

{
  "success": true,
  "message": "If this is a new email, an API key has been sent. If an account already exists, click “Recover your key” below to receive a new API key."
}

Changes