Attributes reference

You use .beID to verify the end-user's identity and obtain relevant personal details about them. This page summarises the user information you can request and receive for the different protocols.

Since we recommend either using OIDC or the Authentication REST API, we only show information for those two protocols below.

Note

Data availability varies depending on the type of account you are using.

• In a sandbox account, you can test your integration with all available attributes.
• In a production account, certain attributes may be restricted by GDPR regulations or subject to specific legislation. In such cases, you must apply for additional authorisation.

For additional information, contact us.

National identity number

Use of the Belgian RRN (national identity number) is subject to specific legislation. For certain uses, you must obtain specific authorisation by FOD/SPF IBZ. For more details, refer to the applicable laws (for example, this one or other updated, applicable laws).

OIDC scopes and claims

You can use the following scopes to request user information from an end-user using .beID:

Response example

The response example below shows the section with the user information claims.

Scope: openid profile idp nin address nationality

{
	"idp_id":"98082100029",
	"name":"Nora Martens",
	"family_name":"Martens",
	"given_name":"Nora Martens",
	"gender":"FEMALE",
	"birthdate":"1990-02-17",
	"address":{"formatted":"Specimenstraat 12,1000,Brussel"},
	"nationality":"BELG",
	"nin":"90021700029",
	"nin_type":"PERSON",
	"nin_issuing_country":"BE",
	"beid_card_delivery_municipality":"Brussel",
	"beid_birth_location":"Leuven",
	"beid_validity_date_begin":"2017-05-30",
	"beid_validity_date_end":"2027-05-30",
	"beid_document_type":"belgian_citizen",
	"beid_card_number":"000001110749",
	"sub":"fIZvCR6CX9wh3Ut-PpDU-q9e9E67pb-vkEpzLiSDVkw=",
	"idp_issuer":"be-smartcard"
	}

Authentication REST API attributes

The Signicat Authentication REST API supports the following request and response attributes for .beID:

Response example

Here is a response example from the Authentication REST API:

{
    "id": "d728f7f2-9791-2743-815f-04bee72e30ad",
    "accountId": "a-sdge-...",
    "authenticationUrl": "https://<YOUR_SIGNICAT_DOMAIN>/broker/sp/external-service/login?messageId=f044eef9-9571-4941-b06f-d98a0615cf6c&transactionId=d728f7f2-9791-2743-815f-04bee72e30ad",
    "status": "SUCCESS",
    "provider": "be-smartcard",
    "subject": {
        "id": "9P3Hfs-WdctMxpl-slH27DYO0gArxT-JpWGm9AleWfQ=",
        "idpId": "90021700029",
        "name": "Nora Martens",
        "firstName": "Nora Martens",
        "middleName": "",
        "lastName": "Specimen",
        "dateOfBirth": "1990-02-17",
        "nin": {
            "value": "90021700029",
            "issuingCountry": "BE",
            "type": "PERSON"
        },
        "beidCardDeliveryMunicipality": "Brussel",
        "beidBirthLocation": "Leuven",
        "address": "Specimenstraat 12,1000,Brussel",
        "beidValidityDateBegin": "2017-05-30",
        "beidDocumentType": "belgian_citizen",
        "nationality": "BELG",
        "beidCardNumber": "000001110749",
        "beidValidityDateEnd": "2027-05-30"
    },
    "callbackUrls": {
        "success": "https://example.com/success?sessionId=58126fb8-c5e2...",
        "abort": "https://example.com/abort?sessionId=58126fb8-c5e2...",
        "error": "https://example.com/error?sessionId=58126fb8-c5e2..."
    },
    "environment": {
        "ipAddress": "123.45.67.899",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"
    },
    "allowedProviders": [
        "beid"
    ],
    "flow": "redirect",
    "requestedAttributes": [
        "address",
        "beidBirthLocation",
        "beidCardDeliveryMunicipality",
        "beidCardNumber",
        "beidDocumentType",
        "beidValidityDateBegin",
        "beidValidityDateEnd",
        "dateOfBirth",
        "firstName",
        "gender",
        "lastName",
        "middleName",
        "name",
        "nationality",
        "nin",
        "idpId"
    ],
    "sessionLifetime": 1200
}