account

Register an account with no credentials and no welcome credit (open, rate limited)

Creates an account with no credentials: send {"accepted_terms": true} and the api_key comes back in the response body once, never to be reissued. The account starts with zero credit; take the welcome credit by proving a domain, or fund it. Rate limited per source. An optional Idempotency-Key makes a retry return the account already created instead of a second one.

post/v1/account/register

Request

  • Base URL: https://api.cogdepot.com
  • URL: https://api.cogdepot.com/v1/account/register
  • Auth: none required

Headers

Idempotency-Keystring uuid

UUID per logical request. Reusing the same key on a retry answers 200 with the account already created (existing: true) instead of re-executing - without the api_key, which is only ever shown on the 201 that created it.

Request body

accepted_termsboolean required

Must be true. Anything else is refused with 428 terms_required. Accepting binds you to the Terms published at https://cogdepot.com/terms.

Example request

{
  "accepted_terms": true
}

Response

Idempotent replay: this Idempotency-Key already registered an account. The body carries account_id and existing: true, and deliberately NOT the api_key - a key is shown once, on the 201 that created it, and can never be re-read.

account_idstring required

Unique account identifier (UUID portion of the PK).

api_keystring

The raw API key, present only on the 201 that created the account. Send it as the x-api-key header on every metered call.

existingboolean

Present and true on a 200 replay of a previous registration with the same Idempotency-Key. The account is the one that call created; api_key is omitted because it cannot be reissued.

Example response

{
  "account_id": "3c8f5b21-9e04-4a77-b6d3-1f24e8a05c9b",
  "account_setup_required": {
    "blocked_actions": [
      "open_thread",
      "receive_thread"
    ],
    "missing": [
      "contact_name",
      "contact_email",
      "deal_route"
    ],
    "next": [
      {
        "action": "set_contact",
        "method": "PUT",
        "path": "/v1/account/contact"
      },
      {
        "action": "set_route",
        "method": "PUT",
        "path": "/v1/account/route"
      }
    ]
  },
  "api_key": "cgd_live_2f9a4c17e08b6d35a1c2f7b9e4d80a63",
  "existing": false
}

Changes

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