Schemas
Income document
Schema: https://schema.org/government-documents#income-document
Set of data that can be collected from Driver's license
| Property | Type | Description | Required |
|---|---|---|---|
| fullName | string | Yes | |
| documentDate | string | Yes | |
| incomeYear | number | Can be null when field is not available in IB60 document | Yes |
| documentContent | string | Full, raw base64-encoded document containing income data, request only when necessary for compliance | Yes |
| annualIncome | number | Can be null when field is not available in IB60 document | Yes |
IDIN information
Schema: https://schema.org/government-documents#idin
Set of personal data that can be collected from IDIN system
| Property | Type | Description | Required |
|---|---|---|---|
| initial | string | Yes | |
| lastName | string | Yes | |
| dateOfBirth | string | Yes | |
| gender | string (M/F/UNKNOWN) | Yes | |
| string | Yes | ||
| phoneNumber | string | Yes | |
| houseNumber | string | Yes | |
| street | string | Yes | |
| city | string | Yes | |
| postalCode | string | Yes | |
| country | string | Yes | |
| infix | string | Yes |
DUO - Student loan information
Schema: https://schema.org/government-documents#duo
Set of data that can be collected from DUO
| Property | Type | Description | Required |
|---|---|---|---|
| firstName | string | Yes | |
| lastName | string | Yes | |
| infix | string | Can be null | Yes |
| debtStartingDate | string | Can be null | Yes |
| debtStartingAmount | object | Can be null | Yes |
| debtRemainingAmount | object | Can be null | Yes |
| debtRemainingMonthsToRepay | number | Can be null | Yes |
| debtPauseMonthsRemaining | string | Can be null | Yes |
| debtCurrentInterestRate | string | Can be null | Yes |
| debtActualityDate | string | Can be null | Yes |
| retrievedDate | string | Yes | |
| studies | array | Can be null | Yes |
debtStartingAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
debtRemainingAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
studies
| Property | Type | Description | Required |
|---|---|---|---|
| institutionName | string | No | |
| registrationStartDate | string | No | |
| registrationEndDate | string | No | |
| educationForm | string (VT/DT) | No | |
| courseFullName | string | No | |
| studyLevel | string | No | |
| studyType | string (MBO/HBO/WO) | No |
Driver's license
Schema: https://schema.org/government-documents#drivers-license
Set of data that can be collected from Driver's license
| Property | Type | Description | Required |
|---|---|---|---|
| documentName | string | Yes | |
| dateOfBirth | string | Yes | |
| dateOfExpiry | string | Yes | |
| documentNumber | string | Yes | |
| issuingCountry | string | Yes | |
| firstName | string | Yes | |
| lastName | string | Yes | |
| base64Image | string | Yes | |
| base64FrontSideImage | string | Yes | |
| base64BackSideImage | string | Yes | |
| dataSource | string (NFC/OCR) | Yes | |
| placeOfBirth | string | Yes | |
| dateOfIssuance | string | Yes | |
| categoryList | array | Yes |
categoryList
| Property | Type | Description | Required |
|---|---|---|---|
| categoryName | string | No | |
| dateOfIssuance | string | Yes | |
| dateOfExpiry | string | Yes |
ID card Liveness Check
Schema: https://schema.org/government-documents#id-card-liveness-check
Set of data that can be collected from ID card of a person
| Property | Type | Description | Required |
|---|---|---|---|
| documentName | string | Yes | |
| documentCode | string | Yes | |
| dateOfBirth | string | Yes | |
| dateOfExpiry | string | Yes | |
| documentNumber | string | Yes | |
| issuingCountry | string | Yes | |
| firstName | string | Yes | |
| lastName | string | Yes | |
| base64Image | string | Yes | |
| base64FrontSideImage | string | Yes | |
| base64BackSideImage | string | Yes | |
| dataSource | string (NFC/OCR) | Yes | |
| gender | string (M/F/UNKNOWN) | Yes | |
| nationality | string | Yes | |
| livenessCheck | object | Yes |
livenessCheck
| Property | Type | Description | Required |
|---|---|---|---|
| assuranceType | string | No | |
| passed | boolean | No |
Working history report
Schema: https://schema.org/government-documents#working-history-document
Financial report originate from UWV
| Property | Type | Description | Required |
|---|---|---|---|
| initial | string | No | |
| infix | string | No | |
| surname | string | The surname of the individual. An empty field may indicate no recorded working history or an error in data retrieval. | No |
| dateOfBirth | string | The individual's date of birth. An empty field may indicate no recorded working history or an error in data retrieval. | No |
| documentDate | string | No | |
| yearsOfBenefit | array | List with the years of benefit (aantal jaren uitkering) and its percentage (100.0 = ja, 0.0 = nee). In the UWV document it is shown as ja/nee, but in the XML is 100.0 or 0.0. We have decided to keep same as XML to not perform parses | No |
| documentContent | string | Full, raw base64-encoded document containing working history data, request only when necessary for compliance | Yes |
| ^income-[0-9]6$ | array | No | |
| ^income-[0-9]4$ | object | No |
yearsOfBenefit
| Property | Type | Description | Required |
|---|---|---|---|
| year | string | No | |
| percentage | string | No |
^income-[0-9]6$
| Property | Type | Description | Required |
|---|---|---|---|
| startDate | string | No | |
| endDate | string | No | |
| organization | string | No | |
| taxableIncome | object | No | |
| totalHoursWorked | number | No | |
| taxAdditionCar | object | No | |
| personalContributionCar | object | No | |
| isPermanentContract | boolean | No | |
| isPhysicalContract | boolean | No | |
| isCallAgreement | boolean | No | |
| payrollTaxNumber | string | String representing the payrollTaxNumber (Loonheffingsnummer) of an employee for a given contract. E.g. 123456789L01 | No |
| insuredUnderWIALaw | boolean | No | |
| insuredUnderWWLaw | boolean | No | |
| insuredUnderZWLaw | boolean | No |
taxableIncome
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
taxAdditionCar
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
personalContributionCar
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
^income-[0-9]4$
| Property | Type | Description | Required |
|---|---|---|---|
| ^income-[0-9]6$ | array | No |
^income-[0-9]6$
| Property | Type | Description | Required |
|---|---|---|---|
| startDate | string | No | |
| endDate | string | No | |
| organization | string | No | |
| taxableIncome | object | No | |
| totalHoursWorked | number | No | |
| taxAdditionCar | object | No | |
| personalContributionCar | object | No | |
| isPermanentContract | boolean | No | |
| isPhysicalContract | boolean | No | |
| isCallAgreement | boolean | No |
taxableIncome
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
taxAdditionCar
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
personalContributionCar
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
IBL report
Schema: https://schema.org/government-documents#ibl-income
IBL income originate from UWV
| Property | Type | Description | Required |
|---|---|---|---|
| initial | string | No | |
| infix | string | No | |
| surname | string | Yes | |
| dateOfBirth | string | Yes | |
| calculationEnumeration | string (A/B/C/D) | No | |
| iblCalculationOutput | string | Base64 encoded json response from the IBL API, since the API does not return a document from IBL which is required for compliance reasons. The json response acts as a proof of output. | No |
| retrievedDate | string | Yes | |
| documentContent | string | UWV source document blob, base64-encoded string to be used for IBL calculation, request only when necessary for compliance | Yes |
| pensionContribution | object | Yes | |
| monthlyIncome | array | Yes | |
| verification | object | Yes | |
| svLoon | object | The calculated year income | Yes |
| calculationOutcome | string (FULL_CALCULATION/NO_ELIGIBLE_CONTRACTS) | Yes |
pensionContribution
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
monthlyIncome
| Property | Type | Description | Required |
|---|---|---|---|
| calculation | string | No | |
| employer | string | No | |
| contractType | string | IBL string that is created based on these UWV booleans: isPermanentContract, isPhysicalContract, and isCallAgreement | No |
| testIncome | object | No | |
| wageItems | array | No |
testIncome
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
wageItems
| Property | Type | Description | Required |
|---|---|---|---|
| originalIncome | object | No | |
| mitigatedIncome | object | No |
originalIncome
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
mitigatedIncome
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
verification
| Property | Type | Description | Required |
|---|---|---|---|
| isPDFSignValid | boolean | No | |
| isPDFSignNotOlderThan3Months | boolean | No | |
| isPDFSignStillValidAtLeast3Weeks | boolean | No | |
| PDFSignDate | string | No | |
| verificationCode | string | This field is used to verify whether the authentic IBL calculator was used | No |
| PDFSignatureHash | string | No | |
| IBLAPIVersion | string | No |
svLoon
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
ID card
Schema: https://schema.org/government-documents#id-card
Set of data that can be collected from ID card of a person
| Property | Type | Description | Required |
|---|---|---|---|
| documentName | string | Yes | |
| documentCode | string | Yes | |
| dateOfBirth | string | Yes | |
| dateOfExpiry | string | Yes | |
| documentNumber | string | Yes | |
| issuingCountry | string | Yes | |
| firstName | string | Yes | |
| lastName | string | Yes | |
| base64Image | string | Yes | |
| base64FrontSideImage | string | Yes | |
| base64BackSideImage | string | Yes | |
| dataSource | string (NFC/OCR) | Yes | |
| gender | string (M/F/UNKNOWN) | Yes | |
| nationality | string | Yes |
Pension
Schema: https://schema.org/government-documents#pension-document
Set of data that can be collected from the pension of a person
| Property | Type | Description | Required |
|---|---|---|---|
| fullName | string | Yes | |
| documentName | string | Yes | |
| dateOfBirth | string | Yes | |
| documentDate | string | Yes | |
| pensionTotal | object | Yes | |
| pensionDetails | object | Yes | |
| missingData | boolean | Yes | |
| pdfContent | string | Full, raw base64-encoded MijnPensioenOverzicht pdf containing pension data | Yes |
pensionTotal
| Property | Type | Description | Required |
|---|---|---|---|
| ^.*$ | array | No |
^.*$
| Property | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| startingAge | string | No | |
| endingAge | string | No | |
| startAge | object | No | |
| endAge | object | No | |
| amountDetails | array | No |
startAge
| Property | Type | Description | Required |
|---|---|---|---|
| year | string | No | |
| month | string | No | |
| condition | string | No |
endAge
| Property | Type | Description | Required |
|---|---|---|---|
| year | string | No | |
| month | string | No | |
| condition | string | No |
amountDetails
| Property | Type | Description | Required |
|---|---|---|---|
| title | string | No | |
| description | string | No | |
| amounts | array | No |
amounts
| Property | Type | Description | Required |
|---|---|---|---|
| title | string | No | |
| amount | string | No |
pensionDetails
| Property | Type | Description | Required |
|---|---|---|---|
| ^.*$ | array | No |
^.*$
| Property | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| startingAge | string | No | |
| endingAge | string | No | |
| startAge | object | No | |
| endAge | object | No | |
| AOW | object | No | |
| pensioen | array | No | |
| indicatiefPensioen | array | No | |
| nettoPensioen | array | No | |
| nettoindicatiefPensioen | array | No | |
| alleenstaandenPensioen | array | No | |
| pensioenUitkering | array | No | |
| partnerPensioenUitkering | array | No | |
| orphanPensioenUitkering | array | No |
startAge
| Property | Type | Description | Required |
|---|---|---|---|
| year | string | No | |
| month | string | No | |
| condition | string | No |
endAge
| Property | Type | Description | Required |
|---|---|---|---|
| year | string | No | |
| month | string | No | |
| condition | string | No |
AOW
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| AOWDetailsOpbouw | object | No | |
| AOWDetailsUitkering | object | No |
AOWDetailsOpbouw
| Property | Type | Description | Required |
|---|---|---|---|
| teBereikenSamenwonend | string | No | |
| opgebouwdSamenwonend | string | No | |
| teBereikenAlleenstaand | string | No | |
| opgebouwdAlleenstaand | string | No |
AOWDetailsUitkering
| Property | Type | Description | Required |
|---|---|---|---|
| uitkeringSamenwonend | string | No | |
| uitkeringAlleenstaand | string | No |
pensioen
| Property | Type | Description | Required |
|---|---|---|---|
| teBereiken | string | No | |
| opgebouwd | string | No | |
| afhandelingVerevening | string | No | |
| afhandelingScheiding | string | No | |
| exPartnerBedrag | string | No | |
| perKind | string | No | |
| pensioenUitvoerder | string | No | |
| herkenningsNummer | string | No | |
| standPer | string | No | |
| amounts | array | No |
amounts
| Property | Type | Description | Required |
|---|---|---|---|
| title | string | No | |
| amount | string | No |
indicatiefPensioen
| Property | Type | Description | Required |
|---|---|---|---|
| teBereiken | string | No | |
| opgebouwd | string | No | |
| afhandelingVerevening | string | No | |
| afhandelingScheiding | string | No | |
| perKind | string | No | |
| pensioenUitvoerder | string | No | |
| herkenningsNummer | string | No | |
| standPer | string | No | |
| amounts | array | No |
amounts
| Property | Type | Description | Required |
|---|---|---|---|
| title | string | No | |
| amount | string | No |
nettoPensioen
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| pensioenUitvoerder | string | No | |
| herkenningsNummer | string | No | |
| teBereiken | string | No | |
| opgebouwd | string | No | |
| afhandelingVerevening | string | No |
nettoindicatiefPensioen
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| pensioenUitvoerder | string | No | |
| herkenningsNummer | string | No | |
| afhandelingScheiding | string | No | |
| amounts | array | No |
amounts
| Property | Type | Description | Required |
|---|---|---|---|
| title | string | No | |
| amount | string | No |
alleenstaandenPensioen
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| pensioenUitvoerder | string | No | |
| herkenningsNummer | string | No | |
| teBereiken | string | No | |
| opgebouwd | string | No | |
| afhandelingVerevening | string | No |
pensioenUitkering
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| pensioenUitvoerder | string | No | |
| uitkering | number | No | |
| herkenningsNummer | string | No |
partnerPensioenUitkering
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| pensioenUitvoerder | string | No | |
| uitkering | number | No | |
| herkenningsNummer | string | No |
orphanPensioenUitkering
| Property | Type | Description | Required |
|---|---|---|---|
| standPer | string | No | |
| pensioenUitvoerder | string | No | |
| uitkering | number | No | |
| herkenningsNummer | string | No |
BRP - basic person registration information
Schema: https://schema.org/government-documents#myNlGovernment
Set of data that can be collected from Mijn Overheid
| Property | Type | Description | Required |
|---|---|---|---|
| firstName | string | Yes | |
| lastName | string | Yes | |
| infix | string | Yes | |
| gender | string (M/F/UNKNOWN) | Yes | |
| dateOfBirth | string | Yes | |
| placeOfBirth | string | Yes | |
| numberOfResidents | number | Yes | |
| countryOfBirth | string | Yes | |
| streetAndHouseNumber | string | Yes | |
| postalCode | string | Yes | |
| municipality | string | Yes | |
| addressRegistrationDate | string | Yes | |
| previousAddress | array | Yes | |
| partner | object | No | |
| previousPartners | array | No | |
| nationality | array | No | |
| idDocumentation | array | No |
previousAddress
| Property | Type | Description | Required |
|---|---|---|---|
| streetAndHouseNumber | string | Yes | |
| postalCode | string | Yes | |
| municipality | string | Yes | |
| addressRegistrationDate | string | Yes |
partner
| Property | Type | Description | Required |
|---|---|---|---|
| partnershipType | string | Represents the relationship type e.g. married, registered partnership, cohabitation agreement or living together without an agreement. | No |
| partnershipEndDate | string | No |
previousPartners
| Property | Type | Description | Required |
|---|---|---|---|
| partnershipType | string | Represents the relationship type e.g. married, registered partnership, cohabitation agreement or living together without an agreement. | No |
| partnershipEndDate | string | No |
nationality
| Property | Type | Description | Required |
|---|---|---|---|
| nationality | string | No | |
| nationalityReason | string | Reason for adding/terminating nationality | No |
| startingDate | string | No |
idDocumentation
| Property | Type | Description | Required |
|---|---|---|---|
| documentType | string | Represents the id document used e.g. id card, passport etc. | No |
| documentNumber | string | No | |
| expiryDate | string | No |
Phone number
Schema: https://schema.org/government-documents#phone-number
Adds a verified phone number
| Property | Type | Description | Required |
|---|---|---|---|
| phoneNumber | string | Yes |
Passport
Schema: https://schema.org/government-documents#passport
Set of data that can be collected from Passport of a person
| Property | Type | Description | Required |
|---|---|---|---|
| documentName | string | Yes | |
| documentCode | string | Yes | |
| dateOfBirth | string | Yes | |
| dateOfExpiry | string | Yes | |
| documentNumber | string | Yes | |
| issuingCountry | string | Yes | |
| firstName | string | Yes | |
| lastName | string | Yes | |
| base64Image | string | Yes | |
| base64FrontSideImage | string | Yes | |
| base64BackSideImage | string | Yes | |
| dataSource | string (NFC/OCR) | Yes | |
| gender | string (M/F/UNKNOWN) | Yes | |
| nationality | string | Yes |
IBAN
Schema: https://schema.org/government-documents#iban
Provides information about bank account number and holder
| Property | Type | Description | Required |
|---|---|---|---|
| IBAN | string | Yes | |
| AccountHolderName | string | Yes |
Liveness check
Schema: https://schema.org/government-documents#liveness-check
Contains document number based on which Liveness check for proved
| Property | Type | Description | Required |
|---|---|---|---|
| documentNumber | string | Yes |
Passport Liveness Check
Schema: https://schema.org/government-documents#passport-liveness-check
Set of data that can be collected from Passport of a person and Liveness Check
| Property | Type | Description | Required |
|---|---|---|---|
| documentName | string | Yes | |
| documentCode | string | Yes | |
| dateOfBirth | string | Yes | |
| dateOfExpiry | string | Yes | |
| documentNumber | string | Yes | |
| issuingCountry | string | Yes | |
| firstName | string | Yes | |
| lastName | string | Yes | |
| base64Image | string | Yes | |
| base64FrontSideImage | string | Yes | |
| base64BackSideImage | string | No | |
| dataSource | string (NFC/OCR) | Yes | |
| gender | string (M/F/UNKNOWN) | Yes | |
| nationality | string | Yes | |
| livenessCheck | object | Yes |
livenessCheck
| Property | Type | Description | Required |
|---|---|---|---|
| assuranceType | string | No | |
| passed | boolean | No |
Authentication
Schema: https://schema.org/government-documents#authentication
Authentication process
| Property | Type | Description | Required |
|---|---|---|---|
| token | string | Yes |
Pre filled tax info document
Schema: https://schema.org/government-documents#pre-filled-tax-info
Set of data extracted from Belastingdienst website that contains information about financial state of a person
| Property | Type | Description | Required |
|---|---|---|---|
| taxYear | number | Yes | |
| initialAndLastName | string | Yes | |
| dateOfBirth | string | No | |
| incomes | object | Yes | |
| realEstate | array | Yes | |
| assets | object | Yes | |
| debts | array | Yes | |
| relationships | array | Yes |
incomes
| Property | Type | Description | Required |
|---|---|---|---|
| workIncomes | array | No | |
| benefits | array | No | |
| foreignBenefits | array | No | |
| lumpSums | array | No | |
| staffLoans | array | No |
workIncomes
| Property | Type | Description | Required |
|---|---|---|---|
| employer | string | No | |
| sivCode | string | Code soort inkomstenverhouding (SIV) | No |
| salary | object | No | |
| travelAllowance | object | No |
salary
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
travelAllowance
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
benefits
| Property | Type | Description | Required |
|---|---|---|---|
| organisationName | string | No | |
| amount | object | No |
amount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
foreignBenefits
| Property | Type | Description | Required |
|---|---|---|---|
| country | string | No | |
| organisationName | string | No | |
| amount | object | No |
amount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lumpSums
| Property | Type | Description | Required |
|---|---|---|---|
| insurerName | string | No | |
| lumpSumAmount | object | No | |
| lumpSumAmountLH | object | The amount you receive in one payment if you choose to cash in your annuity | No |
lumpSumAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lumpSumAmountLH
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
staffLoans
| Property | Type | Description | Required |
|---|---|---|---|
| employer | string | No | |
| amount | object | No |
amount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
realEstate
| Property | Type | Description | Required |
|---|---|---|---|
| wozValue | object | No | |
| wozAddress | string | No |
wozValue
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
assets
| Property | Type | Description | Required |
|---|---|---|---|
| bankAccounts | object | No | |
| securities | object | No | |
| insuredCapitals | object | No | |
| deposits | object | No |
bankAccounts
| Property | Type | Description | Required |
|---|---|---|---|
| accountNumber | string | No | |
| accountName | string | No | |
| amount | object | No | |
| accountBalance | object | No | |
| accountBalanceBox3Savings | object | No |
amount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
accountBalance
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
accountBalanceBox3Savings
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
securities
| Property | Type | Description | Required |
|---|---|---|---|
| investmentAccountNumber | string | No | |
| bankName | string | No | |
| amount | object | No |
amount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
insuredCapitals
| Property | Type | Description | Required |
|---|---|---|---|
| insurancePolicyNumber | string | No | |
| insuredAmount | object | No |
insuredAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
deposits
| Property | Type | Description | Required |
|---|---|---|---|
| depositPolicyNumber | string | No | |
| amount | object | No |
amount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
debts
| Property | Type | Description | Required |
|---|---|---|---|
| bankProductName | string | No | |
| bankAccountType | string | No | |
| isMortgage | boolean | No | |
| isAnnuity | boolean | No | |
| initialAmount | object | No | |
| finalAmount | object | No | |
| interestAmount | object | No | |
| description | string | No | |
| loanNumber | string | No | |
| isLoanAnnuity | boolean | No | |
| initials | string | No | |
| name | string | No |
initialAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
finalAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
interestAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
relationships
| Property | Type | Description | Required |
|---|---|---|---|
| relationshipCode | string (01 \| 02 \| 03 \| 04) | 01: It is a child of the taxpayer; 02: Married to partner or in a registered partnership; 03: Cohabiting and fiscal partnership based on fiscal partnership in the previous year; 04: Cohabiting and fiscal partnership based on parenthood. | No |
| fullName | string | No | |
| dateOfBirth | string | No |
Schema: https://schema.org/government-documents#email
Adds a verified email address
| Property | Type | Description | Required |
|---|---|---|---|
| string | Yes |
Housing costs report
Schema: https://schema.org/government-documents#housing-costs
Financial report generated by CreditEstimate service
| Property | Type | Description | Required |
|---|---|---|---|
| AccountHolderName | string | No | |
| IBAN | string | No | |
| fullReport | array | No | |
| mortgage | array | No | |
| rent | array | No | |
| vve | array | No |
fullReport
| Property | Type | Description | Required |
|---|---|---|---|
| averageAmount | object | No | |
| category | string | Can be 'rent', 'vve' or 'mortgage' | No |
| consistency | number | No | |
| timeConsistency | number | No | |
| amountConsistency | number | No | |
| counterpartyIban | string | No | |
| counterpartyName | string | No | |
| endDate | string | No | |
| title | string | No | |
| lastAmount | object | No | |
| periodicity | string (w/bw/m/bm/ha/a/q/4w/no_periodicity) | No | |
| startDate | string | No | |
| transactions | array | No |
averageAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lastAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
transactions
| Property | Type | Description | Required |
|---|---|---|---|
| accountId | string | No | |
| description | string | No | |
| transactionTime | string | No | |
| transactionValue | object | No |
transactionValue
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
mortgage
| Property | Type | Description | Required |
|---|---|---|---|
| averageAmount | object | No | |
| category | string | Can be 'rent', 'vve' or 'mortgage' | No |
| consistency | number | No | |
| timeConsistency | number | No | |
| amountConsistency | number | No | |
| counterpartyName | string | No | |
| endDate | string | No | |
| lastAmount | object | No | |
| periodicity | string (w/bw/m/bm/ha/a/q/4w/no_periodicity) | No | |
| startDate | string | No | |
| title | string | No |
averageAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lastAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
rent
| Property | Type | Description | Required |
|---|---|---|---|
| averageAmount | object | No | |
| category | string | Can be 'rent', 'vve' or 'mortgage' | No |
| consistency | number | No | |
| timeConsistency | number | No | |
| amountConsistency | number | No | |
| counterpartyName | string | No | |
| endDate | string | No | |
| lastAmount | object | No | |
| periodicity | string (w/bw/m/bm/ha/a/q/4w/no_periodicity) | No | |
| startDate | string | No | |
| title | string | No |
averageAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lastAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
vve
| Property | Type | Description | Required |
|---|---|---|---|
| averageAmount | object | No | |
| category | string | Can be 'rent', 'vve' or 'mortgage' | No |
| consistency | number | No | |
| timeConsistency | number | No | |
| amountConsistency | number | No | |
| counterpartyName | string | No | |
| endDate | string | No | |
| lastAmount | object | No | |
| periodicity | string (w/bw/m/bm/ha/a/q/4w/no_periodicity) | No | |
| startDate | string | No | |
| title | string | No |
averageAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lastAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
NetSalaryReport
Schema: https://schema.org/government-documents#net-salary
Financial report generated by Credit Estimate service, which includes salary only
| Property | Type | Description | Required |
|---|---|---|---|
| AccountHolderName | string | No | |
| IBAN | string | No | |
| fullIncomeReport | array | No | |
| salary | array | No |
fullIncomeReport
| Property | Type | Description | Required |
|---|---|---|---|
| averageAmount | object | No | |
| category | string | Can be 'rent', 'vve' or 'mortgage' | No |
| consistency | number | No | |
| timeConsistency | number | No | |
| amountConsistency | number | No | |
| counterpartyIban | string | No | |
| counterpartyName | string | No | |
| endDate | string | No | |
| title | string | No | |
| lastAmount | object | No | |
| periodicity | string (w/bw/m/bm/ha/a/q/4w/no_periodicity) | No | |
| startDate | string | No | |
| transactions | array | No |
averageAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lastAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
transactions
| Property | Type | Description | Required |
|---|---|---|---|
| accountId | string | No | |
| description | string | No | |
| transactionTime | string | No | |
| transactionValue | object | No |
transactionValue
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
salary
| Property | Type | Description | Required |
|---|---|---|---|
| averageAmount | object | No | |
| category | string | Can be 'rent', 'vve' or 'mortgage' | No |
| consistency | number | No | |
| timeConsistency | number | No | |
| amountConsistency | number | No | |
| counterpartyName | string | No | |
| endDate | string | No | |
| lastAmount | object | No | |
| periodicity | string (w/bw/m/bm/ha/a/q/4w/no_periodicity) | No | |
| startDate | string | No | |
| title | string | No |
averageAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
lastAmount
| Property | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| currencyCode | string | No |
IB60
Schema: https://schema.org/government-documents#ib60
Income data based on the IB60 government document, representing annual income for the first available year and previous year to that. Includes name, document date, income year, annual income, and optionally the base64-encoded document.
| Property | Type | Description | Required |
|---|---|---|---|
| income | object | Yes | |
| incomePreviousYear | object | Can be null | No |
income
| Property | Type | Description | Required |
|---|---|---|---|
| fullName | string | No | |
| documentDate | string | No | |
| incomeYear | number | Can be null when field is not available in IB60 document | No |
| documentContent | string | Full, raw base64-encoded document containing income data | No |
| annualIncome | number | Can be null when field is not available in IB60 document | No |
incomePreviousYear
| Property | Type | Description | Required |
|---|---|---|---|
| fullName | string | No | |
| documentDate | string | No | |
| incomeYear | number | Can be null when field is not available in IB60 document | No |
| documentContent | string | Full, raw base64-encoded document containing income data | No |
| annualIncome | number | Can be null when field is not available in IB60 document | No |