Sample structures of the E_KYC_CHECK API responses for Belgium itsme Verification (bene_gov_itsme_idv).
GREEN
The following response example represents successful checks.
{
"checks": [
{
"answer": "GREEN",
"checkType": "E_KYC_CHECK",
"createdAt": "2026-09-10 12:35:32",
"id": "90c0cee9-bfb7-4f18-9832-9e53bb167b96",
"sourceInfo": {
"id": "bene_gov_itsme_idv"
},
"inputDoc": {
"idDocType": "OTHER",
"country": "BEL"
},
"extractedDoc": {
"country": "BEL",
"firstName": "Louis",
"lastName": "Peeters",
"gender": "M",
"dob": "1997-02-16",
"addresses": [
{
"street": "Rue Brederode 16",
"town": "Bruxelles",
"postCode": "1000",
"country": "BEL",
"formattedAddress": "Rue Brederode 16, Bruxelles, Belgium, 1000",
"source": "externalDb"
}
],
"placeOfBirth": "Bruxelles",
"nationality": "BEL",
"images": [
{
"imageId": 1347622540
}
],
"additionalFields": [
{
"name": "restrictedId",
"value": "e985baa4f8248223f2f454ae39a4e7a9f04fef1d86d79b8d46fe2bdfd18204b5"
},
{
"name": "schemeSub",
"value": "mln5kfxtrf6wpi05fe1aa5qxwo86y87gv4kh"
},
{
"name": "officialGender",
"value": "M"
},
{
"name": "levelOfAssurance",
"value": "HIGH"
}
],
"additionalDocs": [
{
"country": "BEL",
"idDocType": "ID_CARD",
"number": "567663202670",
"issueDate": "2025-02-24",
"validUntil": "2030-02-24"
}
]
},
"ekycCheckInfo": {
"confirmationId": "6a4kIS993PEmXZpmCoHUawAA",
"confirmationType": "oAuth"
}
}
]
}YELLOW
The following example illustrates a case where the verification process is still in progress and the applicant has not yet completed all required steps.
{
"checks": [
{
"answer": "YELLOW",
"checkType": "E_KYC_CHECK",
"createdAt": "2025-11-06 21:39:24",
"id": "faf3469c-7320-4533-8d78-901072fb8f5b",
"sourceInfo": {
"id": "bene_gov_itsme_idv"
},
"inputDoc": {
"idDocType": "OTHER",
"country": "BEL"
},
"ekycCheckInfo": {
"confirmationId": "TX0zGu2IT6YQYkMcMXTYorh8",
"confirmationType": "oAuth"
}
}
]
}ERROR
The following example represents a case when an error occurred during the check.
{
"checks": [
{
"answer": "ERROR",
"checkType": "E_KYC_CHECK",
"createdAt": "2026-07-01 10:12:12",
"id": "gbg4570d-8431-3422-9g89-570226ac9sto",
"sourceInfo": {
"id": "bene_gov_itsme_idv"
},
"inputDoc": {
"idDocType": "OTHER",
"country": "BEL"
},
"ekycCheckInfo": {}
}
]
}Response explained
The response represents a list of checks.
NoteFor the complete common response structure, see the parent page. The sections below describe details specific to Belgium itsme Verification (bene_gov_itsme_idv).
additionalFields element fields
additionalFields element fieldsAn array of key-value pairs providing non-standard additional information. The following table explains the possible keys.
| Field | Type | Description |
|---|---|---|
restrictedId | String | Hashed national identification number. |
schemeSub | String | Subject ID — uniquely identifies a given itsme® user account. |
officialGender | String | Returns unaltered gender exactly as printed on the user's identity document. |
levelOfAssurance | String | Level of Assurance. The only possible value is HIGH. |
additionalDocs element fields
additionalDocs element fieldsProvides information about the ID document used to create the user's itsme® account.
| Field | Type | Description |
|---|---|---|
country | String | Alpha-3 country code (for example, DEU, GBR, ARG). |
idDocType | String | Type of the identification number or document, retrieved from the external source:
|
number | String | Identification number. |
issueDate | Date | Date when the identity document was issued (format YYYY-MM-DD). |
validUntil | Date | Date when the document validity expires (format YYYY-MM-DD). |