--- title: User Profiles url: https://platform.claude.com/docs/en/api/http/user_profiles --- # User Profiles ## Create User Profile **POST** `/v1/user_profiles` Create User Profile ### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-workspace-id": optional string` 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. ### Body parameters - `access_type: optional UserProfileAccessType` 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"` 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"` The user profile represents a company that the platform resells Claude access to. - `external_user_details: optional UserProfileExternalUserDetailsParams` Details about the entity this profile represents, as the platform states them. Every field is optional. Not accepted under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which take the top-level `external_id` (and, under `user-profiles-2026-08-18`, `external_user_onboarded_at`) instead. - `account_status: optional UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: optional string or null` 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. - `email_hash: optional string or null` 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 - `entity_type: optional UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: optional string or null` 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 - `onboarded_at: optional string` 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 - `reference_id: optional string or null` 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 - `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 or null` 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 - `UserProfile object` 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: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `access_type: UserProfileAccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `"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"` The user profile represents a company that the platform resells Claude access to. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `external_user_details: UserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `account_status: UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` 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 - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `name: string or null` 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. `null` until the platform supplies one. - `programs: UserProfilePrograms` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `cyber: UserProfileCyberProgram or null` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` - `efs: UserProfileEfsProgram or null` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. - `updated_at: string` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time ### Example ```bash curl https://api.anthropic.com/v1/user_profiles \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "external_user_details": { "account_status": "active", "country": "US", "entity_type": "business", "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User" }' ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ``` ## List User Profiles **GET** `/v1/user_profiles` List User Profiles ### Query parameters - `limit: optional number` The maximum number of user profiles to return, from 1 to 100. Defaults to 20. format: int32 - `order: optional UserProfileListOrder` The sort direction, applied to the field that `order_by` selects. Defaults to `desc`. - `"asc"` Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`. - `"desc"` Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default. - `order_by: optional UserProfileListOrderBy` The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`. - `"created_at"` Sort by when each user profile was created. This is the default. - `"name"` Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction. - `page: optional string` The cursor for the page to return, taken from `next_page` in a previous response. Leave it out to get the first page. ### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-workspace-id": optional string` 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 - `data: array of UserProfile` User profiles on this page. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `access_type: UserProfileAccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `"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"` The user profile represents a company that the platform resells Claude access to. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `external_user_details: UserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `account_status: UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` 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 - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `name: string or null` 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. `null` until the platform supplies one. - `programs: UserProfilePrograms` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `cyber: UserProfileCyberProgram or null` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` - `efs: UserProfileEfsProgram or null` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. - `updated_at: string` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time - `next_page: string or null` Cursor for the next page, or `null` when there are no more results. ### Example ```bash curl https://api.anthropic.com/v1/user_profiles \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` #### Response (200) ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": {} }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get User Profile **GET** `/v1/user_profiles/{user_profile_id}` Get User Profile ### Path parameters - `user_profile_id: string` The ID of the user profile to get (`uprof_...`). ### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-workspace-id": optional string` 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 - `UserProfile object` 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: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `access_type: UserProfileAccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `"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"` The user profile represents a company that the platform resells Claude access to. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `external_user_details: UserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `account_status: UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` 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 - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `name: string or null` 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. `null` until the platform supplies one. - `programs: UserProfilePrograms` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `cyber: UserProfileCyberProgram or null` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` - `efs: UserProfileEfsProgram or null` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. - `updated_at: string` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time ### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Update User Profile **POST** `/v1/user_profiles/{user_profile_id}` Update User Profile ### Path parameters - `user_profile_id: string` The ID of the user profile to update (`uprof_...`). ### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-workspace-id": optional string` 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. ### Body parameters - `access_type: optional UserProfileAccessType or null` If present, replaces the stored access type. Omit to leave unchanged. - `"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"` The user profile represents a company that the platform resells Claude access to. - `external_user_details: optional UserProfileExternalUserDetailsParams` 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. Not accepted under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers. - `account_status: optional UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: optional string or null` 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. - `email_hash: optional string or null` 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 - `entity_type: optional UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: optional string or null` 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 - `onboarded_at: optional string` 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 - `reference_id: optional string or null` 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 - `metadata: optional map[string]` 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. - `name: optional string or null` If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. minLength: 1, maxLength: 255 ### Returns - `UserProfile object` 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: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `access_type: UserProfileAccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `"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"` The user profile represents a company that the platform resells Claude access to. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `external_user_details: UserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `account_status: UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` 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 - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `name: string or null` 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. `null` until the platform supplies one. - `programs: UserProfilePrograms` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `cyber: UserProfileCyberProgram or null` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` - `efs: UserProfileEfsProgram or null` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. - `updated_at: string` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time ### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "external_user_details": { "account_status": "suspended" } }' ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Delete User Profile **DELETE** `/v1/user_profiles/{user_profile_id}` Delete User Profile ### Path parameters - `user_profile_id: string` The ID of the user profile to delete (`uprof_...`). ### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-workspace-id": optional string` 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 - `DeletedUserProfile object` - `type: "user_profile_deleted"` Object type. Always `user_profile_deleted`. - `id: string` Identifier of the deleted user profile, prefixed `uprof_`. ### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "type": "user_profile_deleted" } ``` ## Domain types ### Deleted User Profile - `DeletedUserProfile object` - `type: "user_profile_deleted"` Object type. Always `user_profile_deleted`. - `id: string` Identifier of the deleted user profile, prefixed `uprof_`. ### User Profile - `UserProfile object` 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: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `access_type: UserProfileAccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `"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"` The user profile represents a company that the platform resells Claude access to. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `external_user_details: UserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `account_status: UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` 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 - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `name: string or null` 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. `null` until the platform supplies one. - `programs: UserProfilePrograms` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `cyber: UserProfileCyberProgram or null` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` - `efs: UserProfileEfsProgram or null` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. - `updated_at: string` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time ### User Profile Access Type - `UserProfileAccessType = "application" or "passthrough"` How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company. - `"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"` The user profile represents a company that the platform resells Claude access to. ### User Profile Cyber Program - `UserProfileCyberProgram object` A user profile's standing in the Cyber Verification Program, which relaxes cyber safeguards for requests that name the profile. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` ### User Profile Cyber Requirements - `UserProfileCyberRequirements object` What a request that names the profile must allow to get the relaxed safeguards of the profile's `active` tiers. A field reads `true` when at least one of those tiers has the requirement and Anthropic has not waived it on that tier for the profile. A request that does not meet a requirement is still served, without the relaxed safeguards of the tiers that have it. The values differ between profiles and can change, so read them rather than assuming them. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. ### User Profile Cyber Tier - `UserProfileCyberTier object` One tier of the Cyber Verification Program. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` ### User Profile Efs Feature - `UserProfileEfsFeature object` One feature of Enterprise Frontier Safeguards. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` ### User Profile Efs Program - `UserProfileEfsProgram object` A user profile's standing in Enterprise Frontier Safeguards, a program under which Anthropic approves the entity the profile represents and may approve any of the program's features. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. ### User Profile External User Account Status - `UserProfileExternalUserAccountStatus = "active" or "suspended" or "blocked"` The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only. The statuses that Anthropic itself reports for the profile, such as its status in a program, are Anthropic's decisions and do not change with it. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. ### User Profile External User Details - `UserProfileExternalUserDetails object` 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. - `account_status: UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` 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 - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. ### User Profile External User Details Params - `UserProfileExternalUserDetailsParams object` - `account_status: optional UserProfileExternalUserAccountStatus or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: optional string or null` 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. - `email_hash: optional string or null` 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 - `entity_type: optional UserProfileExternalUserEntityType or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: optional string or null` 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 - `onboarded_at: optional string` 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 - `reference_id: optional string or null` 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 ### User Profile External User Entity Type - `UserProfileExternalUserEntityType = "individual" or "business" or "non_profit" or "government"` What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`. - `"individual"` - `"business"` - `"non_profit"` - `"government"` ### User Profile List Order - `UserProfileListOrder = "asc" or "desc"` The direction that a list of user profiles is sorted in. - `"asc"` Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`. - `"desc"` Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default. ### User Profile List Order By - `UserProfileListOrderBy = "created_at" or "name"` Sort field for listing user profiles: `created_at` (default) or `name` (case-insensitive; profiles without a name sort last). - `"created_at"` Sort by when each user profile was created. This is the default. - `"name"` Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction. ### User Profile Program Status - `UserProfileProgramStatus = "active" or "pending" or "rejected"` A user profile's status in a program. Each program's `status` field says what the values mean there. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. ### User Profile Programs - `UserProfilePrograms object` A user profile's standing in each program. A program is a set of capabilities or exemptions that Anthropic approves for the entity the profile represents. A program reads `null` when the profile has no status in it, when the caller's organization is not entitled to read programs, or when the response does not report that program. Retrieving the profile reports every program. Anthropic may add programs; ignore a key you do not recognize. - `cyber: UserProfileCyberProgram or null` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `requirements: UserProfileCyberRequirements or null` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `data_retention: boolean` Whether Anthropic must be able to retain the request's inference data. - `human_review: boolean` Whether Anthropic personnel must be allowed to review the data retained from the request. - `status: UserProfileProgramStatus` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. - `tiers: map[UserProfileCyberTier]` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. - `"active"` - `"inactive"` - `efs: UserProfileEfsProgram or null` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. - `features: map[UserProfileEfsFeature]` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `status: "active" or "inactive"` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. - `"active"` - `"inactive"` - `status: UserProfileProgramStatus` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. ## User Profiles › Action URLs ### Create Action URL **POST** `/v1/user_profiles/{user_profile_id}/action_urls` Create Action URL #### Path parameters - `user_profile_id: string` The ID of the user profile the action is for (`uprof_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-workspace-id": optional string` 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. #### Body parameters - `action: UserProfileAction` The action that the person who opens the URL takes. - `UserProfileEnrollEndUserAction object` The end-user that the profile represents enrolls in a program. - `type: "enroll_end_user"` #### Returns - `UserProfileActionURL object` A URL to give to the person who takes the requested action. - `type: "user_profile_action_url"` Object type. Always `user_profile_action_url`. - `expires_at: string` When the URL stops working, in RFC 3339 format. format: date-time - `url: string` The URL to give to the person who takes the action. Anyone who holds it can open it until `expires_at`. #### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/action_urls \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "action": { "type": "enroll_end_user" } }' ``` ##### Response (200) ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "user_profile_action_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ```