itsme® may not return values for some of the attributes. When an attribute is not returned, the corresponding data is omitted from the JSON object of the response. itsme® returns a subset of the data for documents issued in countries other than Belgium.
Attribute | Sub-field (response) | Example | Description |
name | Jane Doe | Full name of the end-user including first name, last name, titles and suffixes. | |
firstName | Jane | First name of the end-user. | |
lastname | Doe | Last name of the end-user. | |
email | Email address of the end-user. | ||
gender | female | Biological sex of the end-user. Possible values are : female, male, unknown, n/a. Note that for Belgian end-users only female or male values are available. | |
dateOfBirth | 1899-12-31 | Date of birth of the end-user represented as a string in YYYY-MM-DD date format. itsme® users are always 16 years old or older. | |
locale | en | End-user mobile phone language in string format. Available values are: nl, fr, de, en. | |
picture | URL pointing to a picture on the ID document of the end-user. The URL refers to an image file. | ||
nin | value | 81042419835 | The national identity number of the end-user. |
type | PERSON | The type of national identity number. | |
issuingCountry | BE | The country issuing the identity number. | |
email | Email address of the end-user. | ||
phoneNumber | +32 453519681 | Phone number of the end-user represented as a string with format [+][country_code] [number]. | |
address | Rue Royale 82 1000 Bruxelles | Postal address of the end-user. A string containing some (or all of) these fields: [street_address] [postal_code] [locality]. | |
nationality | Nationality of the end-user. The format depends on the ID document: for Belgian ID documents this is a string; for Dutch ID documents this is in the ISO 3166-1 alpha-3 format. | ||
placeOfBirth | Bruxelles | Place of birth of end-user. | |
countryOfBirth | Country of birth of end-user. | ||
itsmeEid | 123-4567890-02 | ID document number. Differences apply per country. | |
itsmeIssuanceLocality | Place where the ID document was issued. | ||
itsmeValidityFrom | 1899-01-31T00:00:00+00Z | Belgian ID document issuance date, represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format specified by ISO 8601. | |
itsmeValidityTo | 1899-01-31T00:00:00+00Z | Belgian ID card expiry date, represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format specified by ISO 8601. | |
itsmeReadDate | 1899-01-31T00:00:00+00Z | The date when the end-user's document was read for the last time, represented as a string in YYYY-MM-DDThh:mm:ss.nnnZ date format, specified by ISO 8601. | |
itsmeNationalNumber | 860224 025 08 | National registration number ( "Rijksregisternummer") is the unique identification number of natural persons registered in Belgium. It comprises 11 digits in the form YY.MM.DD-xxx.cd where YY.MM.DD is the date of birth, xxx is a sequential number (odd for males and even for females) and cd a check-digit. | |
itsmeOs | iOS | The device operating system. Available values are "ANDROID" or "iOS". | |
itsmeAppName | The application name. | ||
itsmeAppRelease | The application current release. | ||
itsmeDeviceLabel | The name of the device. | ||
itsmeDebugEnabled | false | Boolean that specifies whether debug mode is activated. | |
itsmeDeviceId | Device identifier. | ||
itsmeOsRelease | The version of the OS running on the device. | ||
itsmeManufacturer | The brand of the device manufacturer. | ||
itsmeDeviceLockLevel | Device lock level. | ||
itsmeSmsEnabled | true | True if device can send an SMS. On iOS, this means it’s an iPhone. | |
itsmeRooted | false | Specifies if it is a rooted device. This value is always false. | |
itsmeImei | IMEI number of device. | ||
itsmeDeviceModel | iPhone 7 | The model of the device. | |
itsmeSdkRelease | Version of SDK on device. |