Skip to content

Update name example to remove previous names #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
erino wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Update name example to remove previous names #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80be0fa
Update name example to remove previous names
erino Mar 9, 2026
0b099b0
fixup! Update name example to remove previous names
erino Mar 17, 2026
45e2e04
Update changelog
erino Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 1 addition & 22 deletions source/integrate-with-integration-environment/prove-users-identity.html.md.erb
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@LesEckersley LesEckersley Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@erino we should also add an entry to the changelog https://github.com/govuk-one-login/tech-docs/blob/main/source/partials/_changelog.erb

Original file line number Diff line number Diff line change
Expand Up @@ -131,27 +131,6 @@ The JWT contains the following claims:
"type": "FamilyName"
}
]
},
{
"validUntil": "2020-03-01",
"nameParts": [
{
"value": "Alice",
"type": "GivenName"
},
{
"value": "Jane",
"type": "GivenName"
},
{
"value": "Laura",
"type": "GivenName"
},
{
"value": "O’Donnell",
"type": "FamilyName"
}
]
}
],
"birthDate": [
Expand Down Expand Up @@ -279,7 +258,7 @@ The identity credential contains the following claims as properties of `credenti

| Property | Description |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | A list showing the name proven by GOV.UK One Login. At the moment the list will only contain the user’s current name. In the future this list will reflect name changes by using the `validFrom` and `validUntil` metadata properties. If `validUntil` is `null` or not present, that name is your user’s current name. If `validFrom` is `null` or not present, your user may have used that name from birth. <br><br> Each name is presented as an array in the `nameParts` property. Each part of the name is either a `GivenName` or a `FamilyName`, identified in its `type` property. The `value` property could be any text string. GOV.UK One Login cannot specify a maximum length or restrictions on what characters may appear. <br><br> `GivenName` or `FamilyName` can appear in any order within the list. The order of names may depend on either your user’s preferences or the order they appear on documents used to prove your user’s identity. |
| `name` | A list showing the name proven by GOV.UK One Login, this will only contain the user’s current name. If `validFrom` is present then this date reflects the earliest date we have evidence for the name. Each name is presented as an array in the `nameParts` property. Each part of the name is either a `GivenName` or a `FamilyName`, identified in its `type` property. The `value` property could be any text string. GOV.UK One Login cannot specify a maximum length or restrictions on what characters may appear. <br><br> `GivenName` or `FamilyName` can appear in any order within the list. The order of names may depend on either your user’s preferences or the order they appear on documents used to prove your user’s identity. |
| `birthDate` | A list of [ISO 8601 date][external.ISO-8601-date] strings. There may be multiple dates of birth, for example, if there’s evidence an incorrect date of birth was previously recorded for your user. The date of birth GOV.UK One Login has highest confidence in will be the first item in the list. |

## Understand your user’s address claim
Expand Down
1 change: 1 addition & 0 deletions source/partials/_changelog.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

| Publication date | Update |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| April 18 2026 | Updates <a href="/integrate-with-integration-environment/prove-users-identity/#understand-your-user-s-core-identity-claim"> guidance to reflect that previous names are not returned in the core identity claim.</a>. |
| Feb 18 2025 | Updates <a href="/integrate-with-integration-environment/authenticate-your-user/#make-a-token-request"> guidance to add details that audience claim can be either token URI or issuer URI</a>. |
| Feb 17 2026 | Updates guidance <a href="/before-integrating/set-up-your-public-and-private-keys/#share-your-public-keys-with-gov-uk-one-login">"Share your public keys using a JWKS endpoint"</a> to clarify how to use a JWKS endpoint. |
| Feb 16 2026 | Updates website header to clarify this website is the technical documentation for GOV.UK One Login.|
Expand Down