Oper Loan Requests Client Info API
The Loan Requests Client Info API from Oper — 1 operation(s) for loan requests client info.
The Loan Requests Client Info API from Oper — 1 operation(s) for loan requests client info.
openapi: 3.0.3
info:
title: Oper Agent Documents Loan Requests Client Info API
version: ''
tags:
- name: Loan Requests Client Info
paths:
/api/loan-requests-client-info/:
post:
description: 'Mixin that routes to the loan request and verifies if the requestor has access to the requested resource
To use the Role View Mixin, you must define either queryset or overwrite get_base_queryset'
operationId: api_loan_requests_client_info_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequestClientRealty'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LoanRequestClientRealty'
multipart/form-data:
schema:
$ref: '#/components/schemas/LoanRequestClientRealty'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequestClientRealty'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests Client Info
components:
schemas:
Client2Client:
properties:
client_from:
allOf:
- $ref: '#/components/schemas/ReducedClientProfile'
writeOnly: true
client_to:
$ref: '#/components/schemas/ReducedClientProfile'
id:
readOnly: true
type: integer
live_in_the_same_household:
nullable: true
type: boolean
oper_reference:
format: uuid
readOnly: true
type: string
relationship:
allOf:
- $ref: '#/components/schemas/Relationship'
nullable: true
required:
- client_from
- client_to
- id
- oper_reference
type: object
DetailedNotary:
description: "Baseclass for Reduced serializers.\n\nWill validate whether the objects exists, and returns the instance in to_internal_value\nSubclasses must implement Meta with at least the model and field attributes\n\nRaises\n------\n Validations errors if the object doesn't exist\n OperBadConfigurationException if the model isn't set"
properties:
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
readOnly: true
type: array
bank_account:
readOnly: true
type: string
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
emails:
items:
$ref: '#/components/schemas/Profile2Email'
readOnly: true
type: array
id:
type: integer
name:
readOnly: true
type: string
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
readOnly: true
type: array
vat_number:
readOnly: true
type: string
required:
- addresses
- bank_account
- company_type
- emails
- id
- name
- phone_numbers
- vat_number
type: object
ConstructionType:
description: Can be managed at /resources/construction-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
SocialInsuranceStartDate:
description: Can be managed at /resources/social-insurance-start-date
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
NestedSignedDocument:
properties:
document_type:
allOf:
- $ref: '#/components/schemas/DocumentType'
readOnly: true
mime_type:
readOnly: true
type: string
url:
readOnly: true
type: string
required:
- document_type
- mime_type
- url
type: object
BaseUserProfile:
description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\nExample of usage:\n```\nclass Child(models.Model):\n field = models.CharField(unique=True)\nclass Parent(models.Model):\n child = models.ForeignKey('Child')\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n class Meta:\n model = Child\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n child = ChildSerializer()\n class Meta:\n model = Parent\n```\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
properties:
birth_city:
maxLength: 128
type: string
birth_date:
format: date
nullable: true
type: string
first_name:
maxLength: 64
type: string
id:
readOnly: true
type: integer
last_name:
maxLength: 128
type: string
middle_name:
maxLength: 64
type: string
mother_maiden_name:
maxLength: 128
type: string
oper_reference:
format: uuid
readOnly: true
type: string
title:
nullable: true
type: integer
title2:
nullable: true
type: integer
user:
type: integer
required:
- id
- oper_reference
- user
type: object
LoanRequestRealty2ClientProfile:
properties:
a_card_details:
allOf:
- $ref: '#/components/schemas/ACardDetails'
nullable: true
address_card_id:
maxLength: 64
type: string
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
type: array
bic:
maxLength: 11
type: string
birth_city:
nullable: true
type: string
birth_country:
allOf:
- $ref: '#/components/schemas/Country'
nullable: true
birth_date:
format: date
nullable: true
type: string
birth_first_name:
maxLength: 64
type: string
birth_last_name:
maxLength: 128
type: string
broker:
allOf:
- $ref: '#/components/schemas/ReducedBroker'
nullable: true
civil_status:
allOf:
- $ref: '#/components/schemas/CivilStatus'
nullable: true
client:
$ref: '#/components/schemas/Client'
company_name:
maxLength: 255
type: string
company_tax_number:
maxLength: 32
type: string
compliance_bank:
nullable: true
type: boolean
compliance_fraud:
nullable: true
type: boolean
compliance_office_presentation:
default: false
type: boolean
compliance_personalized_information:
allOf:
- $ref: '#/components/schemas/PersonalizedInformation'
nullable: true
compliance_privacy_policy:
default: false
type: boolean
compliance_terror:
nullable: true
type: boolean
consent_bank_retrieve_positive_data:
nullable: true
type: string
consent_khr_post_contract_processing:
nullable: true
type: boolean
consent_other_lenders_khr_access:
nullable: true
type: boolean
country_arrival_date:
format: date
nullable: true
type: string
created_by:
allOf:
- $ref: '#/components/schemas/ReducedBaseUser'
readOnly: true
credit_provider:
allOf:
- $ref: '#/components/schemas/ReducedCreditProvider'
nullable: true
dependent_children:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
education:
allOf:
- $ref: '#/components/schemas/EducationType'
nullable: true
emails:
items:
$ref: '#/components/schemas/Profile2Email'
type: array
employment_status:
allOf:
- $ref: '#/components/schemas/EmploymentType'
nullable: true
expected_fetuses_birth_date:
format: date
nullable: true
type: string
external_reference:
type: string
first_name:
maxLength: 64
type: string
fiscal_residence:
allOf:
- $ref: '#/components/schemas/Country'
nullable: true
future_living_status:
allOf:
- $ref: '#/components/schemas/LivingStatus'
nullable: true
has_politically_exposed_person_status:
default: false
type: boolean
has_vehicle:
type: boolean
health_insurance_certificate_date:
format: date
nullable: true
type: string
iban:
maxLength: 34
type: string
id:
type: integer
id_card_number:
maxLength: 32
type: string
id_document_type:
allOf:
- $ref: '#/components/schemas/IdDocumentType'
nullable: true
id_expiration_date:
format: date
nullable: true
type: string
id_issuance_date:
format: date
nullable: true
type: string
id_issuing_authority:
maxLength: 128
type: string
is_36_month_moratorium_on_repayments_required:
type: boolean
is_active:
type: boolean
is_bank_account_opt_in:
type: boolean
is_bank_employee:
type: boolean
is_claiming_tax_refund:
type: boolean
is_debt_collection:
type: boolean
is_essential_communications_only_receiver:
default: false
type: boolean
is_first_time_buyer:
default: false
type: boolean
is_insider:
nullable: true
type: boolean
is_self_employed_or_partner:
type: boolean
is_tax_residence_in_swiss:
type: boolean
is_tax_residence_in_usa:
type: boolean
language:
allOf:
- $ref: '#/components/schemas/Language'
nullable: true
last_active:
format: date-time
readOnly: true
type: string
last_name:
maxLength: 128
type: string
legal_status_type:
allOf:
- $ref: '#/components/schemas/LegalStatusType'
nullable: true
legitimisation_type:
allOf:
- $ref: '#/components/schemas/LegitimisationType'
nullable: true
lender_onboarding_status:
allOf:
- $ref: '#/components/schemas/LenderOnboardingStatus'
nullable: true
living_status:
allOf:
- $ref: '#/components/schemas/LivingStatus'
nullable: true
local_bank_account:
maxLength: 64
type: string
maiden_name:
maxLength: 128
type: string
middle_name:
maxLength: 64
type: string
mother_maiden_name:
maxLength: 128
type: string
national_number:
maxLength: 32
type: string
nationality:
allOf:
- $ref: '#/components/schemas/Country'
nullable: true
neak_oep_certificate_date:
format: date
nullable: true
type: string
number_of_dependent_persons_with_income:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
number_of_dependent_persons_with_no_income:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
number_of_dependents:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
number_of_fetuses_gte_twelve_weeks:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
number_of_income_earners_in_the_household:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
onboarding_redirection_url:
format: uri
maxLength: 200
type: string
people_in_household:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
type: array
planned_children:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
politically_exposed_person_country:
allOf:
- $ref: '#/components/schemas/Country'
nullable: true
politically_exposed_person_declaration_date:
format: date
nullable: true
type: string
politically_exposed_person_type:
allOf:
- $ref: '#/components/schemas/PoliticallyExposedPersonType'
nullable: true
position:
type: string
recent_bankruptcy:
type: boolean
recent_collections:
type: boolean
reference_number:
readOnly: true
type: string
relationships:
items:
$ref: '#/components/schemas/Client2Client'
type: array
residence_permit:
allOf:
- $ref: '#/components/schemas/ResidencePermit'
nullable: true
residence_start_date:
format: date
nullable: true
type: string
role:
$ref: '#/components/schemas/ClientRoleType'
sector:
allOf:
- $ref: '#/components/schemas/Sector'
nullable: true
segment:
allOf:
- $ref: '#/components/schemas/CustomerSegment'
nullable: true
sex:
allOf:
- $ref: '#/components/schemas/Sex'
nullable: true
social_insurance_start_date:
allOf:
- $ref: '#/components/schemas/SocialInsuranceStartDate'
nullable: true
tax_id:
maxLength: 32
type: string
tax_type:
allOf:
- $ref: '#/components/schemas/TaxType'
nullable: true
title:
allOf:
- $ref: '#/components/schemas/ClientTitle'
nullable: true
title_2:
allOf:
- $ref: '#/components/schemas/ClientTitle'
nullable: true
verified:
readOnly: true
type: boolean
version:
maximum: 2147483647
minimum: 0
type: integer
required:
- created_by
- emails
- last_active
- reference_number
- role
- verified
type: object
LandPurchaseType:
description: Can be managed at /resources/land-purchase-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
PoliticallyExposedPersonType:
description: Can be managed at /resources/politically-exposed-person-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
LoanRequestObjective:
properties:
id:
readOnly: true
type: integer
is_main:
type: boolean
purpose:
$ref: '#/components/schemas/LoanRequestPurpose'
required:
- id
- purpose
type: object
RealtyPurpose:
description: Can be managed at /resources/realty-purpose
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
NestedRenovation:
properties:
amount_contractor:
format: double
type: number
amount_diy:
format: double
type: number
id:
readOnly: true
type: integer
is_amount_distribution_confirmed:
type: boolean
oper_reference:
format: uuid
readOnly: true
type: string
renovation_type:
$ref: '#/components/schemas/RenovationType'
total_amount_from_simulation:
format: double
type: number
required:
- id
- oper_reference
- renovation_type
type: object
PhoneCountryCode:
description: Can be managed at /resources/phone-country-code
properties:
country:
readOnly: true
type: string
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- country
- definition
- id
- order
type: object
Periodicity:
description: Can be managed at /resources/periodicity
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
IdDocumentType:
description: Can be managed at /resources/id-document-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
EducationType:
description: Can be managed at /resources/education
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
StatusChangeEvaluation:
properties:
conditions:
items:
$ref: '#/components/schemas/StatusChangeConditionEvaluation'
readOnly: true
type: array
created:
format: date-time
readOnly: true
title: Creation date and time
type: string
next_status:
allOf:
- $ref: '#/components/schemas/Status'
readOnly: true
start_status:
allOf:
- $ref: '#/components/schemas/Status'
readOnly: true
required:
- conditions
- created
- next_status
- start_status
type: object
ComfortType:
description: Can be managed at /resources/comfort-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
LocalizedBorrowerNotification:
properties:
created:
format: date-time
readOnly: true
title: Creation date and time
type: string
id:
readOnly: true
type: integer
language:
allOf:
- $ref: '#/components/schemas/Language'
readOnly: true
message:
readOnly: true
type: string
subject:
readOnly: true
type: string
required:
- created
- id
- language
- message
- subject
type: object
DisbursementSchedule:
description: Can be managed at /resources/disbursement-schedule
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
Sector:
description: Can be managed at /resources/sector
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
LoanRequestType:
description: Can be managed at /resources/loan-request-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
Profile2Address:
properties:
address_type:
allOf:
- $ref: '#/components/schemas/ContactType'
nullable: true
box:
type: string
building:
type: string
city:
type: string
country:
$ref: '#/components/schemas/Country'
floor:
type: string
heading:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
house_number:
type: string
latitude:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
longitude:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
pitch:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
staircase:
type: string
street:
type: string
street_type:
allOf:
- $ref: '#/components/schemas/StreetType'
nullable: true
zip_code:
type: string
zoom:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
required:
- city
- country
- street
- zip_code
type: object
LivingStatus:
description: Can be managed at /resources/living-status
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
StreetType:
description: Can be managed at /resources/street-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ConditionFunctionName:
description: Can be managed at /resources/condition-function-name
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
NewRealtyOption:
description: Can be managed at /resources/new-realty-option
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
FinancialPlanLoanAmountItem:
properties:
amount:
format: double
type: number
created:
format: date-time
readOnly: true
title: Creation date and time
type: string
financial_plan_loan_amount_field:
allOf:
- $ref: '#/components/schemas/FinancialPlanLoanAmountField'
readOnly: true
id:
type: integer
is_overridden:
type: boolean
loan_request:
readOnly: true
type: integer
required:
- created
- financial_plan_loan_amount_field
- id
- loan_request
type: object
Country:
description: Can be managed at /resources/country
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
RealtyType:
description: Can be managed at /resources/realty-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
Sex:
description: Can be managed at /resources/sex
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
NestedRealtyObjective:
properties:
id:
readOnly: true
type: integer
purpose:
$ref: '#/components/schemas/RealtyPurpose'
required:
- id
- purpose
type: object
FinancialPlanLoanAmountType:
description: Can be managed at /resources/financial-plan-loan-amount-type
properties:
color:
readOnly: true
type: string
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- color
- definition
- id
- order
type: object
FsmaStatus:
description: Can be managed at /resources/fsma-status
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
Profile2Phone:
properties:
country_code:
$ref: '#/components/schemas/PhoneCountryCode'
is_secret:
default: false
type: boolean
phone_type:
$ref: '#/components/schemas/ContactType'
value:
maxLength: 32
minLength: 4
type: string
required:
- value
type: object
PurchaseSaleType:
description: Can be managed at /resources/purchase-sale-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
DetailedLeadGenerator:
description: "Baseclass for Reduced serializers.\n\nWill validate whether the objects exists, and returns the instance in to_internal_value\nSubclasses must implement Meta with at least the model and field attributes\n\nRaises\n------\n Validations errors if the object doesn't exist\n OperBadConfigurationException if the model isn't set"
properties:
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
readOnly: true
type: array
bank_account:
readOnly: true
type: string
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
emails:
items:
$ref: '#/components/schemas/Profile2Email'
readOnly: true
type: array
id:
type: integer
name:
readOnly: true
type: string
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
readOnly: true
type: array
vat_number:
readOnly: true
type: string
required:
- addresses
- bank_account
- company_type
- emails
- id
- name
- phone_numbers
- vat_number
type: object
TaxType:
description: Can be managed at /resources/tax-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ParticipantAuthorization:
description: Can be managed at /resources/participant-authorization
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
BorrowerNotification:
properties:
created:
format: date-time
readOnly: true
title: Creation date and time
type: string
deadline:
format: date-time
nullable: true
readOnly: true
type: string
has_read:
type: boolean
id:
readOnly: true
type: integer
loan_request:
readOnly: true
type: integer
localized_notifications:
items:
$ref: '#/components/schemas/LocalizedBorrowerNotification'
readOnly: true
type: array
redirection_path:
nullable: true
readOnly: true
type: string
required:
- created
- deadline
- id
- loan_request
- localized_notifications
- redirection_path
type: object
FinancialPlanOwnFundField:
properties:
external_calculator_type:
$ref: '#/components/schemas/ExternalCalculatorType'
id:
readOnly: true
type: integer
is_calculated:
type: boolean
is_default:
type: boolean
is_loan_needed:
type: boolean
is_main:
type: boolean
is_overridable:
type: boolean
is_visible:
type: boolean
own_fund_type:
$ref: '#/components/schemas/FinancialPlanOwnFundType'
required:
- id
- own_fund_type
type: object
IncomeType:
description: Can be managed at /resources/income-type
properties:
color:
readOnly: true
type: string
definition:
type: string
form_template:
readOnly: true
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- color
- definition
- form_template
- id
- order
type: object
FinancialPlanLoanAmountField:
properties:
default_duration:
maximum: 2147483647
minimum: -2147483648
nullable: true
type: integer
default_rate:
format: double
nullable: true
type: number
external_calculator_type:
$ref: '#/components/schemas/Exter
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oper/refs/heads/main/openapi/oper-loan-requests-client-info-api-openapi.yml