Oper Loan Requests API
The Loan Requests API from Oper — 113 operation(s) for loan requests.
The Loan Requests API from Oper — 113 operation(s) for loan requests.
openapi: 3.0.3
info:
title: Oper Agent Documents Loan Requests API
version: ''
tags:
- name: Loan Requests
paths:
/api/loan-requests/:
get:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_list
parameters:
- in: query
name: analyst
schema:
type: integer
- in: query
name: analyst_or_owner
schema:
type: string
- in: query
name: anonymized
schema:
type: boolean
- explode: true
in: query
name: broker
schema:
items:
type: integer
type: array
style: form
- in: query
name: created_date_end
schema:
format: date
type: string
- in: query
name: created_date_start
schema:
format: date
type: string
- in: query
name: date_submission_end
schema:
format: date
type: string
- in: query
name: date_submission_start
schema:
format: date
type: string
- in: query
name: deed_date_end
schema:
format: date
type: string
- in: query
name: deed_date_start
schema:
format: date
type: string
- in: query
name: external_metadata
schema: {}
- in: query
name: loan_request_type
schema:
type: string
- in: query
name: owner
schema:
type: integer
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: A search term.
in: query
name: search
required: false
schema:
type: string
- in: query
name: status
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLoanRequestList'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
post:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LoanRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LoanRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/total-loan-amount/:
get:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_total_loan_amount_retrieve
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/transfer-blocked:
get:
operationId: api_loan_requests_transfer_blocked_retrieve
responses:
'200':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{id}/:
delete:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_destroy
parameters:
- description: If 'true', deletes all related data connected to this Loan Request.
examples:
DeleteRelatedFalse:
description: Only delete the loan request
value: 'false'
DeleteRelatedTrue:
description: Delete related objects
value: 'true'
in: query
name: delete-related
schema:
type: boolean
- description: A unique integer value identifying this Loan Request.
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
get:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_retrieve
parameters:
- description: A unique integer value identifying this Loan Request.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
patch:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_partial_update
parameters:
- description: A unique integer value identifying this Loan Request.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLoanRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLoanRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLoanRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
put:
description: 'Loan requests filtered on the role and relation to the user
via a ThirdParty or CreditProvider.'
operationId: api_loan_requests_update
parameters:
- description: A unique integer value identifying this Loan Request.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LoanRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LoanRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoanRequest'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/additional-financing-needs/:
get:
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_additional_financing_needs_list
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AdditionalFinancingNeed'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
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_additional_financing_needs_create
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
multipart/form-data:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/additional-financing-needs/{id}/:
delete:
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_additional_financing_needs_destroy
parameters:
- description: A unique integer value identifying this Additional Financing Need.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
get:
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_additional_financing_needs_retrieve
parameters:
- description: A unique integer value identifying this Additional Financing Need.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
patch:
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_additional_financing_needs_partial_update
parameters:
- description: A unique integer value identifying this Additional Financing Need.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAdditionalFinancingNeed'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAdditionalFinancingNeed'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAdditionalFinancingNeed'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
put:
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_additional_financing_needs_update
parameters:
- description: A unique integer value identifying this Additional Financing Need.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
multipart/form-data:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalFinancingNeed'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/assets/:
get:
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_assets_list
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExtendedFinancialAsset'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/bank-guarantees/:
get:
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_bank_guarantees_list
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BankGuarantee'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
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_bank_guarantees_create
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BankGuarantee'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BankGuarantee'
multipart/form-data:
schema:
$ref: '#/components/schemas/BankGuarantee'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BankGuarantee'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/bank-guarantees/{id}/:
delete:
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_bank_guarantees_destroy
parameters:
- description: A unique integer value identifying this Bank Guarantee.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
get:
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_bank_guarantees_retrieve
parameters:
- description: A unique integer value identifying this Bank Guarantee.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BankGuarantee'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
patch:
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_bank_guarantees_partial_update
parameters:
- description: A unique integer value identifying this Bank Guarantee.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBankGuarantee'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBankGuarantee'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBankGuarantee'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BankGuarantee'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
put:
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_bank_guarantees_update
parameters:
- description: A unique integer value identifying this Bank Guarantee.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BankGuarantee'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BankGuarantee'
multipart/form-data:
schema:
$ref: '#/components/schemas/BankGuarantee'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BankGuarantee'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/borrower_notifications/:
get:
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_borrower_notifications_list
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BorrowerNotification'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/borrower_notifications/{id}/:
get:
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_borrower_notifications_retrieve
parameters:
- in: path
name: id
required: true
schema:
type: string
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowerNotification'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
patch:
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_borrower_notifications_partial_update
parameters:
- in: path
name: id
required: true
schema:
type: string
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBorrowerNotification'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBorrowerNotification'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBorrowerNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowerNotification'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/clients/:
get:
description: Access all clients from a loan request
operationId: api_loan_requests_clients_retrieve
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'200':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
post:
description: Access all clients from a loan request
operationId: api_loan_requests_clients_create
parameters:
- in: path
name: loan_request_id
required: true
schema:
pattern: ^\d+$
type: string
responses:
'201':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/:
get:
description: 'Scopes a ViewSet''s data-broker queryset to the ClientProfiles the broker is
permitted to see: unowned clients, clients owned by the broker (or a
descendant broker) and clients the broker created.
Direct-FK ViewSets inherit ``get_queryset_for_data_broker`` unchanged.
ViewSets whose resource references the ClientProfile indirectly (e.g. a
generic foreign key) reuse ``_broker_client_ids`` and apply their own filter.'
operationId: api_loan_requests_clients_assets_list
parameters:
- in: path
name: client_id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/FinancialAsset'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
post:
description: 'Scopes a ViewSet''s data-broker queryset to the ClientProfiles the broker is
permitted to see: unowned clients, clients owned by the broker (or a
descendant broker) and clients the broker created.
Direct-FK ViewSets inherit ``get_queryset_for_data_broker`` unchanged.
ViewSets whose resource references the ClientProfile indirectly (e.g. a
generic foreign key) reuse ``_broker_client_ids`` and apply their own filter.'
operationId: api_loan_requests_clients_assets_create
parameters:
- in: path
name: client_id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialAsset'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinancialAsset'
multipart/form-data:
schema:
$ref: '#/components/schemas/FinancialAsset'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialAsset'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/{id}/:
delete:
description: 'Scopes a ViewSet''s data-broker queryset to the ClientProfiles the broker is
permitted to see: unowned clients, clients owned by the broker (or a
descendant broker) and clients the broker created.
Direct-FK ViewSets inherit ``get_queryset_for_data_broker`` unchanged.
ViewSets whose resource references the ClientProfile indirectly (e.g. a
generic foreign key) reuse ``_broker_client_ids`` and apply their own filter.'
operationId: api_loan_requests_clients_assets_destroy
parameters:
- in: path
name: client_id
required: true
schema:
type: integer
- description: A unique integer value identifying this Financial Asset.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Loan Requests
get:
description: 'Scopes a ViewSet''s data-broker queryset to the ClientProfiles the broker is
permitted to see: unowned clients, clients owned by the broker (or a
descendant broker) and clients the broker created.
Direct-FK ViewSets inherit ``get_queryset_for_data_broker`` unchanged.
ViewSets whose resource references the ClientProfile indirectly (e.g. a
generic foreign key) reuse ``_broker_client_ids`` and apply their own filter.'
operationId: api_loan_requests_clients_assets_retrieve
parameters:
- in: path
name: client_id
required: true
schema:
type: integer
- description: A unique integer value identifying this Financial Asset.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialAsset'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
patch:
description: 'Scopes a ViewSet''s data-broker queryset to the ClientProfiles the broker is
permitted to see: unowned clients, clients owned by the broker (or a
descendant broker) and clients the broker created.
Direct-FK ViewSets inherit ``get_queryset_for_data_broker`` unchanged.
ViewSets whose resource references the ClientProfile indirectly (e.g. a
generic foreign key) reuse ``_broker_client_ids`` and apply their own filter.'
operationId: api_loan_requests_clients_assets_partial_update
parameters:
- in: path
name: client_id
required: true
schema:
type: integer
- description: A unique integer value identifying this Financial Asset.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFinancialAsset'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFinancialAsset'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFinancialAsset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialAsset'
description: ''
security:
- jwtAuth: []
tags:
- Loan Requests
put:
description: 'Scopes a ViewSet''s data-broker queryset to the ClientProfiles the broker is
permitted to see: unowned clients, clients owned by the broker (or a
descendant broker) and clients the broker created.
Direct-FK ViewSets inherit ``get_queryset_for_data_broker`` unchanged.
ViewSets whose resource references the ClientProfile indirectly (e.g. a
generic foreign key) reuse ``_broker_client_ids`` and apply their own filter.'
operationId: api_loan_requests_clients_assets_update
parameters:
- in: path
name: client_id
required: true
schema:
type: integer
- description: A unique integer value identifying this Financial Asset.
in: path
name: id
required: true
schema:
type: integer
- in: path
name: loan_request_id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FinancialAsset'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FinancialAsset'
multipart/form-data:
# --- truncated at 32 KB (496 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oper/refs/heads/main/openapi/oper-loan-requests-api-openapi.yml