curl -X POST 'https://api.anthropic.com/v1/user_profiles?beta=true' \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H 'anthropic-version: 2023-06-01' \
  -H 'Content-Type: application/json' \
  -d '{}'

# POST /v1/user_profiles?beta=true (Claude API)
Base URL: https://api.anthropic.com
Auth: x-api-key; Anthropic API key; required.
Status: Beta.
Request formats: application/json.
Last verified: 2026-10-20

> Create User Profile

## Critical Gotchas
* Authentication uses the `x-api-key` header and requests also require an `anthropic-version` header.
* The official OpenAPI URL is discovered from the SDK repository manifest and must remain under Anthropic's trusted Stainless storage prefix.

## cURL
curl -X POST 'https://api.anthropic.com/v1/user_profiles?beta=true' \
  -H "x-api-key: $ANTHROPIC_API_KEY" \
  -H 'anthropic-version: 2023-06-01' \
  -H 'Content-Type: application/json' \
  -d '{}'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| external_id | body | string | No | Platform's own identifier for this user. Not enforced unique. Maximum 255 cha... |
| name | body | string | No | Optional for all profiles. Real-world name of the entity this profile represe... |
| access_type | body | string | No | How the platform uses the API for this entity. `application` (default): the p... |
| external_user_onboarded_at | body | string | No | When the entity this profile represents opened its account with the platform,... |
| metadata | body | object | No | Free-form key-value data to attach to this user profile. Maximum 16 keys, wit... |

## Response example
{"id":"uprof_011CZkZCu8hGbp5mYRQgUmz9","type":"user_profile"}

---
Need an API key? Get one at https://console.anthropic.com/settings/keys

POST

POST /v1/user_profiles?beta=true — Claude API

Beta

Anthropic API key (required); https://api.anthropic.com

Claude API

Create User Profile

Base URL: https://api.anthropic.com
Auth: x-api-key: <ANTHROPIC_API_KEY>
Last verified: 2026-10-20 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 303 tokens · Vary: Accept

Critical gotchas

Authentication uses the x-api-key header and requests also require an anthropic-version header.

The official OpenAPI URL is discovered from the SDK repository manifest and must remain under Anthropic's trusted Stainless storage prefix.

cURL

curl -X POST 'https://api.anthropic.com/v1/user_profiles?beta=true' \  -H "x-api-key: $ANTHROPIC_API_KEY" \  -H 'anthropic-version: 2023-06-01' \  -H 'Content-Type: application/json' \  -d '{}'

Parameters

Name	In	Type	Required	Description
external_id	body	string	No	Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
name	body	string	No	Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters.
access_type	body	string	No	How the platform uses the API for this entity. `application` (default): the profile represents an individual end-user of the platform's product. `passthrough`: the profile identifies a company the platform resells Claude access to.
external_user_onboarded_at	body	string	No	When the entity this profile represents opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. Optional.
metadata	body	object	No	Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.

Response 200 OK

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "type": "user_profile",
  "external_id": "user_12345",
  "name": "Example User",
  "access_type": "application",
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "external_user_onboarded_at": "2024-11-02T08:15:00Z",
  "metadata": {},
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z"
}

Get a free Claude API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.