---
title: "Create a new user"
method: POST
path: "/v1/user/"
tags: ["/v1/user"]
---

# Create a new user

`POST /v1/user/`

## Request

- Base URL: `https://api.counselhealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.counselhealth.com/v1/user/`
- Auth: HTTP bearer

Once a user completes your onboarding process, create a user within Counsel. We recommend passing an Idempotency-Key header to ensure that the user is created only once. Response replays are available for one day after the request completes.

  Idempotency keys are best-effort and may be lost before the one-day window elapses. If a key is no longer available, a retry is executed as a new request rather than replayed, so do not rely on replays as a durable record of the original response.
  The API accepts a predefined ID as UUID for the user. If you do not pass an ID, the API will generate one for you.

  Phone number must be unique per user. The API will throw if you try to create two users with the same number. On Sandbox, you can use +1 800 700 6000 as a test number which is permissioned to create multiple users.

  Set the access_expires_at field to expire the user's access to the platform at a future date.

## Headers

- `Idempotency-Key` string

## Request body

- object: Create a new user. If `id` is omitted, one will be generated.
  - `dob` string, required: date of birth in YYYY-MM-DD format (ISO 8601). Must be between 18 and 120 years old
  - `phone` string, nullable: US phone number. Supported formats: 8007006000, 800-700-6000, +1 800-700-6000, +18007006000, +1(800)7006000, (800)700-6000
  - `addresses` object[], nullable
    - `line1` string, required
    - `line2` string
    - `city` string, required
    - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'DC', required: US state abbreviation
    - `zip` string, required: US zip code with optional 4 digit extension. Supported formats: 12345, 12345-1234
    - `metadata` object
      - `is_primary` boolean
  - `sex_assigned_at_birth` 'Male' | 'Female', required
  - `gender` 'Male' | 'Female' | 'Other', nullable
  - `body_measurements` object, nullable
    - `height_ft` integer, required
    - `height_in` integer, required
    - `weight_lbs` integer, required
  - `race` string[], nullable
  - `medical_profile` object, required
    - `conditions` string[], required
    - `medications` string[], required
    - `medication_allergies` string[]
    - `surgeries` string[]
    - `family_history` string[]
    - `doctors` object
      - `pcp_name` string
      - `pcp_last_seen` 'Within the last year' | '1-2 years ago' | '2-5 years ago' | 'Longer than that or I do not remember'
      - `specialist_types` string[]
    - `substances` object
      - `tobacco` string[]
      - `alcohol` '0-4' | '5-8' | '9-14' | '15+'
    - `additional_details` object: Pass additional medical profile details
  - `email` string, email, nullable: email address
  - `metadata` object, nullable: Custom key-value metadata for external users. Max 25 keys, each value ≤ 1800 characters. Keys must be alphanumeric with underscores/hyphens only.
  - `external_id` string, nullable: Client-supplied stable identifier for this user, unique within your organization. Can be used in place of the Counsel user ID on GET/PATCH /v1/user/{id}.
  - `id_verified` boolean, nullable: Whether this user's identity has been verified. Sending `true` requires your organization to be granted API identity verification by Counsel support; otherwise the request fails with 403.
  - `access_expires_at` string, date-time, nullable: datetime in ISO 8601 format
  - `first_name` string, required: Legal given name(s)
  - `last_name` string, required: Legal family name
  - `preferred_name` string, nullable: Preferred name
  - `id` string, uuid

## Response `200`

A fully onboarded API user with clinical profile and contact info.

- object: A fully onboarded API user with clinical profile and contact info.
  - `id` string, uuid, required
  - `created_at` string, date-time, required: datetime in ISO 8601 format
  - `first_name` string, required
  - `last_name` string, required
  - `preferred_name` string, nullable
  - `dob` string, required: date of birth in YYYY-MM-DD format (ISO 8601)
  - `phone` string, nullable: US phone number. Supported formats: 8007006000, 800-700-6000, +1 800-700-6000, +18007006000, +1(800)7006000, (800)700-6000
  - `addresses` object[], nullable
    - `line1` string, required
    - `line2` string
    - `city` string, required
    - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'DC', required: US state abbreviation
    - `zip` string, required: US zip code with optional 4 digit extension. Supported formats: 12345, 12345-1234
    - `metadata` object
      - `is_primary` boolean
  - `sex_assigned_at_birth` 'Male' | 'Female', required
  - `gender` 'Male' | 'Female' | 'Other', nullable
  - `body_measurements` object, nullable
    - `height_ft` integer, required
    - `height_in` integer, required
    - `weight_lbs` integer, required
  - `race` string[], nullable
  - `medical_profile` object, required
    - `conditions` string[], required
    - `medications` string[], required
    - `medication_allergies` string[]
    - `surgeries` string[]
    - `family_history` string[]
    - `doctors` object
      - `pcp_name` string
      - `pcp_last_seen` 'Within the last year' | '1-2 years ago' | '2-5 years ago' | 'Longer than that or I do not remember'
      - `specialist_types` string[]
    - `substances` object
      - `tobacco` string[]
      - `alcohol` '0-4' | '5-8' | '9-14' | '15+'
    - `additional_details` object: Pass additional medical profile details
  - `access_expires_at` string, date-time, nullable: datetime in ISO 8601 format
  - `email` string, email, nullable: email address
  - `metadata` object, nullable: Custom key-value metadata for external users. Max 25 keys, each value ≤ 1800 characters. Keys must be alphanumeric with underscores/hyphens only.
  - `onboarded_at` string, date-time, nullable: datetime in ISO 8601 format
  - `external_id` string, nullable: Client-supplied stable identifier for this user, unique within your organization. Can be used in place of the Counsel user ID on GET/PATCH /v1/user/{id}.
  - `id_verified` boolean, nullable: Whether this user's identity has been verified. Sending `true` requires your organization to be granted API identity verification by Counsel support; otherwise the request fails with 403.
  - `consents` object, required: Consent state for this user. Fields are only populated for consents the organization tracks.
    - `hipaa_authorization` boolean: Whether this user has granted HIPAA authorization consent — i.e. waived their right to HIPAA privacy protections so that PHI can be shared back to your organization. Only present when the organization requires HIPAA authorization consent. When false on such an org, API responses redact HIPAA-gated fields and PHI-rich endpoints return 403.

## Other responses

- `400`: 400 error with a machine-readable `code` for client branching.
- `401`: Standard error body returned for non-2xx responses.
- `403`: Standard error body returned for non-2xx responses.
- `404`: Standard error body returned for non-2xx responses.
- `409`: Standard error body returned for non-2xx responses.
- `413`: Standard error body returned for non-2xx responses.
- `429`: Standard error body returned for non-2xx responses.
- `500`: Standard error body returned for non-2xx responses.
- `502`: Default Response
- `503`: Default Response
- `504`: Default Response

---

[API](https://skmtc.dev/counselhealth/apis/counsel-api.md) - [All operations](https://skmtc.dev/counselhealth/apis/counsel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/counselhealth/apis/counsel-api/revisions/4110a89127e8?raw)