Attribute reference

📘
Note:
itsme® may not return values for all attributes. Missing attributes are omitted from the JSON response.
For documents issued outside Belgium, only a subset of attributes may be returned. See the official claims documentation for full reference.

Available Attributes

Attribute	Sub-field (if applicable)	Example	Description
`name`	—	Jane Doe	Full name including first and last names, titles, and suffixes.
`firstName`	—	Jane	First name of the end-user.
`lastname`	—	Doe	Last name of the end-user.
`email`	—	[email protected]	Email address of the end-user.
`gender`	—	female	Biological sex: `female`, `male`, `unknown`, `n/a`. (Only `female` or `male` for Belgian users.)
`dateOfBirth`	—	1899-12-31	Birth date in `YYYY-MM-DD` format. itsme® users are 16+ years.
`locale`	—	en	Mobile device language: `nl`, `fr`, `de`, `en`.
`picture`	—	—	URL to ID document image.
`nin.value`	—	81042419835	National identity number.
`nin.type`	—	PERSON	Type of national identity number.
`nin.issuingCountry`	—	BE	Country issuing the identity number.
`phoneNumber`	—	+32 453519681	E.164 format: `[+][country_code] [number]`
`address`	—	Rue Royale 82 1000 Bruxelles	May include street, postal code, and city.
`nationality`	—	NLD	String or ISO 3166-1 alpha-3 format, depending on document.
`placeOfBirth`	—	Bruxelles	City of birth.
`countryOfBirth`	—	—	Country of birth.
`itsmeEid`	—	123-4567890-02	Document number. Format depends on country: - Belgium: `xxx-xxxxxxx-yy` (12-digit with check digit) - EU/EEA/CH: starts with a letter and 9 digits (`B xxxxxxx xx`)
`itsmeIssuanceLocality`	—	—	Place where the ID was issued.
`itsmeValidityFrom`	—	1899-01-31T00:00:00+00Z	ID issue date in ISO 8601 format.
`itsmeValidityTo`	—	1899-01-31T00:00:00+00Z	ID expiry date in ISO 8601 format.
`itsmeReadDate`	—	1899-01-31T00:00:00+00Z	Last read date of the ID (ISO 8601 format).
`itsmeNationalNumber`	—	860224 025 08	Belgian Rijksregisternummer: `YY.MM.DD-xxx.cd` where: - `YY.MM.DD` = birthdate - `xxx` = sequence (odd: male, even: female) - `cd` = check digit
`itsmeOs`	—	iOS	Operating system: `ANDROID` or `iOS`.
`itsmeAppName`	—	—	App name.
`itsmeAppRelease`	—	—	App release version.
`itsmeDeviceLabel`	—	—	Device name.
`itsmeDebugEnabled`	—	false	`true` if debug mode is on.
`itsmeDeviceId`	—	—	Device ID.
`itsmeOsRelease`	—	—	OS version.
`itsmeManufacturer`	—	—	Device manufacturer.
`itsmeDeviceLockLevel`	—	—	Lock level of the device.
`itsmeSmsEnabled`	—	true	`true` if device can send SMS. (iOS = iPhone)
`itsmeRooted`	—	false	Always returns `false`.
`itsmeImei`	—	—	IMEI number.
`itsmeDeviceModel`	—	iPhone 7	Device model.
`itsmeSdkRelease`	—	—	SDK version on the device.