---
title: "Mint CLI Signup Token"
method: POST
path: "/sign_up"
tags: ["Sign Up"]
---

# Mint CLI Signup Token

`POST /sign_up`

## Request

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

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.

## Request body

- object
  - `email` string, email, required: Account holder's email address.
  - `name` string, required: Account holder's full name.
  - `org_name` string, required: Organization name.
  - `org_address_line_one` string, required
  - `org_address_line_two` string
  - `org_address_line_three` string
  - `org_post_town` string, required
  - `org_postcode` string, required
  - `org_country_code` string, required: ISO 3166-1 alpha-2 country code.

## Response `200`

Token minted

- object
  - `code` integer, required
  - `message` string, required
  - `result` object, required
    - `cli_token` string, required: Random URL-safe token (base64url). Used by the CLI to poll for credentials.
    - `signup_url` string, uri, required: Prefilled accounts web URL. The user opens this in a browser to complete signup.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/addresszen/apis/api-reference.md) · [All operations](https://skmtc.dev/addresszen/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/addresszen/apis/api-reference/revisions/cac119db15c0?raw)