User Profiles changedapi/beta/user_profiles
Nearest release: v2.1.306, published 2 hours after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+472added
Lines−94removed
From line
21
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits19to this page, all time
## Delete User Profile ### Beta Deleted User Profile ## User Profiles › Action URLs ### Create Action URL #### Path parameters #### Headers #### Body parameters #### Returns #### Example ##### Response (200)
The whole hunk
from line 21, old and new numbered
/
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 21
2121
2222- `"anthropic-beta": optional array of AnthropicBeta`
2323
24 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.
24 Optional header to specify the beta version(s) you want to use.
2525
2626 - `string`
2727
from line 149
149149
150150- `external_id: optional string or null`
151151
152 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.
152 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Legacy field, accepted only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, send `external_user_details.reference_id`.
153153
154154 minLength: 1, maxLength: 255
155155
156156- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
157157
158 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.
158 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.
159159
160160 - `account_status: optional "active" or "suspended" or "blocked" or null`
161161
from line 215
215215
216216- `external_user_onboarded_at: optional string`
217217
218 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.
218 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. Legacy field, accepted only under the `user-profiles-2026-08-18` beta header; without a legacy header, send `external_user_details.onboarded_at`.
219219
220220 format: date-time
221221
from line 255
255255
256256 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
257257
258 - `name: string or null`
259
260 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.
261
258262 - `trust_grants: map[BetaUserProfileTrustGrant]`
259263
260264 Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 275
271275
272276 - `updated_at: string`
273277
274 When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp.
278 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.
275279
276280 format: date-time
277281
278282 - `access_type: optional "application" or "passthrough"`
279283
280 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.
284 How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header.
281285
282286 - `"application"`
283287
from line 293
289293
290294 - `external_id: optional string or null`
291295
292 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`.
296 Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`.
293297
294298 - `external_user_details: optional BetaUserProfileExternalUserDetails`
295299
296 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`.
300 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`.
297301
298302 - `account_status: "active" or "suspended" or "blocked" or null`
299303
from line 351
347351
348352 - `external_user_onboarded_at: optional string or null`
349353
350 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`.
354 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. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`.
351355
352356 format: date-time
353
354 - `name: optional string or null`
355
356 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.
357357
358358### Example
359359
from line 364
364364 -H 'anthropic-beta: user-profiles-2026-08-18' \
365365 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
366366 -d '{
367 "external_id": "user_12345",
368 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
369 "metadata": {}
367 "external_user_details": {
368 "account_status": "active",
369 "country": "US",
370 "entity_type": "business",
371 "onboarded_at": "2024-11-02T08:15:00Z",
372 "reference_id": "user_12345"
373 },
374 "metadata": {},
375 "name": "Example User"
370376 }'
371377```
372378
from line 383
377383 "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
378384 "created_at": "2026-03-15T10:00:00Z",
379385 "metadata": {},
386 "name": "Example User",
380387 "trust_grants": {
381388 "cyber": {
382389 "status": "active"
from line 395
388395 "external_id": "user_12345",
389396 "external_user_details": {
390397 "account_status": "active",
391 "country": "country",
392 "email_hash": "email_hash",
393 "entity_type": "individual",
394 "name_hash": "name_hash",
395 "onboarded_at": "2019-12-27T18:11:19.117Z",
396 "reference_id": "reference_id"
398 "country": "US",
399 "email_hash": null,
400 "entity_type": "business",
401 "name_hash": null,
402 "onboarded_at": "2024-11-02T08:15:00Z",
403 "reference_id": "user_12345"
397404 },
398 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
399 "name": "Example User"
405 "external_user_onboarded_at": "2024-11-02T08:15:00Z"
400406}
401407```
402408
from line 460
454460
455461- `"anthropic-beta": optional array of AnthropicBeta`
456462
457 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.
463 Optional header to specify the beta version(s) you want to use.
458464
459465 - `string`
460466
from line 596
590596
591597 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
592598
599 - `name: string or null`
600
601 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.
602
593603 - `trust_grants: map[BetaUserProfileTrustGrant]`
594604
595605 Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 616
606616
607617 - `updated_at: string`
608618
609 When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp.
619 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.
610620
611621 format: date-time
612622
613623 - `access_type: optional "application" or "passthrough"`
614624
615 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.
625 How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header.
616626
617627 - `"application"`
618628
from line 634
624634
625635 - `external_id: optional string or null`
626636
627 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`.
637 Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`.
628638
629639 - `external_user_details: optional BetaUserProfileExternalUserDetails`
630640
631 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`.
641 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`.
632642
633643 - `account_status: "active" or "suspended" or "blocked" or null`
634644
from line 692
682692
683693 - `external_user_onboarded_at: optional string or null`
684694
685 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`.
695 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. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`.
686696
687697 format: date-time
688
689 - `name: optional string or null`
690
691 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.
692698
693699- `next_page: string or null`
694700
from line 718
712718 "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
713719 "created_at": "2026-03-15T10:00:00Z",
714720 "metadata": {},
721 "name": "Example User",
715722 "trust_grants": {
716723 "cyber": {
717724 "status": "active"
from line 730
723730 "external_id": "user_12345",
724731 "external_user_details": {
725732 "account_status": "active",
726 "country": "country",
727 "email_hash": "email_hash",
728 "entity_type": "individual",
729 "name_hash": "name_hash",
730 "onboarded_at": "2019-12-27T18:11:19.117Z",
731 "reference_id": "reference_id"
733 "country": "US",
734 "email_hash": null,
735 "entity_type": "business",
736 "name_hash": null,
737 "onboarded_at": "2024-11-02T08:15:00Z",
738 "reference_id": "user_12345"
732739 },
733 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
734 "name": "Example User"
740 "external_user_onboarded_at": "2024-11-02T08:15:00Z"
735741 }
736742 ],
737743 "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
from line 766
760766
761767- `"anthropic-beta": optional array of AnthropicBeta`
762768
763 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.
769 Optional header to specify the beta version(s) you want to use.
764770
765771 - `string`
766772
from line 904
898904
899905 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
900906
907 - `name: string or null`
908
909 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.
910
901911 - `trust_grants: map[BetaUserProfileTrustGrant]`
902912
903913 Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 924
914924
915925 - `updated_at: string`
916926
917 When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp.
927 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.
918928
919929 format: date-time
920930
921931 - `access_type: optional "application" or "passthrough"`
922932
923 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.
933 How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header.
924934
925935 - `"application"`
926936
from line 942
932942
933943 - `external_id: optional string or null`
934944
935 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`.
945 Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`.
936946
937947 - `external_user_details: optional BetaUserProfileExternalUserDetails`
938948
939 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`.
949 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`.
940950
941951 - `account_status: "active" or "suspended" or "blocked" or null`
942952
from line 1000
9901000
9911001 - `external_user_onboarded_at: optional string or null`
9921002
993 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`.
1003 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. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`.
9941004
9951005 format: date-time
996
997 - `name: optional string or null`
998
999 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.
10001006
10011007### Example
10021008
from line 1020
10141020 "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
10151021 "created_at": "2026-03-15T10:00:00Z",
10161022 "metadata": {},
1023 "name": "Example User",
10171024 "trust_grants": {
10181025 "cyber": {
10191026 "status": "active"
from line 1032
10251032 "external_id": "user_12345",
10261033 "external_user_details": {
10271034 "account_status": "active",
1028 "country": "country",
1029 "email_hash": "email_hash",
1030 "entity_type": "individual",
1031 "name_hash": "name_hash",
1032 "onboarded_at": "2019-12-27T18:11:19.117Z",
1033 "reference_id": "reference_id"
1035 "country": "US",
1036 "email_hash": null,
1037 "entity_type": "business",
1038 "name_hash": null,
1039 "onboarded_at": "2024-11-02T08:15:00Z",
1040 "reference_id": "user_12345"
10341041 },
1035 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
1036 "name": "Example User"
1042 "external_user_onboarded_at": "2024-11-02T08:15:00Z"
10371043}
10381044```
10391045
from line 1065
10591065
10601066- `"anthropic-beta": optional array of AnthropicBeta`
10611067
1062 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.
1068 Optional header to specify the beta version(s) you want to use.
10631069
10641070 - `string`
10651071
from line 1193
11871193
11881194- `external_id: optional string or null`
11891195
1190 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.
1196 If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Legacy field, accepted only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, send `external_user_details.reference_id`.
11911197
11921198 minLength: 1, maxLength: 255
11931199
11941200- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
11951201
1196 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.
1202 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.
11971203
11981204 - `account_status: optional "active" or "suspended" or "blocked" or null`
11991205
from line 1259
12531259
12541260- `external_user_onboarded_at: optional string`
12551261
1256 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.
1262 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. Legacy field, accepted only under the `user-profiles-2026-08-18` beta header; without a legacy header, send `external_user_details.onboarded_at`.
12571263
12581264 format: date-time
12591265
from line 1299
12931299
12941300 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
12951301
1302 - `name: string or null`
1303
1304 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.
1305
12961306 - `trust_grants: map[BetaUserProfileTrustGrant]`
12971307
12981308 Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 1319
13091319
13101320 - `updated_at: string`
13111321
1312 When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp.
1322 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.
13131323
13141324 format: date-time
13151325
13161326 - `access_type: optional "application" or "passthrough"`
13171327
1318 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.
1328 How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header.
13191329
13201330 - `"application"`
13211331
from line 1337
13271337
13281338 - `external_id: optional string or null`
13291339
1330 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`.
1340 Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`.
13311341
13321342 - `external_user_details: optional BetaUserProfileExternalUserDetails`
13331343
1334 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`.
1344 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`.
13351345
13361346 - `account_status: "active" or "suspended" or "blocked" or null`
13371347
from line 1395
13851395
13861396 - `external_user_onboarded_at: optional string or null`
13871397
1388 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`.
1398 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. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`.
13891399
13901400 format: date-time
1391
1392 - `name: optional string or null`
1393
1394 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.
13951401
13961402### Example
13971403
from line 1408
14021408 -H 'anthropic-beta: user-profiles-2026-08-18' \
14031409 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
14041410 -d '{
1405 "external_id": "user_12345"
1411 "external_user_details": {
1412 "account_status": "suspended"
1413 }
14061414 }'
14071415```
14081416
from line 1421
14131421 "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
14141422 "created_at": "2026-03-15T10:00:00Z",
14151423 "metadata": {},
1424 "name": "Example User",
14161425 "trust_grants": {
14171426 "cyber": {
14181427 "status": "active"
from line 1433
14241433 "external_id": "user_12345",
14251434 "external_user_details": {
14261435 "account_status": "active",
1427 "country": "country",
1428 "email_hash": "email_hash",
1429 "entity_type": "individual",
1430 "name_hash": "name_hash",
1431 "onboarded_at": "2019-12-27T18:11:19.117Z",
1432 "reference_id": "reference_id"
1436 "country": "US",
1437 "email_hash": null,
1438 "entity_type": "business",
1439 "name_hash": null,
1440 "onboarded_at": "2024-11-02T08:15:00Z",
1441 "reference_id": "user_12345"
14331442 },
1434 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
1435 "name": "Example User"
1443 "external_user_onboarded_at": "2024-11-02T08:15:00Z"
14361444}
14371445```
14381446
1447## Delete User Profile
1448
1449**DELETE** `/v1/user_profiles/{user_profile_id}`
1450
1451Delete User Profile
1452
1453### Path parameters
1454
1455- `user_profile_id: string`
1456
1457 The ID of the user profile to delete (`uprof_...`).
1458
1459### Headers
1460
1461- `"anthropic-version": optional string`
1462
1463 The version of the Claude API you want to use.
1464
1465 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
1466
1467- `"anthropic-beta": optional array of AnthropicBeta`
1468
1469 Optional header to specify the beta version(s) you want to use.
1470
1471 - `string`
1472
1473 - `"message-batches-2024-09-24"`
1474
1475 - `"prompt-caching-2024-07-31"`
1476
1477 - `"computer-use-2024-10-22"`
1478
1479 - `"computer-use-2025-01-24"`
1480
1481 - `"pdfs-2024-09-25"`
1482
1483 - `"token-counting-2024-11-01"`
1484
1485 - `"token-efficient-tools-2025-02-19"`
1486
1487 - `"output-128k-2025-02-19"`
1488
1489 - `"files-api-2025-04-14"`
1490
1491 - `"mcp-client-2025-04-04"`
1492
1493 - `"mcp-client-2025-11-20"`
1494
1495 - `"dev-full-thinking-2025-05-14"`
1496
1497 - `"interleaved-thinking-2025-05-14"`
1498
1499 - `"code-execution-2025-05-22"`
1500
1501 - `"extended-cache-ttl-2025-04-11"`
1502
1503 - `"context-1m-2025-08-07"`
1504
1505 - `"context-management-2025-06-27"`
1506
1507 - `"model-context-window-exceeded-2025-08-26"`
1508
1509 - `"skills-2025-10-02"`
1510
1511 - `"fast-mode-2026-02-01"`
1512
1513 - `"output-300k-2026-03-24"`
1514
1515 - `"user-profiles-2026-03-24"`
1516
1517 - `"user-profiles-2026-08-18"`
1518
1519 - `"user-profiles-2026-09-04"`
1520
1521 - `"advisor-tool-2026-03-01"`
1522
1523 - `"managed-agents-2026-04-01"`
1524
1525 - `"cache-diagnosis-2026-04-07"`
1526
1527 - `"dreaming-2026-04-21"`
1528
1529 - `"thinking-token-count-2026-05-13"`
1530
1531 - `"server-side-fallback-2026-06-01"`
1532
1533 - `"server-side-fallback-2026-07-01"`
1534
1535 - `"fallback-credit-2026-06-01"`
1536
1537 - `"fallback-credit-2026-07-01"`
1538
1539 - `"agent-memory-2026-07-22"`
1540
1541 - `"mid-conversation-tool-changes-2026-07-01"`
1542
1543 - `"compact-2026-01-12"`
1544
1545 - `"computer-use-2025-11-24"`
1546
1547 - `"mcp-tunnels-2026-06-22"`
1548
1549 - `"structured-outputs-2025-11-13"`
1550
1551 - `"task-budgets-2026-03-13"`
1552
1553 - `"thinking-display-updates-2026-08-18"`
1554
1555 - `"ce-user-management-2026-07-13"`
1556
1557 - `"mid-conversation-output-config-2026-07-01"`
1558
1559 - `"thinking-binding-controls-2026-08-01"`
1560
1561 - `"mid-conversation-system-clear-at-2026-08-21"`
1562
1563 - `"compact-2026-09-04"`
1564
1565 - `"inline-tools-2026-09-15"`
1566
1567 - `"mcp-client-2026-09-15"`
1568
1569 - `"ce-plugins-2026-09-01"`
1570
1571 - `"spend-limit-reads-2026-09-26"`
1572
1573 - `"telemetry-destinations-2026-08-11"`
1574
1575- `"anthropic-workspace-id": optional string`
1576
1577 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1578
1579 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.
1580
1581### Returns
1582
1583- `BetaDeletedUserProfile object`
1584
1585 - `type: "user_profile_deleted"`
1586
1587 Object type. Always `user_profile_deleted`.
1588
1589 - `id: string`
1590
1591 Identifier of the deleted user profile, prefixed `uprof_`.
1592
1593### Example
1594
1595```bash
1596curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \
1597 -X DELETE \
1598 -H 'anthropic-version: 2023-06-01' \
1599 -H 'anthropic-beta: user-profiles-2026-08-18' \
1600 -H "X-Api-Key: $ANTHROPIC_API_KEY"
1601```
1602
1603#### Response (200)
1604
1605```json
1606{
1607 "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
1608 "type": "user_profile_deleted"
1609}
1610```
1611
14391612## Create Enrollment URL
14401613
14411614**POST** `/v1/user_profiles/{user_profile_id}/enrollment_url`
from line 1631
14581631
14591632- `"anthropic-beta": optional array of AnthropicBeta`
14601633
1461 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.
1634 Optional header to specify the beta version(s) you want to use.
14621635
14631636 - `string`
14641637
from line 1747
15741747
15751748- `BetaUserProfileEnrollmentURL object`
15761749
1577 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
1750 A URL to give to the entity that a user profile represents, so that the entity can enroll in a program.
15781751
15791752 - `type: "enrollment_url"`
15801753
from line 1785
16121785
16131786## Domain types
16141787
1788### Beta Deleted User Profile
1789
1790- `BetaDeletedUserProfile object`
1791
1792 - `type: "user_profile_deleted"`
1793
1794 Object type. Always `user_profile_deleted`.
1795
1796 - `id: string`
1797
1798 Identifier of the deleted user profile, prefixed `uprof_`.
1799
16151800### Beta User Profile
16161801
16171802- `BetaUserProfile object`
from line 1823
16381823
16391824 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
16401825
1826 - `name: string or null`
1827
1828 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.
1829
16411830 - `trust_grants: map[BetaUserProfileTrustGrant]`
16421831
16431832 Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
from line 1843
16541843
16551844 - `updated_at: string`
16561845
1657 When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp.
1846 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.
16581847
16591848 format: date-time
16601849
16611850 - `access_type: optional "application" or "passthrough"`
16621851
1663 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.
1852 How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header.
16641853
16651854 - `"application"`
16661855
from line 1861
16721861
16731862 - `external_id: optional string or null`
16741863
1675 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`.
1864 Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`.
16761865
16771866 - `external_user_details: optional BetaUserProfileExternalUserDetails`
16781867
1679 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`.
1868 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`.
16801869
16811870 - `account_status: "active" or "suspended" or "blocked" or null`
16821871
from line 1919
17301919
17311920 - `external_user_onboarded_at: optional string or null`
17321921
1733 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`.
1922 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. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`.
17341923
17351924 format: date-time
17361925
1737 - `name: optional string or null`
1738
1739 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.
1740
17411926### Beta User Profile Enrollment URL
17421927
17431928- `BetaUserProfileEnrollmentURL object`
17441929
1745 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
1930 A URL to give to the entity that a user profile represents, so that the entity can enroll in a program.
17461931
17471932 - `type: "enrollment_url"`
17481933
from line 2074
18892074 - `"pending"`
18902075
18912076 - `"rejected"`
2077
2078## User Profiles › Action URLs
2079
2080### Create Action URL
2081
2082**POST** `/v1/user_profiles/{user_profile_id}/action_urls`
2083
2084Create Action URL
2085
2086#### Path parameters
2087
2088- `user_profile_id: string`
2089
2090 The ID of the user profile the action is for (`uprof_...`).
2091
2092#### Headers
2093
2094- `"anthropic-version": optional string`
2095
2096 The version of the Claude API you want to use.
2097
2098 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2099
2100- `"anthropic-beta": optional array of AnthropicBeta`
2101
2102 Optional header to specify the beta version(s) you want to use.
2103
2104 - `string`
2105
2106 - `"message-batches-2024-09-24"`
2107
2108 - `"prompt-caching-2024-07-31"`
2109
2110 - `"computer-use-2024-10-22"`
2111
2112 - `"computer-use-2025-01-24"`
2113
2114 - `"pdfs-2024-09-25"`
2115
2116 - `"token-counting-2024-11-01"`
2117
2118 - `"token-efficient-tools-2025-02-19"`
2119
2120 - `"output-128k-2025-02-19"`
2121
2122 - `"files-api-2025-04-14"`
2123
2124 - `"mcp-client-2025-04-04"`
2125
2126 - `"mcp-client-2025-11-20"`
2127
2128 - `"dev-full-thinking-2025-05-14"`
2129
2130 - `"interleaved-thinking-2025-05-14"`
2131
2132 - `"code-execution-2025-05-22"`
2133
2134 - `"extended-cache-ttl-2025-04-11"`
2135
2136 - `"context-1m-2025-08-07"`
2137
2138 - `"context-management-2025-06-27"`
2139
2140 - `"model-context-window-exceeded-2025-08-26"`
2141
2142 - `"skills-2025-10-02"`
2143
2144 - `"fast-mode-2026-02-01"`
2145
2146 - `"output-300k-2026-03-24"`
2147
2148 - `"user-profiles-2026-03-24"`
2149
2150 - `"user-profiles-2026-08-18"`
2151
2152 - `"user-profiles-2026-09-04"`
2153
2154 - `"advisor-tool-2026-03-01"`
2155
2156 - `"managed-agents-2026-04-01"`
2157
2158 - `"cache-diagnosis-2026-04-07"`
2159
2160 - `"dreaming-2026-04-21"`
2161
2162 - `"thinking-token-count-2026-05-13"`
2163
2164 - `"server-side-fallback-2026-06-01"`
2165
2166 - `"server-side-fallback-2026-07-01"`
2167
2168 - `"fallback-credit-2026-06-01"`
2169
2170 - `"fallback-credit-2026-07-01"`
2171
2172 - `"agent-memory-2026-07-22"`
2173
2174 - `"mid-conversation-tool-changes-2026-07-01"`
2175
2176 - `"compact-2026-01-12"`
2177
2178 - `"computer-use-2025-11-24"`
2179
2180 - `"mcp-tunnels-2026-06-22"`
2181
2182 - `"structured-outputs-2025-11-13"`
2183
2184 - `"task-budgets-2026-03-13"`
2185
2186 - `"thinking-display-updates-2026-08-18"`
2187
2188 - `"ce-user-management-2026-07-13"`
2189
2190 - `"mid-conversation-output-config-2026-07-01"`
2191
2192 - `"thinking-binding-controls-2026-08-01"`
2193
2194 - `"mid-conversation-system-clear-at-2026-08-21"`
2195
2196 - `"compact-2026-09-04"`
2197
2198 - `"inline-tools-2026-09-15"`
2199
2200 - `"mcp-client-2026-09-15"`
2201
2202 - `"ce-plugins-2026-09-01"`
2203
2204 - `"spend-limit-reads-2026-09-26"`
2205
2206 - `"telemetry-destinations-2026-08-11"`
2207
2208- `"anthropic-workspace-id": optional string`
2209
2210 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
2211
2212 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.
2213
2214#### Body parameters
2215
2216- `action: BetaUserProfileAction`
2217
2218 The action that the person who opens the URL takes.
2219
2220 - `BetaUserProfileEnrollEndUserAction object`
2221
2222 The end-user that the profile represents enrolls in a program.
2223
2224 - `type: "enroll_end_user"`
2225
2226#### Returns
2227
2228- `BetaUserProfileActionURL object`
2229
2230 A URL to give to the person who takes the requested action.
2231
2232 - `type: "user_profile_action_url"`
2233
2234 Object type. Always `user_profile_action_url`.
2235
2236 - `expires_at: string`
2237
2238 When the URL stops working, in RFC 3339 format.
2239
2240 format: date-time
2241
2242 - `url: string`
2243
2244 The URL to give to the person who takes the action. Anyone who holds it can open it until `expires_at`.
2245
2246#### Example
2247
2248```bash
2249curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/action_urls \
2250 -H 'Content-Type: application/json' \
2251 -H 'anthropic-version: 2023-06-01' \
2252 -H 'anthropic-beta: user-profiles-2026-08-18' \
2253 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
2254 -d '{
2255 "action": {
2256 "type": "enroll_end_user"
2257 }
2258 }'
2259```
2260
2261##### Response (200)
2262
2263```json
2264{
2265 "expires_at": "2026-03-15T10:15:00Z",
2266 "type": "user_profile_action_url",
2267 "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1"
2268}
2269```
18922270
No line in this hunk matches that.