Sign Up

Mint CLI Signup Token

Mints a one-shot cli_token and returns a prefilled signup URL. The user opens the URL, clears the captcha, accepts the Terms of Service and creates the account. The CLI then polls GET /sign_up/{cli_token} until the accounts service has propagated the new user and its first API key, at which point the API returns the credentials exactly once.

The API does not store the cli_token when it mints it. The token becomes known to the API only once the accounts service propagates the new user, so the CLI must set its own polling deadline. If the user never completes signup, GET /sign_up/{cli_token} returns 202 Accepted indefinitely.

post/sign_up

Request

  • Base URL: https://api.addresszen.com/v1
  • URL: https://api.addresszen.com/v1/sign_up
  • Auth: none declared

Request body

emailstring email required

Account holder's email address.

namestring required

Account holder's full name.

org_namestring required

Organization name.

org_address_line_onestring required
org_address_line_twostring
org_address_line_threestring
org_post_townstring required
org_postcodestring required
org_country_codestring required

ISO 3166-1 alpha-2 country code.

Response

Token minted

codeinteger required
messagestring required

Example response

{
  "code": 2000,
  "message": "Success"
}

Changes

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