Introduction
itsme accounts are always created from an official ID document (eID card, passport…). However, each country can choose which attributes are presents on those documents so that, depending on the user’s country, some itsme accounts can contain more/different data than others. You will find below a list of all attributes (“claims”) supported by itsme and their availability per country.
Claims
How to understand the table below:
SHALL: A value shall always be returned.
MAY NOT: Best-effort - will return a value in most cases but it may not be possible for some accounts.
SHALL NOT: This values is never available.
Available countries: Belgium, Netherlands, Luxembourg, Ireland, Portugal, Italy, France, Spain, United Kingdom, Germany, Finland, Norway, Sweden, Denmark, Iceland, Estonia, Romania, Austria, Bulgaria, Czech Republic, Greece, Hungary, Poland, Slovakia, Croatia, Lithuania, Slovenia, Latvia, Cyprus, Malta, Serbia, Moldova
No matching claims.
| Claim | Description | SHALL | MAY NOT | SHALL NOT |
|---|---|---|---|---|
| name | User's full name in displayable form including all name parts, possibly including titles and suffixes. | All countries | - | - |
| given_name | User's given name(s) or first name(s). Note that in some cultures, people can have multiple given names or none at all; all can be present, separated by space characters. | - | All countries | - |
| family_name | User's surname(s) or last name(s). Note that in some cultures, people can have multiple family names or none; all can be present, separated by space characters. | All countries | - | - |
| birthdate | User's birthdate, represented as a string in YYYY-MM-DD date format. itsme users are always 16 years old or more. | All other countries (except Belgium) | Belgium | - |
MAY NOT: At least one of birthdate or birthdate_as_string will always be available. (Belgium) | ||||
| http://itsme.services/v2/ claim/birthdate_as_string |
User's birthdate in an unprocessed way, exactly as mentioned on the ID document. itsme users are always 13 years old or more. | - | Belgium | All other countries (except Belgium) |
MAY NOT: At least one of birthdate or birthdate_as_string will always be available. (Belgium) | ||||
| age_gte_13 | Returns true if the age of the user is greater than or equal to 13 years old. Returns false otherwise. This claim is meant to be used for age verification in contexts where data minimisation is relevant and you don't need the exact birthdate. This claim is always returned except for accounts without a valid birthdate. |
All other countries (except Belgium) | Belgium | - |
| age_gte_16 | Returns true if the age of the user is greater than or equal to 16 years old. Returns false otherwise. This claim is meant to be used for age verification in contexts where data minimisation is relevant and you don't need the exact birthdate. This claim is always returned except for accounts without a valid birthdate. |
All other countries (except Belgium) | Belgium | - |
| age_gte_18 | Returns true if the age of the user is greater than or equal to 18 years old. Returns false otherwise. This claim is meant to be used for age verification in contexts where data minimisation is relevant and you don't need the exact birthdate. This claim is always returned except for accounts without a valid birthdate. |
All other countries (except Belgium) | Belgium | - |
| age_gte_21 | Returns true if the age of the user is greater than or equal to 21 years old. Returns false otherwise. This claim is meant to be used for age verification in contexts where data minimisation is relevant and you don't need the exact birthdate. This claim is always returned except for accounts without a valid birthdate. |
All other countries (except Belgium) | Belgium | - |
| age_gte_30 | Returns true if the age of the user is greater than or equal to 30 years old. Returns false otherwise. This claim is meant to be used for age verification in contexts where data minimisation is relevant and you don't need the exact birthdate. This claim is always returned except for accounts without a valid birthdate. |
All other countries (except Belgium) | Belgium | - |
| gender | User's gender. Possible values are: female male unknown n/a. If the value mentioned on the user's ID document is different from those (local language, letter code...), then we apply a best-effort mapping to one of those values. |
All other countries (except Netherlands) | Netherlands | - |
| http://itsme.services/v2/ claim/official_gender |
User's gender unaltered, exactly as mentioned on their ID document. | All other countries (except Netherlands) | Netherlands | - |
| locale | User's itsme app language, represented as a string format. Possible values are : NL FR DE EN |
- | All countries | - |
| picture | User's ID picture, represented as a URL string. This URL points to an image file (for example, a JPEG, JPEG2000, or PNG image file). This image is the raw (unprocessed) image contained on the ID document. Accessing this URL requires using your Access Token (received in the response to your Token Request) as a bearer token. Example: GET /v2/picture HTTP/1.1 |
All other countries (except Belgium) | Belgium | - |
| http://itsme.services/v2/ claim/physical_person_photo |
User's ID picture, represented as a JSON Object containing these members:format: the MIME typevalue: the base64 encoded image.This picture is read from the ID document but converted to always return a 200x140px, 24 BPP JPEG image. |
All other countries (except Belgium) | Belgium | - |
| User's email address. | - | All countries | - | |
| email_verified | Returns true if the user's e-mail address is verified or false otherwise.Note : currently always returns false because no email verification is implemented in our systems at this stage. |
- | All countries | - |
MAY NOT: Only if "email" available | ||||
| phone_number | User's phone number, represented as a string format. For example : [+][country code] [subscriber number including area code]. |
All countries | - | - |
| phone_number_verified | Returns true if the user's phone number is verified or false otherwise.Note: currently, all phone numbers are verified so this claim always returns true. |
All countries | - | - |
| address | User's postal address, represented as JSON Object containing some or all of these members: formatted street_address postal_code locality. |
Belgium | Netherlands | All other countries (except Belgium, Netherlands) |
| address_assurance_level | Indicates the level of assurance associated with the user's address claim, depending on whether the address is SELF_DECLARED (provided by the user without verification), VALIDATED (provided by the user and validated against a source), or VERIFIED (obtained from an official document). |
Belgium | Netherlands | All other countries (except Belgium, Netherlands) |
| http://itsme.services/v2/ claim/claim_citizenship |
User's nationality unaltered, exactly as mentioned on the ID document. | All countries | - | - |
SHALL: String (e.g. belge) (Belgium) | ||||
| http://itsme.services/v2/ claim/claim_citizenship_as_iso |
User's nationality. The format is always ISO 3166-1 alpha-3. | All other countries (except Belgium) | Belgium | - |
MAY NOT: Mapped by itsme on a best effort basis (Belgium) | ||||
| http://itsme.services/v2/ claim/place_of_birth |
User's place of birth, represented as a JSON Object containing some or all of these members formatted city country. |
- | Belgium | All other countries (except Belgium) |
| http://itsme.services/v2/ claim/BEeidSn |
User's Belgian ID document number, represented as a string with 12 digits in the form xxx-xxxxxxx-yy. (the check-number yy is the remainder of the division of xxxxxxxxxx by 97) for Belgian citizens, or starting with a letter and nine digits in the form B xxxxxxx xx for EU/EEA/Swiss citizens.Note: This claim is made redundant by the IDDocumentSN claim below which we advise to use instead. |
Belgium | - | All other countries (except Belgium) |
| http://itsme.services/v2/ claim/claim_device |
User's phone information, represented as a JSON Object containing some or all of these members os appName appRelease deviceLabel debugEnabled deviceID osRelease manufacturer deviceLockLevel rooted deviceModel. |
- | All countries | - |
| http://itsme.services/v2/ claim/BENationalNumber |
User's Belgian unique identification number, represented as a string with 11 digits in the form YYMMDDxxxcd where YY.MM.DD is the birthdate of the person, xxx a sequential number (odd for males and even for females) and cd a check-digit (Some exceptions could apply). | Belgium | - | All other countries (except Belgium) |
| http://itsme.services/v2/ claim/RONationalNumber |
User's Romanian unique identification number. | Romania | - | All other countries (except Romania) |
| http://itsme.services/v2/ claim/BGNationalNumber |
User's Bulgarian unique identification number. | Bulgaria | - | All other countries (except Bulgaria) |
| http://itsme.services/v2/ claim/CZNationalNumber |
User's Czech unique identification number. | Czech Republic | - | All other countries (except Czech Republic) |
| http://itsme.services/v2/ claim/SKNationalNumber |
User's Slovakian unique identification number. | Slovakia | - | All other countries (except Slovakia) |
| http://itsme.services/v2/ claim/HRNationalNumber |
User's Croatian unique identification number. | Croatia | - | All other countries (except Croatia) |
| http://itsme.services/v2/ claim/LTNationalNumber |
User's Lithuanian unique identification number. | Lithuania | - | All other countries (except Lithuania) |
| http://itsme.services/v2/ claim/SINationalNumber |
User's Slovenian unique identification number. | Slovenia | - | All other countries (except Slovenia) |
| http://itsme.services/v2/ claim/LVNationalNumber |
User's Latvian unique identification number. | Latvia | - | All other countries (except Latvia) |
| http://itsme.services/v2/ claim/MTNationalNumber |
User's Maltese unique identification number. | Malta | - | All other countries (except Malta) |
| http://itsme.services/v2/ claim/RSNationalNumber |
User's Serbian unique identification number. | Serbia | - | All other countries (except Serbia) |
| http://itsme.services/v2/ claim/MDNationalNumber |
User's Moldovan unique identification number. | Moldova | - | All other countries (except Moldova) |
| http://itsme.services/v2/ claim/validityFrom |
This is a metadata. User's Belgian ID document issuance date, represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format specified by ISO 8601. Can only be returned in combination with claims http://itsme.services/v2/claim/BEeidSn or http://itsme.services/v2/claim/IDDocumentSN. |
- | Belgium | All other countries (except Belgium) |
| http://itsme.services/v2/ claim/validityTo |
This is a metadata. User's Belgian ID card expiry date, represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format specified by ISO 8601. Can only be returned in combination with claims http://itsme.services/v2/claim/BEeidSn or http://itsme.services/v2/claim/IDDocumentSN. |
All other countries (except Belgium) | Belgium | - |
| http://itsme.services/v2/ claim/verificationDate |
This is a metadata. The date when the user's document was read for the last time, represented as a string in YYYY-MM-DDThh:mm:ss date format specified by ISO 8601. |
All other countries (except Belgium) | Belgium | - |
| http://itsme.services/v2/ claim/IDDocumentSN |
The ID document number, represented as a string. | All countries | - | - |
SHALL: A string with 12 digits formatted as xxx-xxxxxxx-yy (the check-number yy is the remainder of the division of xxxxxxxxxx by 97) for Belgian citizens, or starting with a letter and nine digits in the form B xxxxxxx xx for EU/EEA/Swiss citizens. (Belgium) | ||||
| http://itsme.services/v2/ claim/IDDocumentType |
The ID document type. This is a 1 or 2 characters code defined by the ICAO. Identity cards have a code with first letter I while passports have a code starting with P. |
All countries | - | - |
| http://itsme.services/v2/ claim/IDIssuingCountry |
This is a metadata. The 3-letters iso code of the country that issued the identity document used to create the itsme account. |
All countries | - | - |
| http://itsme.services/v2/ claim/issuance_locality |
This is a metadata. The locality that issued the ID document used to create the itsme account. |
- | Belgium | All other countries (except Belgium) |
| http://itsme.services/v2/ claim/app |
A JSON object with 3 members: appInstalledDate contains the date when the app was installed on the user's device, represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format specified by ISO 8601. appName contains the name of the app and appRelease contains a string identifying the release (example: "4.9.1").This claim is intended to help partners detect fraudulent use cases. |
All countries | - | - |
| http://itsme.services/v2/ claim/account |
A JSON object with 3 members: activationDate contains the date when the account was last activated (enrolled or unblocked), represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format specified by ISO 8601. activationMechanism contains a string identifying the way this account was created. Possible values are "CARD_READER" (enrollment via a physical reading of the ID document chip), "CONTACT_LESS" (enrollment via a NFC reading of the ID document) or "ID_PROVIDER" (enrollment via a trusted partner, i.e. a bank).This claim is intended to help partners detect fraudulent use cases. |
All countries | - | - |
| http://itsme.services/v2/ claim/identification_mode |
An indication of the way the user initiated the itsme transaction. Can contain "QR", "MSISDN" (i.e. phone number) or "a2a" (i.e. app to app flow). Other values can be added in the future. | All countries | - | - |
| http://itsme.services/v2/ claim/transaction_ip |
The IP address of the smartphone approving the transaction. This claim is intended to help partners detect fraudulent use cases. |
All countries | - | - |
| http://itsme.services/v2/ claim/ongoing_call |
Returns true if an ongoing call was detected during the action approval or false otherwise.This claim is intended to help partners detect fraudulent use cases. |
All countries | - | - |