AuthenticationResponse
sessionTokenThe session token to be further used in all subsequent api requests in order to authenticate
BorrowerCreateRequest
borrowerTypeIdType identifier for the borrower (e.g., KeyBorrower, borrower)
keyBorrowerRelationIdRelation identifier to the key borrower (optional)
BorrowerFinancialDataCreateRequest
incomeWagesPensionsIncome from wages or pensions (monthly, optional)
incomeGreenReceiptsIncome from green receipts (monthly, optional)
incomeRentsRental income (monthly, optional)
incomeOthersOther income (monthly, optional)
installmentHousingCreditMonthly housing credit installment (optional)
installmentPersonalCreditMonthly personal credit installment (optional)
installmentAutoLeasingCreditMonthly auto/leasing credit installment (optional)
installmentCreditCardMonthly credit card installment (optional)
installmentBankOverdraftMonthly bank overdraft installment (optional)
installmentOtherOther monthly installments (optional)
hasSocialSecurityDebtIndicates whether the borrower has social security debt (optional)
BorrowerFinancialDataUpdateRequest
incomeWagesPensionsIncome from wages or pensions (monthly, optional)
incomeGreenReceiptsIncome from green receipts (monthly, optional)
incomeRentsRental income (monthly, optional)
incomeOthersOther income (monthly, optional)
installmentHousingCreditMonthly housing credit installment (optional)
installmentPersonalCreditMonthly personal credit installment (optional)
installmentAutoLeasingCreditMonthly auto/leasing credit installment (optional)
installmentCreditCardMonthly credit card installment (optional)
installmentBankOverdraftMonthly bank overdraft installment (optional)
installmentOtherOther monthly installments (optional)
hasSocialSecurityDebtIndicates whether the borrower has social security debt (optional)
BorrowerPersonalDataCreateRequest
nameFull name of the borrower
birthDateDate of birth of the borrower
taxIdTax identification number
mobileMobile phone number
emailEmail address
genderIdIdentifier for gender
nationalityIdIdentifier for nationality
identificationDocumentTypeIdIdentification document type identifier
identificationDocumentNumberIdentification document number
identificationDocumentExpiredDateIdentification document expiry date
maritalStatusIdIdentifier for marital status
residenceTypeIdIdentifier for residence type
academicLevelIdIdentifier for academic level
dependentsNumberNumber of dependents
addressResidential address
zipCodePostal code
zipCodeLocalLocality for the postal code
doorNumberDoor number of the property
floorFloor of the property
countryIdIdentifier for country
phoneLandline phone number (optional)
checkDigitIdentification document check digit (optional)
socialSecurityNumberSocial security number (optional)
matrimonialRegimeIdIdentifier for matrimonial regime (optional)
BorrowerPersonalDataUpdateRequest
nameFull name of the borrower (optional)
birthDateDate of birth of the borrower (optional)
taxIdTax identification number (optional)
phoneLandline phone number (optional)
mobileMobile phone number (optional)
emailEmail address (optional)
genderIdIdentifier for gender (optional)
nationalityIdIdentifier for nationality (optional)
identificationDocumentTypeIdIdentification document type identifier (optional)
identificationDocumentNumberIdentification document number (optional)
checkDigitIdentification document check digit (optional)
identificationDocumentExpiredDateIdentification document expiry date (optional)
socialSecurityNumberSocial security number (optional)
maritalStatusIdIdentifier for marital status (optional)
matrimonialRegimeIdIdentifier for matrimonial regime (optional)
residenceTypeIdIdentifier for residence type (optional)
academicLevelIdIdentifier for academic level (optional)
dependentsNumberNumber of dependents (optional)
addressResidential address (optional)
zipCodePostal code (optional)
zipCodeLocalLocality for the postal code (optional)
doorNumberDoor number of the property (optional)
floorFloor of the property (optional)
countryIdIdentifier for country (optional)
BorrowerProfessionalDataCreateRequest
employmentProfessionIdIdentifier of the borrower's profession (optional)
employmentSituationIdIdentifier of the employment situation (optional)
employmentPositionDepartmentIDIdentifier of the employment position or department (optional)
employmentContractTypeIdIdentifier of the employment contract type (optional)
employerNameName of the employer (optional)
employerTaxIdEmployer tax identification number (optional)
employmentDurationMonthsEmployment duration in months (optional)
BorrowerProfessionalDataUpdateRequest
employmentProfessionIdIdentifier of the borrower's profession (optional)
employmentSituationIdIdentifier of the employment situation (optional)
employmentPositionDepartmentIDIdentifier of the employment position or department (optional)
employmentContractTypeIdIdentifier of the employment contract type (optional)
employerNameName of the employer (optional)
employerTaxIdEmployer tax identification number (optional)
employmentDurationMonthsEmployment duration in months (optional)
BorrowerUpdateRequest
borrowerTypeIdType identifier for the borrower (e.g., KeyBorrower, borrower)
keyBorrowerRelationIdRelation identifier to the key borrower (optional)
DocumentCreateRequest
documentTitleDocument title or brief description
documentTypeIDIdentifier of the document type
fileNameStored file name for the document
rejectedFileIndicator or reason used when a file is rejected (required)
documentContentDocument content (base64-encoded string)
documentObservationsAdditional observations or notes about the document (optional)
DocumentUpdateRequest
documentTitleDocument title or brief description (optional)
documentTypeIDIdentifier of the document type (optional)
fileNameStored file name for the document (optional)
documentObservationsAdditional observations or notes about the document (optional)
documentContentDocument content (base64-encoded string) (optional)
ErrorItem
errorCodeNumeric code of the error (Always 6 digits - First 2 digits represent the category the next 2 digits represent the field and the last 2 digits represent the error itself)
errorMessageBrief description of the error found
errorFieldInput field where the error was found
OperationStatus
operationStatusCodeOperation's Status code, representend also by 6 digits, the first 2 digits represent the Resource, the second 2 digits represent the operation and the last 2 digits represent what happend in that operation type
operationStatusMessageOperation's Status message, a more readable description of the status code
PPGenericTaxonomy
idUnique identifier for the taxonomy item
localizedIDLocalized identifier for the taxonomy item
descriptionLocalized description value for the taxonomy item
languageIDIdentifier for the language of the taxonomy item
PPPartnerNotificationCallbackResponse
partnerUniqueIDUnique identifier for the partner.
notificationTypeIdentifier for the type of notification.
callbackUrlThe URL where notifications will be sent.
totalRowsTotal number of rows available.
PPProcessBorrowerFinancialItemResponse
incomeWagesPensionsIncome from wages or pensions (monthly)
incomeGreenReceiptsIncome from green receipts (monthly)
incomeRentsRental income (monthly)
incomeOthersOther income (monthly)
installmentHousingCreditMonthly housing credit installment
installmentPersonalCreditMonthly personal credit installment
installmentAutoLeasingCreditMonthly auto/leasing credit installment
installmentCreditCardMonthly credit card installment
installmentBankOverdraftMonthly bank overdraft installment
installmentOtherOther monthly installments
hasSocialSecurityDebtIndicates whether the borrower has social security debt
PPProcessBorrowerItemResponse
borrowerUniqueIDUnique identifier for the borrower
borrowerTypeIDType identifier for the borrower (e.g., KeyBorrower, Borrower)
borrowerTypeDescriptionDescription of the borrower type
keyBorrowerRelationIDRelation identifier to the key borrower (if applicable)
keyBorrowerRelationDescriptionDescription of the relation to the key borrower (if applicable)
PPProcessBorrowerPersonalItemResponse
nameFull name of the borrower
birthDateDate of birth of the borrower
taxIDTax identification number
socialSecurityNumberSocial security number
phoneLandline phone number
mobileMobile phone number
emailEmail address
genderIDIdentifier for gender
genderDescriptionGender description
nationalityIDIdentifier for nationality
nationalityDescriptionNationality description
identificationDocumentTypeIDIdentifier for identification document type
identificationDocumentTypeDescriptionIdentification document type description
identificationDocumentNumberIdentification document number
checkDigitCheck digit of the identification document
identificationDocumentExpiredDateIdentification document expiry date
maritalStatusIDIdentifier for marital status
maritalStatusDescriptionMarital status description
matriomonialRegimeIDIdentifier for matrimonial regime
matriomonialRegimeDescriptionMatrimonial regime description
residenceTypeIDIdentifier for residence type
residenceTypeDescriptionResidence type description
academicLevelIDIdentifier for academic level
academicLevelDescriptionAcademic level description
dependentsNumberNumber of dependents
addressResidential address
zipCodePostal code
zipCodeLocalLocality for the postal code
doorNumberDoor number
floorFloor
countryIDIdentifier for country
countryDescriptionCountry description
PPProcessBorrowerProfessionalItemResponse
employmentProfessionIDIdentifier of the borrower's profession
employmentProfessionDescriptionDescription of the borrower's profession
employmentSituationIDIdentifier of the employment situation (e.g., employed, unemployed)
employmentsSituationDescriptionDescription of the employment situation
employmentPositionDepartmentIDIdentifier of the position or department
employmentPositionDepartmentDescriptionDescription of the position or department
employmentContractTypeIDIdentifier of the employment contract type
employmentContractTypeDescriptionDescription of the employment contract type
employerNameName of the employer
employerTaxIDEmployer tax identification number
employmentDurationMonthsEmployment duration in months
PPProcessCreateResponse
processUniqueIDUnique identifier for the created process
processNumberNumeric process number
PPProcessDetailBorrowerFinancialResponse
incomeWagesPensionsIncome from wages or pensions (monthly)
incomeGreenReceiptsIncome from green receipts (monthly)
incomeRentsRental income (monthly)
incomeOthersOther income (monthly)
installmentHousingCreditMonthly housing credit installment
installmentPersonalCreditMonthly personal credit installment
installmentAutoLeasingCreditMonthly auto/leasing credit installment
installmentCreditCardMonthly credit card installment
installmentBankOverdraftMonthly bank overdraft installment
installmentOtherOther monthly installments
hasSocialSecurityDebtIndicates whether the borrower has social security debt
PPProcessDetailBorrowerPersonalResponse
nameFull name of the borrower
birthDateDate of birth of the borrower
taxIDTax identification number
socialSecurityNumberSocial security number
phoneLandline phone number
mobileMobile phone number
emailEmail address
genderIDIdentifier for gender
genderDescriptionGender description
nationalityIDIdentifier for nationality
nationalityDescriptionNationality description
identificationDocumentTypeIDIdentifier for identification document type
identificationDocumentTypeDescriptionIdentification document type description
identificationDocumentNumberIdentification document number
checkDigitCheck digit of the identification document
identificationDocumentExpiredDateIdentification document expiry date
maritalStatusIDIdentifier for marital status
maritalStatusDescriptionMarital status description
matriomonialRegimeIDIdentifier for matrimonial regime
matriomonialRegimeDescriptionMatrimonial regime description
residenceTypeIDIdentifier for residence type
residenceTypeDescriptionResidence type description
academicLevelIDIdentifier for academic level
academicLevelDescriptionAcademic level description
dependentsNumberNumber of dependents
addressResidential address
zipCodePostal code
zipCodeLocalLocality for the postal code
doorNumberDoor number
floorFloor
countryIDIdentifier for country
countryDescriptionCountry description
PPProcessDetailBorrowerProfessionResponse
employmentProfessionIDIdentifier of the borrower's profession
employmentProfessionDescriptionDescription of the borrower's profession
employmentSituationIDIdentifier of the employment situation (e.g., employed, unemployed)
employmentsSituationDescriptionDescription of the employment situation
employmentPositionDepartmentIDIdentifier of the position or department
employmentPositionDepartmentDescriptionDescription of the position or department
employmentContractTypeIDIdentifier of the employment contract type
employmentContractTypeDescriptionDescription of the employment contract type
employerNameName of the employer
employerTaxIDEmployer tax identification number
employmentDurationMonthsEmployment duration in months
PPProcessDetailBorrowerResponse
borrowerUniqueIDUnique identifier for the borrower
borrowerTypeIDType identifier for the borrower (e.g., KeyBorrower, Borrower)
borrowerTypeDescriptionDescription of the borrower type
keyBorrowerRelationIDRelation identifier to the key borrower (when applicable)
keyBorrowerRelationDescriptionDescription of the relation to the key borrower (when applicable)
PPProcessDetailDocumentResponse
documentUniqueIDUnique identifier for the document
titleDocument title
fileNameStored file name for the document
statusIDIdentifier of the document status
statusDescriptionDescription of the document status
typeIDIdentifier of the document type
typeDescriptionDescription of the document type
categoryIDIdentifier of the document category
categoryDescriptionDescription of the document category
observationsAdditional observations or notes about the document
isMandatoryIndicates whether the document is mandatory
PPProcessDetailLoanResponse
loanAmountRequested loan amount
loanDurationMonthsDuration of the loan in months
hasCrossSellingIndicates whether cross-selling is applied
productSchemeIDIdentifier of the product scheme
productSchemeDescriptionDescription of the product scheme
loanPurposeIDIdentifier of the loan purpose
loanPurposeDescriptionDescription of the loan purpose
productPurposeIDIdentifier of the product purpose
productPurposeDescriptionDescription of the product purpose
ltvEstimatedEstimated loan-to-value percentage
ltvRealReal loan-to-value percentage
baseSpreadBase spread applied to the loan
proposedSpreadProposed spread for the loan
indexInterestRateIndex interest rate used in the simulation
tanNominal Annual Rate (TAN)
taegAnnual percentage rate (TAEG)
discountCrossSellingCross-selling discount amount
interestRateTypeIDIdentifier of the interest rate type
interestRateTypeDescriptionDescription of the interest rate type
commercialDiscountCommercial discount applied to the offer
monthlyInstallmentAmountEstimated monthly installment amount
sustainabilityCampaignIndicates if the sustainability campaign applies
sustainabilityCampaignPercentageSustainability campaign percentage (when applicable)
mticExpected final paid amount (MTIC)
fixedTANFixed TAN value (when applicable)
variableTANVariable TAN value (when applicable)
indexTypeSubCategoryIDIdentifier of the index type sub-category
indexTypeSubCategoryDescriptionDescription of the index type sub-category
indexTypeMixedMixed index type information (when applicable)
indexTypeIndex type description
fixedBaseInterestRateFixed base interest rate
fixedMonthlyInstallmentAmountMonthly installment amount for the fixed period
fixedSpreadFixed spread amount
fixedPeriodFixed period duration (as string)
fixedProposedSpreadProposed spread for the fixed period
loanFixedPeriodMonthsFixed period length in months
variableBaseInterestRateVariable base interest rate (when applicable)
variableMonthlyInstallmentAmountMonthly installment amount for the variable period (when applicable)
variableSpreadVariable spread amount (when applicable)
variableProposedSpreadProposed spread for the variable period (when applicable)
loanVariablePeriodMonthsVariable period length in months
spreadOverall spread used in the loan
baseInterestRateBase interest rate used in the simulation
PPProcessDetailNoteResponse
commentNote comment text
dateDate and time when the note was created
userNameUser name of the person who added the note
PPProcessDetailPropertyResponse
propertyUniqueIDUnique identifier for the property
typologyIDIdentifier of the property typology (e.g., Flat, Detached House)
typologyDescriptionDescription of the property typology
grossBuiltAreaGross built area in square meters
yearBuiltYear the property was built
completedDateDate when the property construction was completed
acquisitionDateDate of property acquisition
acquisitionAmountAcquisition amount paid for the property
acquisitionDeedAmountAcquisition deed amount (if different from acquisition amount)
evaluationEstimatedAmountEstimated evaluation amount used in the simulation
evaluationAmountActual evaluation amount (if available)
districtIDIdentifier of the district where the property is located
districtDescriptionDistrict description
countyIDIdentifier of the county where the property is located
countyDescriptionCounty description
parishIDIdentifier of the parish where the property is located
parishDescriptionParish description
addressStreet address of the property
doorNumberDoor number of the property
floorFloor of the property
zipCodePostal code
zipCodeLocalLocality for the postal code
PPProcessDetailResponseBase
processUniqueIDUnique identifier for the process
processNumberNumeric process number
simulationUniqueIDUnique identifier of the related simulation
simulationNumberNumeric simulation identifier
creationDateCreation date of the process
lastActionDateLast action date of the process
branchIDIdentifier of the branch handling the process
branchDescriptionDescription of the branch
processStatusIDIdentifier for the process status
processStatusDescriptionDescription of the process status
PPProcessDocumentGetResponse
fileNameStored file name of the document
titleDocument title or brief description
contentDocument content (base64)
PPProcessDocumentItemResponse
documentUniqueIDUnique identifier for the document
titleDocument title or brief description
fileNameStored file name for the document
statusIDIdentifier of the document status
statusDescriptionDescription of the document status
typeIDIdentifier of the document type
typeDescriptionDescription of the document type
categoryIDIdentifier of the document category
categoryDescriptionDescription of the document category
observationsAdditional observations or notes about the document
isMandatoryIndicates whether the document is mandatory
PPProcessMessageBaseListResponse
totalCountTotal number of messages associated with the process
countNumber of messages in the current response
PPProcessMessageResponse
usernameIdentifier of the user sending the message
subjectSubject of the message
textBody text of the message
creationDateMessage creation date
PPProcessPropertyItemResponse
propertyUniqueIDUnique identifier for the property
yearBuiltYear the property was built (optional)
acquisitionAmountAcquisition amount paid for the property (optional)
acquisitionDateDate of property acquisition (optional)
estimatedAmountEstimated property amount used in the process (optional)
doorNumberDoor number of the property (optional)
floorFloor of the property (optional)
districtIDIdentifier of the district where the property is located (optional)
districtDescriptionDistrict description (optional)
countyIDIdentifier of the county where the property is located (optional)
countyDescriptionCounty description (optional)
parishIDIdentifier of the parish where the property is located (optional)
parishDescriptionParish description (optional)
zipCodePostal code of the property (optional)
zipCodeLocalLocality for the postal code (optional)
typologyIDIdentifier of the property typology (optional)
typologyDescriptionDescription of the property typology (optional)
grossBuiltAreaGross built area in square meters (optional)
addressStreet address of the property (optional)
PPSimulationCreateResponse
simulationUniqueIDUnique identifier for the created simulation
simulationNumberHuman-readable simulation number
elegibilityIndicates whether the simulation meets eligibility criteria
nonElegibilityDescriptionDescription explaining why a simulation is not eligible (when applicable)
PPSimulationDetailBankCharges
descriptionBank charge description
amountBank charge amount
PPSimulationDetailBorrowers
numberOfborrowersAmount of borrowers for this simulation
keyBorrowerNamePrincipal borrower complete name
keyBorrowerTaxIdPrincipal borrower fiscal number
keyBorrowerBirthDatePrincipal borrower birth date
keyBorrowerContractTypeIDPrincipal borrower current employment contract type id (This information can also be obtained from the corresponding Taxonomy endpoint)
keyBorrowerContractTypeDescriptionPrincipal borrower current employment contract type description
keyBorrowerIncomeWagesPensionsPrincipal borrower earnings related to wages/pensions (monthly)
keyBorrowerIncomeGreenReceiptsPrincipal borrower earnings related to green receipts (monthly)
keyBorrowerIncomeRentsPrincipal borrower earnings related to incoming rents (monthly)
keyBorrowerIncomeOthersPrincipal borrower earnings related to other matters (monthly)
keyBorrowerInstallmentHousingCreditPrincipal borrower expenses related to housing mortgages (monthly)
keyBorrowerInstallmentPersonalCreditPrincipal borrower expenses related to personal credits (monthly)
keyBorrowerInstallmentAutoLeasingCreditPrincipal borrower expenses related to automobile credits (monthly)
keyBorrowerInstallmentCreditCardPrincipal borrower expenses related to credit card lines (monthly)
keyBorrowerInstallmentBankOverdraftPrincipal borrower expenses related to bank overdrafts (monthly)
keyBorrowerInstallmentOtherPrincipal borrower expenses related to other matters (monthly)
keyBorrowerHasSocialSecurityDebtWether the principal borrower has any pending social security debt
borrowerNameSecondary borrower complete name (field should only be present if the number of borrowers is > 1 as well as the subsequent Borrower fields)
borrowerTaxIdSecondary borrower fiscal number
borrowerBirthDateSecondary borrower birth date
borrowerContractTypeIDSecondary borrower current employment contract id (This information can also be obtained from the corresponding Taxonomy endpoint)
borrowerContractTypeDescriptionSecondary borrower current employment contract description
borrowerIncomeWagesPensionsSecondary borrower earnings related to wages/pensions (monthly)
borrowerIncomeGreenReceiptsSecondary borrower earnings related to green receipts (monthly)
borrowerIncomeRentsSecondary borrower earnings related to incoming rents (monthly)
borrowerIncomeOthersSecondary borrower earnings related to other matters (monthly)
borrowerInstallmentHousingCreditSecondary borrower expenses related to housing mortgages (monthly)
borrowerInstallmentPersonalCreditSecondary borrower expenses related to personal credits (monthly)
borrowerInstallmentAutoLeasingCreditSecondary borrower expenses related to automobile credits (monthly)
borrowerInstallmentCreditCardSecondary borrower expenses related to credit card lines (monthly)
borrowerInstallmentBankOverdraftSecondary borrower expenses related to bank overdrafts (monthly)
borrowerInstallmentOtherSecondary borrower expenses related to other matters (monthly)
borrowerHasSocialSecurityDebtWether the secondary borrower has any pending social security debt
borrowersDependentsNumberHow many dependets do the borrowers have collectivly
PPSimulationDetailInsurance
lifeInsuranceMonthlyAmountLife insurance estimated monthly amount
propertyInsuranceMonthlyAmountMultirisk insurance estimated monthly amount
PPSimulationDetailLoan
loanAmountRequested loan amount
loanDurationMonthsDuration of the loan for the simulation in months
monthlyInstallmentAmountEstimated monthly installment amount
mticExpected final payed amount
proposedSpreadProposed spread for the loan
indexInterestRateIndex interest rate used in the simulation
tanNominal Annual Rate (TAN)
taegAnnual percentage rate (TAEG)
productSchemeIdIdentifier of the product scheme
productSchemeDescriptionDescription of the product scheme
loanPurposeIdIdentifier of the loan purpose
loanPurposeDescriptionDescription of the loan purpose
productPurposeIdIdentifier of the product purpose
productPurposeDescriptionDescription of the product purpose
hasCrossSellingIndicates if cross-selling is available
indexTypeSubCategoryIDIdentifier of the index type sub-category
indexTypeSubCategoryDescriptionDescription of the index type sub-category
indexTypeMixedMixed index type information
indexTypeIndex type
fixedBaseInterestRateFixed base interest rate
fixedMonthlyInstallmentAmountMonthly installment amount for fixed period
fixedTANFixed Nominal Annual Rate (TAN)
variableTANVariable Nominal Annual Rate (TAN)
fixedSpreadFixed spread amount
fixedPeriodFixed period duration
fixedProposedSpreadProposed spread for fixed period
loanFixedPeriodMonthsFixed period length in months
variableBaseInterestRateVariable base interest rate
variableMonthlyInstallmentAmountMonthly installment amount for variable period
variableSpreadVariable spread amount
variableProposedSpreadProposed spread for variable period
loanVariablePeriodMonthsVariable period length in months
spreadSpread used in the loan
baseInterestRateBase interest rate used in the simulation
loanToValueLoan-to-value percentage
youthCreditIndicates whether youth credit applies
PPSimulationDetailProperty
typologyIdProperty's typology id (This information can also be obatined from the corresponding taxonomy endpoint)
typologyDescriptionProperty's typology description (This information can also be obatined from the corresponding taxonomy endpoint)
evaluationEstimatedAmountProperty's estimated evaluation amount
acquisitionAmountProperty's acquisition amount
districtIdProperty's location district id (This information can also be obatined from the corresponding taxonomy endpoint)
districtDescriptionProperty's location district description
grossBuiltAreaProperty's gross built area in sqr m
PPSimulationDetailSimulation
simulationUniqueIdSimulation's unique identifier
simulationNumberSimulation's unique integer identifier
processUniqueIdAssociated Process unique identifier (If simulation did not progress into a formal Proposal this field will be empty)
processNumberAssociated Process unique integer identifier (If simulation did not progress into a formal Proposal this field will be empty)
creationDateDate of the creation of the simulation
originThis field represents where the simulation came from
branchIdAssociated Branch ID
branchDescriptionAssociated Branch name
simulationStatusIdCurrent simulation's status id
simulationStatusDescriptionCurrent simulation's status description
cancelReasonIdCancel reason id (Only if the simulation had been previously cancelled)
cancelReasonDescriptionCancel reason description (Only if the simulation had been previously cancelled)
cancelObservationsCancel observations (Only if the simulation had been previously cancelled)
PPSimulationMessageBaseListResponse
totalCountTotal number of messages associated with the simulation
countNumber of messages in the current response
PPSimulationMessageResponse
usernameIdentifier of the user sending the message
subjectSubject of the message
textBody text of the message
creationDateCreation date of the message
PPSimulationSearchResponse
simulationUniqueIDSimulation's unique identifier
simulationNumberSimulation's unique integer identifier
keyBorrowerNameMortgage principal borrower name
keyBorrowerTaxIDMortgage principal borrower fiscal number
loanAmountSimulation's request amount
statusLastDateLast time the simulation was updated
simulationStatusIDSimulation's current state id
simulationStatusDescriptionSimulation's current state description
propertyAmountSimulation's property amount
ltvEstimatedEstimated LTV for the current simulation
branchIDSimulation's associated branch
branchDescriptionSimulation's associated branch name
originSimulation's origin
youthCreditIndicates wether the simulation has the DL 44/2024 active (Youth measures)
PPSimulationSearchResponseBase
totalRecordsTotal number of records found
hasMoreResultsIndicates if there are more results available
List of simulation details
PPSimulationUpdateResponse
simulationUniqueIDUnique identifier for the created simulation
simulationNumberHuman-readable simulation number
elegibilityIndicates whether the simulation meets eligibility criteria
nonElegibilityDescriptionDescription explaining why a simulation is not eligible (when applicable)
PPTaxonomyBankChargeType
bankChargeTypeLocalizedIDLocalized identifier for the bank charge type
bankChargeTypeIDUnique identifier for the bank charge type
codeShort business code representing the bank charge type
descriptionLocalized description of the bank charge type
languageIDIdentifier of the language used for the localized bank charge type description
investorIDIdentifier of the investor associated with the bank charge type
PPTaxonomyBrokerSubType
mortgageBrokerTypeIDIdentifier for the associated Mortgage Broker Type
mortgageBrokerSubTypeIDUnique identifier for the MortgageBrokerSubType item
mortgageBrokerSubTypeLocalizedIDLocalized identifier for the MortgageBrokerSubType item
descriptionLocalized description value for the MortgageBrokerSubType item
languageIDIdentifier for the language of the MortgageBrokerSubType item
PPTaxonomyCountry
countryLocalizedIDLocalized identifier for the country
countryIDUnique identifier for the country
uniqueIDGlobally unique identifier for the country
nameName of the country
abbreviationAbbreviation of the country
latitudeLatitude coordinate of the country
longitudeLongitude coordinate of the country
phoneCodePhone code of the country
statusIDStatus identifier of the country telling if it's active or inactive
alphaThreeCodeISO 3166-1 alpha-3 – three-letter country code
languageIDIdentifier of the language used for the localized country name
codeCode of the country
numericThreeCodeISO 3166-1 numeric – three-digit country code
originationCurrencyIDIdentifier of the origination currency associated with the country
countryIBANCodeIBAN code associated with the country
isEuropeanUnionIndicates whether the country is a member of the European Union
PPTaxonomyCounty
countyLocalizedIDLocalized identifier for the county
countyIDUnique identifier for the county
countryIDIdentifier for the associated country
regionIDIdentifier for the associated region
districtIDIdentifier for the associated district
nameName of the county
uniqueIDGlobally unique identifier for the county
latitudeLatitude coordinate of the county
longitudeLongitude coordinate of the county
statusIDStatus identifier of the county telling if it's active or inactive
codeOfficial administrative code associated with the county
languageIDIdentifier of the language used for the localized county name
PPTaxonomyDistrict
districtLocalizedIDLocalized identifier for the district
districtIDUnique identifier for the district
uniqueIDGlobally unique identifier for the district
countryIDIdentifier for the associated country
regionIDIdentifier for the associated region
nameName of the district
latitudeLatitude coordinate of the district
longitudeLongitude coordinate of the district
statusIDStatus identifier of the district telling if it's active or inactive
codeOfficial administrative code associated with the district
corporateStructureIDIdentifier representing the corporate or organizational structure associated with the district
languageIDIdentifier of the language used for the localized district name
PPTaxonomyDocumentType
documentTypeLocalizedIDLocalized identifier for the document type
documentTypeIDUnique identifier for the document type
languageIDIdentifier of the language used for the localized document type description
codeExternal or business reference code used to identify the document type in country-specific, regulatory, or institutional contexts. May be empty when no official code applies.
descriptionLocalized description of the document type
isPublicIndicates whether the document type is publicly visible
documentCategoryIDIdentifier for the document category associated with the document type
documentSubCategoryIDIdentifier for the document sub-category associated with the document type
enableQnAIndicates whether Q&A functionality is enabled for this document type
PPTaxonomyGender
genderLocalizedIDLocalized identifier for the gender
genderIDUnique identifier for the gender
languageIDIdentifier of the language used for the localized gender description
codeShort business code representing the gender
descriptionLocalized description of the gender
statusIDStatus identifier of the gender telling if it's active or inactive
PPTaxonomyIndexType
idUnique identifier for the index definition
descriptionDescription of the index
indexTypeIDIdentifier for the index type
indexTypeCategoryIDIdentifier for the index type category
indexTypeSubCategoryIDIdentifier for the index type sub-category
periodicityMonthsPeriodicity of the index update expressed in months
periodicityYearsPeriodicity of the index update expressed in years
statusIDStatus identifier of the index indicating if it's active or inactive
typeIndex type behavior indicating fixed or floating rate
portfolioIDIdentifier of the portfolio associated with the index
investorIDIdentifier of the investor associated with the index
PPTaxonomyIndexTypeSubCategories
indexTypeSubCategoryLocalizedIDLocalized identifier for the index type sub-category
indexTypeSubCategoryIDUnique identifier for the index type sub-category
descriptionLocalized description of the index type sub-category
codeShort business code representing the index type sub-category
languageIDIdentifier of the language used for the localized index type sub-category description
PPTaxonomyLoanPurpose
loanPurposeLocalizedIDLocalized identifier for the loan purpose
loanPurposeIDUnique identifier for the loan purpose
codeShort business code representing the loan purpose
descriptionLocalized description of the loan purpose
languageIDIdentifier of the language used for the localized loan purpose description
loanPurposeCategoryIDIdentifier for the loan purpose category associated with the loan purpose
PPTaxonomyMaritalStatus
maritalStatusLocalizedIDLocalized identifier for the marital status
maritalStatusIDUnique identifier for the marital status
languageIDIdentifier of the language used for the localized marital status description
codeShort business code representing the marital status
descriptionLocalized description of the marital status
statusIDStatus identifier of the marital status telling if it's active or inactive
PPTaxonomyParish
parishLocalizedIDLocalized identifier for the parish
parishIDUnique identifier for the parish
countryIDIdentifier for the associated country
regionIDIdentifier for the associated region
districtIDIdentifier for the associated district
countyIDIdentifier for the associated county
uniqueIDGlobally unique identifier for the parish
nameName of the parish
latitudeLatitude coordinate of the parish
longitudeLongitude coordinate of the parish
statusIDStatus identifier of the parish telling if it's active or inactive
disconfreOfficial DICOFRE code identifying the parish in Portuguese administrative records
ineParishIDINE identifier for the parish
ineDistrictIDINE identifier for the district associated with the parish
ineCountyIDINE identifier for the county associated with the parish
ineCodeESINE code for statistical or electoral purposes
codeOfficial administrative code associated with the parish
languageIDIdentifier of the language used for the localized parish name
PPTaxonomyProductPurpose
productPurposeLocalizedIDLocalized identifier for the product purpose
productPurposeIDUnique identifier for the product purpose
languageIDIdentifier of the language used for the localized product purpose description
descriptionLocalized description of the product purpose
statusIDStatus identifier of the product purpose telling if it's active or inactive
codeShort business code representing the product purpose
PPTaxonomyProfession
mortgageProposalProfessionLocalizedIDLocalized identifier for the profession
mortgageProposalProfessionIDUnique identifier for the profession
languageIDIdentifier of the language used for the localized profession description
descriptionLocalized description of the profession
isVisibleIndicates whether the profession is visible for selection in the application
PPTaxonomyPropertyTypology
simulationPropertyTypologyLocalizedIDLocalized identifier for the simulation property typology
simulationPropertyTypologyIDUnique identifier for the simulation property typology
descriptionLocalized description of the property typology
languageIDIdentifier of the language used for the localized property typology description
investorIDIdentifier of the investor associated with the property typology
PPTaxonomyWorkflowPhase
workflowPhaseLocalizedIDLocalized identifier for the workflow phase
workflowPhaseIDUnique identifier for the workflow phase
qualifiedNameQualified name of the workflow phase, including its sequence or label
codeShort business code representing the workflow phase
descriptionLocalized description of the workflow phase
workflowPhaseNumberSequential number representing the order of the workflow phase
workflowTypeIDIdentifier of the workflow type to which this phase belongs
languageIDIdentifier of the language used for the localized workflow phase information
PPTaxonomyWorkflowState
workflowStateIDUnique identifier for the workflow state
workflowPhaseIDIdentifier of the workflow phase associated with this state, if applicable
workflowStateTypeIDIdentifier for the workflow state type
workflowTypeIDIdentifier of the workflow type to which this state belongs
codeShort business code representing the workflow state
descriptionDescription of the workflow state
ProcessCreateRequest
simulationUniqueIdUnique identifier of the simulation to create a process for
keyBorrowerEmailEmail address of the primary (key) borrower
keyBorrowerNameFull name of the primary (key) borrower
keyBorrowerIdentificationDocTypeIdIdentification document type identifier for the primary borrower
keyBorrowerIdentificationDocNumberIdentification document number for the primary borrower
keyBorrowerResidencePrimary borrower's residence/address (optional)
keyBorrowerIdentificationDocExpirationDateIdentification document expiration date for the primary borrower (optional)
borrowerEmailEmail of the secondary borrower (optional)
borrowerNameFull name of the secondary borrower (optional)
borrowerResidenceResidence/address of the secondary borrower (optional)
borrowerIdentificationDocTypeIdIdentification document type identifier for the secondary borrower (optional)
borrowerIdentificationDocNumberIdentification document number for the secondary borrower (optional)
borrowerIdentificationDocExpirationDateIdentification document expiration date for the secondary borrower (optional)
ProcessListItem
processUniqueIdUnique identifier of the process (GUID as string)
processNumberHuman-readable process number
keyBorrowerNameFull name of the primary borrower
keyBorrowerTaxIdTax identifier of the primary borrower
loanAmountRequested loan amount
lastActionDateDate of the last action on the process
processStatusIdIdentifier of the process status
processStatusDescriptionDescription of the process status
hasCreditDecisionIndicates if a credit decision exists for the process
branchIdIdentifier of the branch handling the process
branchDescriptionDescription of the branch
contractDateDate when the contract was signed (if applicable)
scheduledContractDateScheduled contract date (if applicable)
propertyAmountProperty purchase amount
simulationUniqueIdUnique identifier of the related simulation (GUID as string)
simulationNumberHuman-readable simulation number
hasInsuranceIndicates whether the process has insurance
ltvEstimatedEstimated loan-to-value percentage
ltvRealReal loan-to-value percentage
ProcessListResponse
totalRecordsTotal number of process records matching the query
hasMoreResultsIndicates whether more results are available beyond the current page
ProcessUpdateRequest
loanAmountRequested loan amount (optional)
loanDurationMonthsDuration of the loan in months (optional)
productSchemeIdIdentifier of the selected product scheme (optional)
loanPurposeIdIdentifier of the loan purpose (optional)
productPurposeIdIdentifier of the product purpose (optional)
hasCrossSellingIndicates whether cross-selling options are selected (optional)
branchIdIdentifier of the branch handling the process (optional)
PropertyUpdateRequest
grossBuiltAreaGross built area in square meters (optional)
yearBuiltYear the property was built (optional)
acquisitionAmountAcquisition amount paid for the property (optional)
acquisitionDateDate of property acquisition (optional)
addressStreet address of the property (optional)
doorNumberDoor number of the property (optional)
floorFloor of the property (optional)
districtIdIdentifier of the district where the property is located (optional)
countyIdIdentifier of the county where the property is located (optional)
parishIdIdentifier of the parish where the property is located (optional)
zipCodePostal code (optional)
zipCodeLocalLocality for the postal code (optional)
SimulationCancelRequest
simulationCancelReasonIdSimulation Cancel reason ID (can be obtained from the corresponding taxonomy endpoint)
cancelCommentsAny additional comments to the cancel reason
SimulationCreateRequestBorrowers
numberOfborrowersNumber of borrowers in the simulation
keyBorrowerNameFull name of the primary (key) borrower
keyBorrowerBirthDateBirth date of the primary (key) borrower
keyBorrowerIncomeWagesPensionsPrimary borrower's income from wages or pensions (monthly)
keyBorrowerIncomeGreenReceiptsPrimary borrower's income from green receipts (monthly)
keyBorrowerIncomeRentsPrimary borrower's rental income (monthly)
keyBorrowerIncomeOthersPrimary borrower's other income (monthly)
keyBorrowerInstallmentHousingCreditPrimary borrower's monthly housing credit installment
keyBorrowerInstallmentPersonalCreditPrimary borrower's monthly personal credit installment
keyBorrowerInstallmentAutoLeasingCreditPrimary borrower's monthly auto/leasing credit installment
keyBorrowerInstallmentCreditCardPrimary borrower's monthly credit card installment
keyBorrowerInstallmentBankOverdraftPrimary borrower's monthly bank overdraft installment
keyBorrowerInstallmentOtherPrimary borrower's other monthly installments
borrowerNameFull name of the secondary borrower (optional)
borrowerBirthDateBirth date of the secondary borrower (optional)
borrowerIncomeWagesPensionsSecondary borrower's income from wages or pensions (monthly, optional)
borrowerIncomeGreenReceiptsSecondary borrower's income from green receipts (monthly, optional)
borrowerIncomeRentsSecondary borrower's rental income (monthly, optional)
borrowerIncomeOthersSecondary borrower's other income (monthly, optional)
borrowerInstallmentHousingCreditSecondary borrower's monthly housing credit installment (optional)
borrowerInstallmentPersonalCreditSecondary borrower's monthly personal credit installment (optional)
borrowerInstallmentAutoLeasingCreditSecondary borrower's monthly auto/leasing credit installment (optional)
borrowerInstallmentCreditCardSecondary borrower's monthly credit card installment (optional)
borrowerInstallmentBankOverdraftSecondary borrower's monthly bank overdraft installment (optional)
borrowerInstallmentOtherSecondary borrower's other monthly installments (optional)
SimulationCreateRequestLoan
loanDurationMonthsDuration of the loan in months
loanAmountRequested loan amount
productSchemeIdIdentifier of the selected product scheme
loanPurposeIdIdentifier of the loan purpose
productPurposeIdIdentifier of the product purpose
hasCrossSellingIndicates whether cross-selling options are selected
interestRateTypeIDInterest rate type identifier (e.g., fixed, variable, mixed)
youthCreditIndicates whether youth credit option applies
indexTypeIDIndex type identifier when applicable
indexTypeMixedIDMixed index type identifier when applicable
fixedPeriodIDIdentifier of the fixed period selection (if applicable)
utilizationPeriodUtilization period in months (if applicable)
SimulationCreateRequestProperty
acquisitionAmountAcquisition price of the property
evaluationEstimatedAmountEstimated market value used for the simulation
sustainabilityCampaignIndicates if the property is part of a sustainability campaign
worksCostEstimated cost of works or renovations (optional)
estimatedValueAfterWorksEstimated value of the property after works (optional)
landValueValue of the land portion (optional)
SimulationUpdateRequestBorrowers
numberOfborrowersNumber of borrowers in the simulation
keyBorrowerNameFull name of the primary (key) borrower
keyBorrowerBirthDateBirth date of the primary (key) borrower
keyBorrowerIncomeWagesPensionsPrimary borrower's income from wages or pensions (monthly)
keyBorrowerIncomeGreenReceiptsPrimary borrower's income from green receipts (monthly)
keyBorrowerIncomeRentsPrimary borrower's rental income (monthly)
keyBorrowerIncomeOthersPrimary borrower's other income (monthly)
keyBorrowerInstallmentHousingCreditPrimary borrower's monthly housing credit installment
keyBorrowerInstallmentPersonalCreditPrimary borrower's monthly personal credit installment
keyBorrowerInstallmentAutoLeasingCreditPrimary borrower's monthly auto/leasing credit installment
keyBorrowerInstallmentCreditCardPrimary borrower's monthly credit card installment
keyBorrowerInstallmentBankOverdraftPrimary borrower's monthly bank overdraft installment
keyBorrowerInstallmentOtherPrimary borrower's other monthly installments
borrowerNameFull name of the secondary borrower (optional)
borrowerBirthDateBirth date of the secondary borrower (optional)
borrowerIncomeWagesPensionsSecondary borrower's income from wages or pensions (monthly, optional)
borrowerIncomeGreenReceiptsSecondary borrower's income from green receipts (monthly, optional)
borrowerIncomeRentsSecondary borrower's rental income (monthly, optional)
borrowerIncomeOthersSecondary borrower's other income (monthly, optional)
borrowerInstallmentHousingCreditSecondary borrower's monthly housing credit installment (optional)
borrowerInstallmentPersonalCreditSecondary borrower's monthly personal credit installment (optional)
borrowerInstallmentAutoLeasingCreditSecondary borrower's monthly auto/leasing credit installment (optional)
borrowerInstallmentCreditCardSecondary borrower's monthly credit card installment (optional)
borrowerInstallmentBankOverdraftSecondary borrower's monthly bank overdraft installment (optional)
borrowerInstallmentOtherSecondary borrower's other monthly installments (optional)
SimulationUpdateRequestLoan
loanDurationMonthsDuration of the loan in months
loanAmountRequested loan amount
productSchemeIdIdentifier of the selected product scheme
loanPurposeIdIdentifier of the loan purpose
productPurposeIdIdentifier of the product purpose
hasCrossSellingIndicates whether cross-selling options are selected
interestRateTypeIDInterest rate type identifier (e.g., fixed, variable, mixed)
indexTypeIDIndex type identifier when applicable
indexTypeMixedIDMixed index type identifier when applicable
fixedPeriodIDIdentifier of the fixed period selection (if applicable)
utilizationPeriodUtilization period in months (if applicable)
youthCreditIndicates whether youth credit option applies
SimulationUpdateRequestProperty
acquisitionAmountAcquisition price of the property (optional)
evaluationEstimatedAmountEstimated market value used for the simulation (optional)
sustainabilityCampaignIndicates if the property is part of a sustainability campaign (optional)
worksCostEstimated cost of works or renovations (optional)
estimatedValueAfterWorksEstimated value of the property after works (optional)
landValueValue of the land portion (optional)