Date of Birth Validation
The Date of Birth Validation endpoint serves two purposes:
- Holistic DoB retrieval —
dateOfBirthReturnedis always present in the response and provides a normalised date of birth for the authenticated user, regardless of which Auth method was used. This is useful because different eIDs structure or expose date of birth differently. - DoB matching — If a
date_of_birthvalue is included in the request, the endpoint also returns whether that value matches the DoB on record for the authenticated user. This can confirm that a known identity matches the person who just authenticated.
How it works
- The customer initiates and completes a normal auth transaction (via front-end, API, or MAS).
- Once the transaction is
complete, call this endpoint. - To retrieve the date of birth only, omit
date_of_birthfrom the query. - To match against a known date of birth, include
date_of_birthas a query parameter.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
transaction_id | UUID (path) | Yes | The ID of the completed transaction |
date_of_birth | date (query) | No | The date of birth to validate against the authenticated user's record |
Response
{
"dateOfBirthReturned": "1985-03-22",
"match": "Match",
"matchDateOfBirth": "1985-03-22"
}
| Field | Type | Description |
|---|---|---|
dateOfBirthReturned | date | The date of birth of the authenticated user, normalised across providers |
match | string | The result of the match comparison. Only present when date_of_birth was provided in the request |
matchDateOfBirth | date | The date of birth used for the match comparison |
Match values
| Value | Meaning |
|---|---|
Match | The provided date of birth matches the eID-verified value exactly |
NoMatch | The provided date of birth does not match |
Partial | The values partially overlap. Specific to Swedish end users, where the Swedish personal number (SSN) is not always a 1:1 representation of the date of birth. The day field can differ by at most 10 days |
Provider support
Date of birth validation works with all available Auth and non-QES Sign methods in the eID Hub.
API reference
See the full request and response specification in the Date of birth validation API reference.