--- title: User Profiles url: https://platform.claude.com/docs/en/api/java/beta/user_profiles --- # User Profiles ## Create User Profile `BetaUserProfile beta().userProfiles().create(params = UserProfileCreateParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/user_profiles` Create User Profile ### Parameters - `UserProfileCreateParams params` - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `Optional accessType` 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. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead. minLength: 1, maxLength: 255 - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them. Every field is optional. Accepted under the `user-profiles-2026-09-04` beta header only. - `Optional externalUserOnboardedAt` 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. Accepted under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` send `external_user_details.onboarded_at` instead. format: date-time - `Optional metadata` 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. - `Optional name` 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. minLength: 1, maxLength: 255 ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `Type type` Object type. Always `user_profile`. - `String id` Unique identifier for this user profile, prefixed `uprof_`. - `LocalDateTime createdAt` When this user profile was created, in RFC 3339 format. format: date-time - `Metadata metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `TrustGrants trustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status status` Status of the trust grant. - `ACTIVE("active")` - `PENDING("pending")` - `REJECTED("rejected")` - `LocalDateTime updatedAt` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `Optional accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `Optional emailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `Optional onboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `Optional referenceId` The platform's own reference for the entity. `null` until the platform supplies one. - `Optional externalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `Optional name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.userprofiles.BetaUserProfile; import com.anthropic.models.beta.userprofiles.UserProfileCreateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaUserProfile betaUserProfile = client.beta().userProfiles().create(); } } ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ``` ## List User Profiles `UserProfileListPage beta().userProfiles().list(params = UserProfileListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/user_profiles` List User Profiles ### Parameters - `UserProfileListParams params` - `Optional limit` (query parameter) The maximum number of user profiles to return, from 1 to 100. Defaults to 20. format: int32 - `Optional order` (query parameter) The sort direction, applied to the field that `order_by` selects. Defaults to `desc`. - `ASC("asc")` Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`. - `DESC("desc")` Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default. - `Optional orderBy` (query parameter) The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`. - `CREATED_AT("created_at")` Sort by when each user profile was created. This is the default. - `NAME("name")` Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction. - `Optional page` (query parameter) The cursor for the page to return, taken from `next_page` in a previous response. Leave it out to get the first page. - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `Type type` Object type. Always `user_profile`. - `String id` Unique identifier for this user profile, prefixed `uprof_`. - `LocalDateTime createdAt` When this user profile was created, in RFC 3339 format. format: date-time - `Metadata metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `TrustGrants trustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status status` Status of the trust grant. - `ACTIVE("active")` - `PENDING("pending")` - `REJECTED("rejected")` - `LocalDateTime updatedAt` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `Optional accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `Optional emailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `Optional onboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `Optional referenceId` The platform's own reference for the entity. `null` until the platform supplies one. - `Optional externalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `Optional name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.userprofiles.UserProfileListPage; import com.anthropic.models.beta.userprofiles.UserProfileListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); UserProfileListPage page = client.beta().userProfiles().list(); } } ``` #### Response (200) ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get User Profile `BetaUserProfile beta().userProfiles().retrieve(params = UserProfileRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/user_profiles/{user_profile_id}` Get User Profile ### Parameters - `UserProfileRetrieveParams params` - `Optional userProfileId` (path parameter) The ID of the user profile to get (`uprof_...`). - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `Type type` Object type. Always `user_profile`. - `String id` Unique identifier for this user profile, prefixed `uprof_`. - `LocalDateTime createdAt` When this user profile was created, in RFC 3339 format. format: date-time - `Metadata metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `TrustGrants trustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status status` Status of the trust grant. - `ACTIVE("active")` - `PENDING("pending")` - `REJECTED("rejected")` - `LocalDateTime updatedAt` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `Optional accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `Optional emailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `Optional onboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `Optional referenceId` The platform's own reference for the entity. `null` until the platform supplies one. - `Optional externalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `Optional name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.userprofiles.BetaUserProfile; import com.anthropic.models.beta.userprofiles.UserProfileRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaUserProfile betaUserProfile = client.beta().userProfiles().retrieve("uprof_011CZkZCu8hGbp5mYRQgUmz9"); } } ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ``` ## Update User Profile `BetaUserProfile beta().userProfiles().update(params = UserProfileUpdateParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/user_profiles/{user_profile_id}` Update User Profile ### Parameters - `UserProfileUpdateParams params` - `Optional userProfileId` (path parameter) The ID of the user profile to update (`uprof_...`). - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `Optional accessType` If present, replaces the stored access type. Omit to leave unchanged. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead. minLength: 1, maxLength: 255 - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Accepted under the `user-profiles-2026-09-04` beta header only. - `Optional externalUserOnboardedAt` If present, replaces the stored account creation time. Omit to leave unchanged; once set, the value cannot be cleared and `null` is rejected. Must be a complete RFC 3339 timestamp no more than 1 minute in the future. Accepted under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` send `external_user_details.onboarded_at` instead. format: date-time - `Optional metadata` Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. - `Optional name` If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. minLength: 1, maxLength: 255 ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `Type type` Object type. Always `user_profile`. - `String id` Unique identifier for this user profile, prefixed `uprof_`. - `LocalDateTime createdAt` When this user profile was created, in RFC 3339 format. format: date-time - `Metadata metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `TrustGrants trustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status status` Status of the trust grant. - `ACTIVE("active")` - `PENDING("pending")` - `REJECTED("rejected")` - `LocalDateTime updatedAt` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `Optional accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `Optional emailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `Optional onboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `Optional referenceId` The platform's own reference for the entity. `null` until the platform supplies one. - `Optional externalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `Optional name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.userprofiles.BetaUserProfile; import com.anthropic.models.beta.userprofiles.UserProfileUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaUserProfile betaUserProfile = client.beta().userProfiles().update("uprof_011CZkZCu8hGbp5mYRQgUmz9"); } } ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ``` ## Create Enrollment URL `BetaUserProfileEnrollmentUrl beta().userProfiles().createEnrollmentUrl(params = UserProfileCreateEnrollmentUrlParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/user_profiles/{user_profile_id}/enrollment_url` Create Enrollment URL ### Parameters - `UserProfileCreateEnrollmentUrlParams params` - `Optional userProfileId` (path parameter) The ID of the user profile to create an enrollment URL for (`uprof_...`). - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfileEnrollmentUrl` A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant. - `Type type` Object type. Always `enrollment_url`. - `LocalDateTime expiresAt` When this enrollment URL expires, in RFC 3339 format. format: date-time - `String url` Enrollment URL to send to the end user. Valid until `expires_at`. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.userprofiles.BetaUserProfileEnrollmentUrl; import com.anthropic.models.beta.userprofiles.UserProfileCreateEnrollmentUrlParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaUserProfileEnrollmentUrl betaUserProfileEnrollmentUrl = client.beta().userProfiles().createEnrollmentUrl("uprof_011CZkZCu8hGbp5mYRQgUmz9"); } } ``` #### Response (200) ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "enrollment_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ``` ## Domain types ### Beta User Profile - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `Type type` Object type. Always `user_profile`. - `String id` Unique identifier for this user profile, prefixed `uprof_`. - `LocalDateTime createdAt` When this user profile was created, in RFC 3339 format. format: date-time - `Metadata metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `TrustGrants trustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `Status status` Status of the trust grant. - `ACTIVE("active")` - `PENDING("pending")` - `REJECTED("rejected")` - `LocalDateTime updatedAt` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `Optional accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `APPLICATION("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `PASSTHROUGH("passthrough")` The user profile represents a company that the platform resells Claude access to. - `Optional externalId` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `Optional externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `Optional emailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `Optional onboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `Optional referenceId` The platform's own reference for the entity. `null` until the platform supplies one. - `Optional externalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `Optional name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. ### Beta User Profile Enrollment URL - `class BetaUserProfileEnrollmentUrl` A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant. - `Type type` Object type. Always `enrollment_url`. - `LocalDateTime expiresAt` When this enrollment URL expires, in RFC 3339 format. format: date-time - `String url` Enrollment URL to send to the end user. Valid until `expires_at`. ### Beta User Profile External User Details - `class BetaUserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value. - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `Optional emailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `Optional onboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `Optional referenceId` The platform's own reference for the entity. `null` until the platform supplies one. ### Beta User Profile External User Details Params - `class BetaUserProfileExternalUserDetailsParams` - `Optional accountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `ACTIVE("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `SUSPENDED("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `BLOCKED("blocked")` The platform has barred the account of the entity that the user profile represents. - `Optional country` The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked. - `Optional emailHash` A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `Optional entityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `INDIVIDUAL("individual")` - `BUSINESS("business")` - `NON_PROFIT("non_profit")` - `GOVERNMENT("government")` - `Optional nameHash` A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `Optional onboardedAt` When the entity 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. format: date-time - `Optional referenceId` The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. minLength: 1, maxLength: 255 ### Beta User Profile Trust Grant - `class BetaUserProfileTrustGrant` The status of one trust grant on a user profile, listed in the profile's `trust_grants` map under the grant's name. - `Status status` Status of the trust grant. - `ACTIVE("active")` - `PENDING("pending")` - `REJECTED("rejected")`