Oper Credits Loan Requests Client Info API
The Loan Requests Client Info API from Oper Credits — 1 operation(s) for loan requests client info.
OpenAPI Specification
openapi: 3.0.3
info:
title: Oper Credits 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:
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
_LoanOffer:
properties:
created:
format: date-time
readOnly: true
title: Creation date and time
type: string
id:
readOnly: true
type: integer
internal_reference:
maxLength: 64
type: string
is_generated_from_loan_offer_invalidation:
type: boolean
status:
$ref: '#/components/schemas/LoanOfferStatus'
required:
- created
- id
- internal_reference
- status
type: object
PersonalizedInformation:
description: Can be managed at /resources/personalized-information
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
CustomerSegment:
description: Can be managed at /resources/customer-segment
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
StatusChangeType:
description: Can be managed at /resources/status-change-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
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
Relationship:
description: Can be managed at /resources/relationship
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- 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
StatusChangeConditionEvaluation:
properties:
is_completed:
readOnly: true
type: boolean
status_change_condition:
allOf:
- $ref: '#/components/schemas/StatusChangeCondition'
nullable: true
readOnly: true
required:
- is_completed
- status_change_condition
type: object
CoLivingGroupType:
description: Can be managed at /resources/co-living-group-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ClientRoleType:
description: Can be managed at /resources/client-role
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
CivilStatus:
description: Can be managed at /resources/civil-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
ReducedEstimator:
description: Estimator reduced representation
properties:
bank_account:
readOnly: true
type: string
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
fsma_reference:
nullable: true
readOnly: true
type: string
id:
type: integer
name:
readOnly: true
type: string
vat_number:
readOnly: true
type: string
required:
- bank_account
- company_type
- fsma_reference
- id
- name
- vat_number
type: object
AcquisitionSource:
description: Can be managed at /resources/acquisition-source
properties:
definition:
type: string
id:
type: integer
online:
readOnly: true
type: boolean
order:
readOnly: true
type: integer
required:
- definition
- id
- online
- order
type: object
LoanRequestPurpose:
description: Can be managed at /resources/loan-request-purpose
properties:
definition:
type: string
id:
type: integer
is_simulator_enabled:
type: boolean
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
HistoryType:
description: Can be managed at /resources/history-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
CompanyType:
description: Can be managed at /resources/company-types
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
BankBranch:
description: Can be managed at /resources/bank-branch
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
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
EnergyRating:
description: Can be managed at /resources/energy-rating
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
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
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
LoanRequestSource:
description: Can be managed at /resources/loan-request-source
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ReducedCreditProvider:
description: To be used for a short summary of the CreditProvider
properties:
active:
readOnly: true
type: boolean
fsma_reference:
maxLength: 128
readOnly: true
type: string
full_name:
readOnly: true
type: string
id:
type: integer
is_liability_provider:
readOnly: true
type: boolean
loan_request_form_documents:
readOnly: true
type: string
logo_url:
format: uri
readOnly: true
type: string
name:
readOnly: true
type: string
order:
maximum: 2147483647
minimum: 0
nullable: true
readOnly: true
type: integer
required:
- active
- fsma_reference
- full_name
- id
- is_liability_provider
- loan_request_form_documents
- logo_url
- name
- order
type: object
RealtyAcquisitionType:
description: Can be managed at /resources/realty-acquisition-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
LoanOfferStatus:
description: Can be managed at /resources/loan-offer-status
properties:
color:
maxLength: 7
type: string
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ReducedBaseUser:
description: User reduced representation
properties:
first_name:
default: ''
readOnly: true
type: string
id:
type: integer
last_name:
default: ''
readOnly: true
type: string
role:
allOf:
- $ref: '#/components/schemas/UserRole'
readOnly: true
verified:
readOnly: true
type: boolean
required:
- first_name
- id
- last_name
- role
- verified
type: object
DetailedBroker:
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:
account_manager:
allOf:
- $ref: '#/components/schemas/ReducedBaseUser'
nullable: true
readOnly: true
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
readOnly: true
type: array
ancestor_brokers:
items:
$ref: '#/components/schemas/Broker'
readOnly: true
type: array
bank_account:
readOnly: true
type: string
co_brokers:
items:
$ref: '#/components/schemas/Broker'
readOnly: true
type: array
commission_email:
allOf:
- $ref: '#/components/schemas/Profile2Email'
readOnly: true
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
confiscate_commission:
readOnly: true
type: boolean
emails:
items:
$ref: '#/components/schemas/Profile2Email'
readOnly: true
type: array
fsma_reference:
nullable: true
readOnly: true
type: string
fsma_status:
allOf:
- $ref: '#/components/schemas/FsmaStatus'
nullable: true
readOnly: true
id:
type: integer
legal_address:
allOf:
- $ref: '#/components/schemas/Profile2Address'
readOnly: true
main_contact:
allOf:
- $ref: '#/components/schemas/BaseUserProfileWithContacts'
readOnly: true
name:
readOnly: true
type: string
outstanding_debt:
format: double
readOnly: true
type: number
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
readOnly: true
type: array
sector:
allOf:
- $ref: '#/components/schemas/Sector'
nullable: true
readOnly: true
vat_number:
readOnly: true
type: string
required:
- account_manager
- addresses
- ancestor_brokers
- bank_account
- co_brokers
- commission_email
- company_type
- confiscate_commission
- emails
- fsma_reference
- fsma_status
- id
- legal_address
- main_contact
- name
- outstanding_debt
- phone_numbers
- sector
- vat_number
type: object
Broker:
properties:
account_manager:
allOf:
- $ref: '#/components/schemas/ReducedBaseUser'
nullable: true
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
type: array
bank_account:
type: string
commission_email:
allOf:
- $ref: '#/components/schemas/Profile2Email'
readOnly: true
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
confiscate_commission:
type: boolean
emails:
items:
$ref: '#/components/schemas/Profile2Email'
type: array
fsma_reference:
nullable: true
type: string
fsma_status:
allOf:
- $ref: '#/components/schemas/FsmaStatus'
nullable: true
id:
readOnly: true
type: integer
legal_address:
allOf:
- $ref: '#/components/schemas/Profile2Address'
readOnly: true
main_contact:
allOf:
- $ref: '#/components/schemas/BaseUserProfileWithContacts'
readOnly: true
name:
type: string
outstanding_debt:
format: double
readOnly: true
type: number
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
type: array
sector:
allOf:
- $ref: '#/components/schemas/Sector'
nullable: true
vat_number:
type: string
required:
- addresses
- commission_email
- emails
- id
- legal_address
- main_contact
- name
- outstanding_debt
- phone_numbers
- vat_number
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
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
HistoryLogLevel:
description: Can be managed at /resources/history-log-level
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ReducedLoanRequest:
description: Loan request reduced representation
properties:
borrower_reference:
readOnly: true
type: string
external_reference:
readOnly: true
type: string
id:
type: integer
internal_reference:
readOnly: true
type: string
status:
allOf:
- $ref: '#/components/schemas/Status'
readOnly: true
required:
- borrower_reference
- external_reference
- id
- internal_reference
- status
type: object
CommunityPropertyInvolvement:
description: Can be managed at /resources/community-property-involvement
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ContactType:
description: Can be managed at /resources/contact-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
Language:
description: Can be managed at /resources/language
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
BaseUserProfileWithContacts:
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:
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
type: array
emails:
items:
$ref: '#/components/schemas/Profile2Email'
type: array
first_name:
type: string
id:
readOnly: true
type: integer
last_name:
type: string
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
type: array
profile:
allOf:
- $ref: '#/components/schemas/BaseUserProfile'
writeOnly: true
required:
- addresses
- emails
- first_name
- id
- last_name
- phone_numbers
type: object
OtherCreditProviderRequest:
description: Other credit providers for the loan request
properties:
amount:
format: double
type: number
application_date:
format: date
type: string
credit_provider:
$ref: '#/components/schemas/ReducedCreditProvider'
id:
readOnly: true
type: integer
offer_received:
type: boolean
required:
- amount
- application_date
- credit_provider
- id
- offer_received
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
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
RealtyUsageType:
description: Can be managed at /resources/realty-usage-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
RedirectionPath:
description: Can be managed at /resources/redirection-path
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
NonRequiredAddress:
description: 'Inheriting from base address serializer and set with a few optional
fields. Use this serializer to add any future non required fields.'
properties:
box:
maxLength: 64
type: string
building:
type: string
city:
maxLength: 64
type: string
country:
allOf:
- $ref: '#/components/schemas/Country'
nullable: true
floor:
maxLength: 64
type: string
heading:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
house_number:
maxLength: 64
type: string
id:
readOnly: true
type: integer
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:
maxLength: 64
type: string
street_type:
allOf:
- $ref: '#/components/schemas/StreetType'
nullable: true
zip_code:
maxLength: 8
type: string
zoom:
exclusiveMaximum: true
exclusiveMinimum: true
format: double
maximum: 100000
minimum: -100000
nullable: true
type: number
required:
- city
- house_number
- id
- street
- zip_code
type: object
DocumentType:
description: Can be managed at /resources/document-type
properties:
add_to_handover_letter:
type: boolean
allows_generation:
type: boolean
append_file_version:
type: boolean
can_be_added_manually_as_informative_document:
type: boolean
definition:
type: string
document_generation_configuration: {}
id:
type: integer
is_informative:
type: boolean
is_proof_to_sign:
type: boolean
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
LegalStatusType:
description: Can be managed at /resources/legal-status-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
ReducedClientProfile:
description: Client profile reduced representation
properties:
first_name:
maxLength: 64
readOnly: true
type: string
id:
type: integer
last_name:
maxLength: 128
readOnly: true
type: string
required:
- first_name
- id
- last_name
type: object
LenderOnboardingStatus:
description: Can be managed at /resources/lender-onboarding-status
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
EmploymentType:
description: Can be managed at /resources/employment-type
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
LoanRequestClientRealty:
properties:
acquisition_source:
allOf:
- $ref: '#/components/schemas/AcquisitionSource'
nullable: true
action_required:
type: boolean
analyst:
allOf:
- $ref: '#/components/schemas/ReducedBaseUser'
nullable: true
anonymized:
type: boolean
approval_options:
items:
additionalProperties: {}
type: object
readOnly: true
type: array
bank_branch:
allOf:
- $ref: '#/components/schemas/BankBranch'
nullable: true
borrower_notifications:
items:
$ref: '#/components/schemas/BorrowerNotification'
type: array
borrower_reference:
description: Borrowers first and last names
readOnly: true
type: string
broker:
allOf:
- $ref: '#/components/schemas/DetailedBroker'
nullable: true
business_capital:
format: double
type: number
business_capital_overridden:
type: boolean
client:
allOf:
- $ref: '#/components/sc
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oper-credits/refs/heads/main/openapi/oper-credits-loan-requests-client-info-api-openapi.yml