Claude Platform Docs

User Profiles

Create User Profile
$ ant beta:user-profiles create
POST/v1/user_profiles
List User Profiles
$ ant beta:user-profiles list
GET/v1/user_profiles
Get User Profile
$ ant beta:user-profiles retrieve
GET/v1/user_profiles/{user_profile_id}
Update User Profile
$ ant beta:user-profiles update
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
$ ant beta:user-profiles create-enrollment-url
POST/v1/user_profiles/{user_profile_id}/enrollment_url
Models
beta_user_profile: object{ type: "user_profile", id, created_at, 8 more }

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.

beta_user_profile_enrollment_url: object{ type: "enrollment_url", expires_at, url }

A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.

type: "enrollment_url"

Object type. Always enrollment_url.

expires_at: string

When this enrollment URL expires, in RFC 3339 format.

formatdate-time
url: string

Enrollment URL to send to the end user. Valid until expires_at.

beta_user_profile_external_user_details: object{ account_status, country, email_hash, 4 more }

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.

beta_user_profile_external_user_details_params: object{ account_status, country, email_hash, 4 more }
beta_user_profile_trust_grant: object{ status }

The status of one trust grant on a user profile, listed in the profile's trust_grants map under the grant's name.

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

Status of the trust grant.

One of the following:
"active"
"pending"
"rejected"