GET
/api/conversations/{conversationId}/affordability/infoRetrieving the affordability assessment product information relating to the conversation
Returns information about how the affordability assessment validation process is performed for the given conversation ID. Results are available when the appropriate callback is received, or when the affordabilityAssessment status reaches FINISHED.
Response Content
Detailed description of returned fields:
| Parameter | Example | Description |
|---|---|---|
| personalInformation | - | A structure representing the set of personal data collected in affordability assessment validation process. |
| personalInformation.firstName | Jan | Person's first name |
| personalInformation.lastName | Kowalski | Person's last name |
| personalInformation.fullName | Jan Kowalski | Person's full name |
| personalInformation.birthDate | 1985-07-20 | Person's date of birth |
| personalInformation.address | - | A structure representing the set of address related data collected in affordability assessment validation process. |
| personalInformation.address.text | Testowa 5 00-001 Warszawa Polska | Full adress |
| personalInformation.address.addressLine | 5 | House number |
| personalInformation.address.postalCode | 00-001 | Postal code |
| personalInformation.address.city | Warszawa | City |
| personalInformation.address.country | Polska | Country |
| accountInformation | - | A structure representing the set of data related with account collected in affordability assessment validation process. |
| accountInformation.account | - | List of account information. |
| accountInformation.account.accountNumber | PL12345678901234567890123456 | Account number |
| accountInformation.account.bankName | Bank Millennium | Bank name |
| accountInformation.account.accountType | Current | Account type/name |
| accountInformation.account.balance | 15450.75 | Balance |
| accountInformation.account.currency | EUR | Currency |
| accountInformation.account.overdraft | true | Account has an overdraft |
| sourceOfFundsInformation | - | A structure representing the set of data related with source of funds information collected in affordability assessment validation process. |
| sourceOfFundsInformation.sourceOfFunds | - | List of sources. |
| sourceOfFundsInformation.sourceOfFunds.type | Employment | Source type |
| sourceOfFundsInformation.sourceOfFunds.name | Tech Solutions sp. z o.o. | Name of the institution which is the source of funds. |
| sourceOfFundsInformation.sourceOfFunds.grossAmount | 8500.0 | Contract gross amount |
| sourceOfFundsInformation.sourceOfFunds.netAmount | 6120.5 | Contract net amount |
| sourceOfFundsInformation.sourceOfFunds.currency | EUR | Currency |
| sourceOfFundsInformation.sourceOfFunds.currencyConversion.convertedAmount | 4766.94 | Net income after conversion to target currency |
| sourceOfFundsInformation.sourceOfFunds.currencyConversion.targetCurrency | USD | Target currency |
| sourceOfFundsInformation.sourceOfFunds.currencyConversion.convertedAmount | 1.1770 | Exchange rate applied by provider |
| sourceOfFundsInformation.sourceOfFunds.frequency | Monthly | Payment frequency |
| sourceOfFundsInformation.sourceOfFunds.contractType | Permanent | Type of the contract |
| sourceOfFundsInformation.sourceOfFunds.contractEndDate | 2099-12-31 | Contract end date |
| sourceOfFundsInformation.sourceOfFunds.partTimePercentage | 1 | Part of a full-time position covered by the agreement |
| documentInformation | - | A structure representing the set of data related with document collected in affordability assessment validation process. |
| documentInformation.type | EmploymentContract | Type of the collected document |
| documentInformation.number | TS/KOW/2022/11 | Number of the collected document |
| documentInformation.issueDate | 2022-11-01 | Document issue date |
| documentInformation.confidenceScore | 0.95 | Level of trust of the analysed document |
| documentInformation.trustScore | 0.7 | Document Trust Index score |
| documentInformation.periodStart | 2023-01-01 | Period start date that analysed document refers to |
| documentInformation.periodEnd | 2023-12-31 | Period end date that analysed document refers to |
| financialAnalysis | - | A structure representing the summary of affordability assessment validation. |
| financialAnalysis.income | 7500 | Income summary |
| financialAnalysis.expenditure | 4200.5 | Expenditure summary |
| financialAnalysis.currency | EUR | Currency |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversationId | path | string | Required | Conversation ID |
Responses
Transaction list available
Content-Type
application/vnd.authologic.v1.1+jsonJSONitemsarray<AffordabilityResultDetails> required List of affordability assessment results
Bad Request
Content-Type
application/vnd.authologic.v1.1+jsonJSONOne of:
Variant 1
BadRequestApiError Variant 2
MethodArgumentNotValidError Variant 3
MethodArgumentTypeMismatchError Variant 4
ConstraintViolationError Variant 5
CustomValidationApiError Variant 6
OperationNotSupportedApiFieldError Variant 7
MissingHeaderApiErrorExhaustion of the plan or limitations related to non-payment
Forbidden
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Conversation not found
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Conversation is unavailable
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Server side error