The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Create User Profile
3url: https://platform.claude.com/docs/en/api/beta/user_profiles/create
4---
5
16# Create User Profile
27
38**POST** `/v1/user_profiles`
from line 17
1217
1318 - `string`
1419
15 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1621
1722 - `"message-batches-2024-09-24"`
1823
from line 65
6065
6166 - `"user-profiles-2026-08-18"`
6267
68 - `"user-profiles-2026-09-04"`
69
6370 - `"advisor-tool-2026-03-01"`
6471
6572 - `"managed-agents-2026-04-01"`
from line 121
114121
115122- `external_id: optional string or null`
116123
117 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
124 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.
118125
119126 minLength: 1, maxLength: 255
120127
128- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
129
130 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.
131
132 - `account_status: optional "active" or "suspended" or "blocked" or null`
133
134 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 in `trust_grants` are Anthropic's and do not follow it.
135
136 - `"active"`
137
138 - `"suspended"`
139
140 - `"blocked"`
141
142 - `country: optional string or null`
143
144 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.
145
146 - `email_hash: optional string or null`
147
148 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.
149
150 minLength: 1, maxLength: 255
151
152 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null`
153
154 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
155
156 - `"individual"`
157
158 - `"business"`
159
160 - `"non_profit"`
161
162 - `"government"`
163
164 - `name_hash: optional string or null`
165
166 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.
167
168 minLength: 1, maxLength: 255
169
170 - `onboarded_at: optional string`
171
172 A timestamp in RFC 3339 format
173
174 format: date-time
175
176 - `reference_id: optional string or null`
177
178 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.
179
180 minLength: 1, maxLength: 255
181
121182- `external_user_onboarded_at: optional string`
122183
123184 A timestamp in RFC 3339 format
from line 199
138199
139200- `BetaUserProfile object`
140201
202 - `type: "user_profile"`
203
204 Object type. Always `user_profile`.
205
141206 - `id: string`
142207
143208 Unique identifier for this user profile, prefixed `uprof_`.
from line 231
166231
167232 - `"rejected"`
168233
169 - `type: "user_profile"`
170
171 Object type. Always `user_profile`.
172
173234 - `updated_at: string`
174235
175236 A timestamp in RFC 3339 format
from line 247
186247
187248 - `external_id: optional string or null`
188249
189 Platform's own identifier for this user. Not enforced unique.
250 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`.
190251
252 - `external_user_details: optional BetaUserProfileExternalUserDetails`
253
254 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.
255
256 - `account_status: "active" or "suspended" or "blocked" or null`
257
258 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 in `trust_grants` are Anthropic's and do not follow it.
259
260 - `"active"`
261
262 - `"suspended"`
263
264 - `"blocked"`
265
266 - `country: string or null`
267
268 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
269
270 - `email_hash: string or null`
271
272 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
273
274 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
275
276 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
277
278 - `"individual"`
279
280 - `"business"`
281
282 - `"non_profit"`
283
284 - `"government"`
285
286 - `name_hash: string or null`
287
288 The platform-computed hash of the entity's name. `null` until the platform supplies one.
289
290 - `onboarded_at: string or null`
291
292 A timestamp in RFC 3339 format
293
294 format: date-time
295
296 - `reference_id: string or null`
297
298 The platform's own reference for the entity. `null` until the platform supplies one.
299
191300 - `external_user_onboarded_at: optional string or null`
192301
193302 A timestamp in RFC 3339 format
from line 338
229338 "updated_at": "2026-03-15T10:00:00Z",
230339 "access_type": "application",
231340 "external_id": "user_12345",
341 "external_user_details": {
342 "account_status": "active",
343 "country": "country",
344 "email_hash": "email_hash",
345 "entity_type": "individual",
346 "name_hash": "name_hash",
347 "onboarded_at": "2019-12-27T18:11:19.117Z",
348 "reference_id": "reference_id"
349 },
232350 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
233351 "name": "Example User"
234352}