Create User Profile

post /v1/user_profiles

Create User Profile

Header Parameters

• "anthropic-beta": optional array of AnthropicBeta

  Optional header to specify the beta version(s) you want to use.

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

Body Parameters

• external_id: optional string

  Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.

• metadata: optional map[string]

  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.

• name: optional string

  Display name of the entity this profile represents. Required when relationship is resold (the resold-to company's name); optional otherwise. Maximum 255 characters.

• relationship: optional "external" or "resold" or "internal"

  How the entity behind a user profile relates to the platform that owns the API key. external: an individual end-user of the platform. resold: a company the platform resells Claude access to. internal: the platform's own usage.

  • "external"

  • "resold"

  • "internal"

Returns

• BetaUserProfile object { id, created_at, metadata, 6 more }

  • id: string

    Unique identifier for this user profile, prefixed uprof_.

  • created_at: string

    A timestamp in RFC 3339 format

  • metadata: map[string]

    Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

  • relationship: "external" or "resold" or "internal"

    How the entity behind a user profile relates to the platform that owns the API key. external: an individual end-user of the platform. resold: a company the platform resells Claude access to. internal: the platform's own usage.

    • "external"

    • "resold"

    • "internal"

  • trust_grants: map[BetaUserProfileTrustGrant]

    Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.

    • status: "active" or "pending" or "rejected"

      Status of the trust grant.

      • "active"

      • "pending"

      • "rejected"

  • type: "user_profile"

    Object type. Always user_profile.

    • "user_profile"

  • updated_at: string

    A timestamp in RFC 3339 format

  • external_id: optional string

    Platform's own identifier for this user. Not enforced unique.

  • name: optional string

    Display name of the entity this profile represents. For resold this is the resold-to company's name.

Example

curl https://api.anthropic.com/v1/user_profiles \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: user-profiles-2026-03-24' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "external_id": "user_12345",
          "metadata": {}
        }'

Response

{
  "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
  "created_at": "2026-03-15T10:00:00Z",
  "metadata": {},
  "relationship": "external",
  "trust_grants": {
    "cyber": {
      "status": "active"
    }
  },
  "type": "user_profile",
  "updated_at": "2026-03-15T10:00:00Z",
  "external_id": "user_12345",
  "name": "Example User"
}