Skip to main content

Date of Birth Validation

The Date of Birth Validation endpoint serves two purposes:

  1. Holistic DoB retrievaldateOfBirthReturned is 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.
  2. DoB matching — If a date_of_birth value 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

  1. The customer initiates and completes a normal auth transaction (via front-end, API, or MAS).
  2. Once the transaction is complete, call this endpoint.
  3. To retrieve the date of birth only, omit date_of_birth from the query.
  4. To match against a known date of birth, include date_of_birth as a query parameter.

Request parameters

ParameterTypeRequiredDescription
transaction_idUUID (path)YesThe ID of the completed transaction
date_of_birthdate (query)NoThe date of birth to validate against the authenticated user's record

Response

{
"dateOfBirthReturned": "1985-03-22",
"match": "Match",
"matchDateOfBirth": "1985-03-22"
}
FieldTypeDescription
dateOfBirthReturneddateThe date of birth of the authenticated user, normalised across providers
matchstringThe result of the match comparison. Only present when date_of_birth was provided in the request
matchDateOfBirthdateThe date of birth used for the match comparison

Match values

ValueMeaning
MatchThe provided date of birth matches the eID-verified value exactly
NoMatchThe provided date of birth does not match
PartialThe 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.