Oper Credits Loan Requests API
The Loan Requests API from Oper Credits — 113 operation(s) for loan requests.
Oper Credits Loan Requests API is one of 52 APIs that Oper Credits publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Loan Requests. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 202 operations across 113 paths, and defines 307 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against the base URL https://developers.opercredits.com/.
202 operations
113 paths
307 schemas
21 DELETE86 GET25 PATCH47 POST23 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Oper Credits Loan Requests API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (jwtAuth).
Paths & Operations 202
Across 113 paths, the API surfaces 202 operations — 21 DELETE, 86 GET, 25 PATCH, 47 POST, 23 PUT. Each is listed below with its method, path, parameters, and response codes.
Loan Requests 202
GET
/api/loan-requests/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
POST
/api/loan-requests/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
GET
/api/loan-requests/total-loan-amount/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
GET
/api/loan-requests/transfer-blocked
DELETE
/api/loan-requests/{id}/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
GET
/api/loan-requests/{id}/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
PATCH
/api/loan-requests/{id}/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
PUT
/api/loan-requests/{id}/
Loan requests filtered on the role and relation to the user via a ThirdParty or CreditProvider.
GET
/api/loan-requests/{loan_request_id}/additional-financing-needs/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/additional-financing-needs/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/additional-financing-needs/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/additional-financing-needs/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/additional-financing-needs/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/additional-financing-needs/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/assets/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/bank-guarantees/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/bank-guarantees/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/bank-guarantees/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/bank-guarantees/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/bank-guarantees/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/bank-guarantees/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/borrower_notifications/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/borrower_notifications/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/borrower_notifications/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/clients/
Access all clients from a loan request
POST
/api/loan-requests/{loan_request_id}/clients/
Access all clients from a loan request
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/
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. Dir…
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/
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. Dir…
DELETE
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/{id}/
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. Dir…
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/{id}/
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. Dir…
PATCH
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/{id}/
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. Dir…
PUT
/api/loan-requests/{loan_request_id}/clients/{client_id}/assets/{id}/
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. Dir…
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/external_references/
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. Dir…
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/external_references/
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. Dir…
DELETE
/api/loan-requests/{loan_request_id}/clients/{client_id}/external_references/{id}/
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. Dir…
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/external_references/{id}/
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. Dir…
PATCH
/api/loan-requests/{loan_request_id}/clients/{client_id}/external_references/{id}/
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. Dir…
PUT
/api/loan-requests/{loan_request_id}/clients/{client_id}/external_references/{id}/
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. Dir…
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/incomes/
Incomes filtered by Client creator
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/incomes/
Incomes filtered by Client creator
DELETE
/api/loan-requests/{loan_request_id}/clients/{client_id}/incomes/{id}/
Incomes filtered by Client creator
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/incomes/{id}/
Incomes filtered by Client creator
PATCH
/api/loan-requests/{loan_request_id}/clients/{client_id}/incomes/{id}/
Incomes filtered by Client creator
PUT
/api/loan-requests/{loan_request_id}/clients/{client_id}/incomes/{id}/
Incomes filtered by Client creator
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/invite-link/
Returns invite URL without sending email - for QR code/manual sharing.
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/invite/
Allows an agent in the brokerage app to send an invite to the client to provide him access to the self-service portal. So from a functional point of view, it will only be called from the brokerage de…
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/
Liabilities filtered by Client creator
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/
Liabilities filtered by Client creator
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/batch-update/
Liabilities filtered by Client creator
DELETE
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/{id}/
Liabilities filtered by Client creator
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/{id}/
Liabilities filtered by Client creator
PATCH
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/{id}/
Liabilities filtered by Client creator
PUT
/api/loan-requests/{loan_request_id}/clients/{client_id}/liabilities/{id}/
Liabilities filtered by Client creator
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/relationships/
Client Relationships filtered by Client Profiles creator (both sides of the relationship)
POST
/api/loan-requests/{loan_request_id}/clients/{client_id}/relationships/
Client Relationships filtered by Client Profiles creator (both sides of the relationship)
DELETE
/api/loan-requests/{loan_request_id}/clients/{client_id}/relationships/{id}/
Client Relationships filtered by Client Profiles creator (both sides of the relationship)
GET
/api/loan-requests/{loan_request_id}/clients/{client_id}/relationships/{id}/
Client Relationships filtered by Client Profiles creator (both sides of the relationship)
PATCH
/api/loan-requests/{loan_request_id}/clients/{client_id}/relationships/{id}/
Client Relationships filtered by Client Profiles creator (both sides of the relationship)
PUT
/api/loan-requests/{loan_request_id}/clients/{client_id}/relationships/{id}/
Client Relationships filtered by Client Profiles creator (both sides of the relationship)
DELETE
/api/loan-requests/{loan_request_id}/clients/{id}/
Access all clients from a loan request
GET
/api/loan-requests/{loan_request_id}/clients/{id}/
Access all clients from a loan request
PATCH
/api/loan-requests/{loan_request_id}/clients/{id}/
Access all clients from a loan request
PUT
/api/loan-requests/{loan_request_id}/clients/{id}/
Access all clients from a loan request
GET
/api/loan-requests/{loan_request_id}/comments/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/comments/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/comments/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/comments/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/comments/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/comments/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/compliance-checks/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/compliance-checks/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/compliance-checks/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/consultations/
POST
/api/loan-requests/{loan_request_id}/consultations/
GET
/api/loan-requests/{loan_request_id}/consultations/{id}/
GET
/api/loan-requests/{loan_request_id}/contact-details/
GET
/api/loan-requests/{loan_request_id}/data-connections/
The data connection object represents the state of a data connection in a third-party system, which has been initiated by sending the loan request information from Oper to the third-party system. Suc…
GET
/api/loan-requests/{loan_request_id}/data-connections/{id}/
The data connection object represents the state of a data connection in a third-party system, which has been initiated by sending the loan request information from Oper to the third-party system. Suc…
PATCH
/api/loan-requests/{loan_request_id}/data-connections/{id}/
The data connection object represents the state of a data connection in a third-party system, which has been initiated by sending the loan request information from Oper to the third-party system. Suc…
PUT
/api/loan-requests/{loan_request_id}/data-connections/{id}/
The data connection object represents the state of a data connection in a third-party system, which has been initiated by sending the loan request information from Oper to the third-party system. Suc…
POST
/api/loan-requests/{loan_request_id}/data-push/
Adds any permissions in self.namedpermissions to a NamedPermissionChecker
GET
/api/loan-requests/{loan_request_id}/decisions/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/decisions/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/decisions/allowed-decision-types/
Returns allowed decision types based on user permissions.
GET
/api/loan-requests/{loan_request_id}/decisions/required/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/decisions/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/declarations/
A ViewSet mixin that parametrizes DRF methods over roles
POST
/api/loan-requests/{loan_request_id}/declarations/create/
A ViewSet mixin that parametrizes DRF methods over roles
GET
/api/loan-requests/{loan_request_id}/declarations/preview-payload/
A ViewSet mixin that parametrizes DRF methods over roles
GET
/api/loan-requests/{loan_request_id}/declarations/{id}/
A ViewSet mixin that parametrizes DRF methods over roles
POST
/api/loan-requests/{loan_request_id}/declarations/{id}/check-status/
A ViewSet mixin that parametrizes DRF methods over roles
POST
/api/loan-requests/{loan_request_id}/declarations/{id}/delete-instruments/
A ViewSet mixin that parametrizes DRF methods over roles
POST
/api/loan-requests/{loan_request_id}/declarations/{id}/validation-report/
A ViewSet mixin that parametrizes DRF methods over roles
GET
/api/loan-requests/{loan_request_id}/discounts/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/documents-push/
Push Loan request documents to an Integrator
GET
/api/loan-requests/{loan_request_id}/documents/
Documents filtered by Loan request
POST
/api/loan-requests/{loan_request_id}/documents/
Documents filtered by Loan request
DELETE
/api/loan-requests/{loan_request_id}/documents/{id}/
Documents filtered by Loan request
GET
/api/loan-requests/{loan_request_id}/documents/{id}/
Documents filtered by Loan request
GET
/api/loan-requests/{loan_request_id}/dynamic-fields-access-config/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/esignature/
Adds any permissions in self.extrapermission to the permission classes. Useful because then you can keep using the default permissions but extend them with extra permissions
POST
/api/loan-requests/{loan_request_id}/esignature/webhook-callback/
Adds any permissions in self.extrapermission to the permission classes. Useful because then you can keep using the default permissions but extend them with extra permissions
GET
/api/loan-requests/{loan_request_id}/external_references/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/external_references/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/external_references/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/external_references/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/external_references/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/external_references/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/fact-check/
Provides an endpoint to retrieve fact-check results for a loan request.
GET
/api/loan-requests/{loan_request_id}/financed-items/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/fire-insurances/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/fire-insurances/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/fire-insurances/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/fire-insurances/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/fire-insurances/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/fire-insurances/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/force-update-status/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/generate-documents/
Adds any permissions in self.extrapermission to the permission classes. Useful because then you can keep using the default permissions but extend them with extra permissions
POST
/api/loan-requests/{loan_request_id}/generate-documents/json/
ViewSet to get the raw json for generated document. Should not be used in production.
GET
/api/loan-requests/{loan_request_id}/guarantees/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/guarantees/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/guarantees/automated/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/guarantees/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/guarantees/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/guarantees/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/guarantees/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/history/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/history/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/insurance-simulations/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/insurance-simulations/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/insurance-simulations/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/insurance-simulations/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/insurance-simulations/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/insurance-simulations/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/liability-insurances/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/liability-insurances/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/liability-insurances/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/liability-insurances/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/liability-insurances/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/liability-insurances/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/milestones/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/milestones/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/milestones/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/offers/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/offers/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/offers/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/offers/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/offers/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/offers/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/offers/{id}/missing-data/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/offers/{offer_id}/akr-belq-override/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/offers/{offer_id}/akr-belq-override/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/offers/{offer_id}/akr-belq-override/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/offers/{offer_id}/akr-override/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/offers/{offer_id}/akr-override/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/offers/{offer_id}/akr-override/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/pre-approval/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/pre-approval/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/proof-download/
Documents as zip files filtered by Loan request
GET
/api/loan-requests/{loan_request_id}/proof-download/{loan_request_id}/
Documents as zip files filtered by Loan request
GET
/api/loan-requests/{loan_request_id}/proof/
Proof instance objects associated to a loan request
POST
/api/loan-requests/{loan_request_id}/proof/realty/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/allowed-document-types/
Document types allowed to add
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/allowed-document-types/{id}/
Document types allowed to add
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/
Posting a document, will require a new document for the loan request.
POST
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/bulk-create/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/merge/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{document_proof_object_id}/ai_verifications/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{document_proof_object_id}/ai_verifications/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{document_proof_object_id}/ai_verifications/{id}/
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 getbasequeryset
DELETE
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{id}/
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 getbasequeryset
PATCH
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{id}/
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 getbasequeryset
PUT
/api/loan-requests/{loan_request_id}/proof/{category_id}/documents/{id}/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/informative-document-types/
Informative document types
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/informative-document-types/{id}/
Informative document types
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/signed-document-types/
Signed document types
GET
/api/loan-requests/{loan_request_id}/proof/{category_id}/signed-document-types/{id}/
Signed document types
GET
/api/loan-requests/{loan_request_id}/proof/{id}/
Proof instance objects associated to a loan request
POST
/api/loan-requests/{loan_request_id}/proofs-share/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/realties/
Access all realties from a loan request
POST
/api/loan-requests/{loan_request_id}/realties/
Access all realties from a loan request
DELETE
/api/loan-requests/{loan_request_id}/realties/{id}/
Access all realties from a loan request
GET
/api/loan-requests/{loan_request_id}/realties/{id}/
Access all realties from a loan request
PATCH
/api/loan-requests/{loan_request_id}/realties/{id}/
Access all realties from a loan request
PUT
/api/loan-requests/{loan_request_id}/realties/{id}/
Access all realties from a loan request
GET
/api/loan-requests/{loan_request_id}/realties/{id}/collateral-ownership/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/realties/{id}/collateral-ownership/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/realties/{id}/valuation-report/download-url/
Return a fresh signed download URL for the realty's valuation report. Resolves the latest RealtyValuation with an externalservice set (currently Rock Estate is the only configured one), then the most…
GET
/api/loan-requests/{loan_request_id}/realties/{id}/valuation-report/status/
Access all realties from a loan request
POST
/api/loan-requests/{loan_request_id}/realties/{id}/valuation-report/upload/
Access all realties from a loan request
POST
/api/loan-requests/{loan_request_id}/recommended-solutions/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/reset-status/
PATCH
/api/loan-requests/{loan_request_id}/reset-status/
POST
/api/loan-requests/{loan_request_id}/search/products/
The DynamicProductViewSet provides a way to fetch the list of available products enriched with data related to the loan request provided in the URL. It is used to select products to add to an offer a…
POST
/api/loan-requests/{loan_request_id}/search/products/{product_version_id}/
The DynamicProductViewSet provides a way to fetch the list of available products enriched with data related to the loan request provided in the URL. It is used to select products to add to an offer a…
PATCH
/api/loan-requests/{loan_request_id}/source-data-fields/{id}/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/status-change-validation/
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 getbasequeryset
GET
/api/loan-requests/{loan_request_id}/status-changes/
PATCH
/api/loan-requests/{loan_request_id}/toggle-cancel/
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 getbasequeryset
POST
/api/loan-requests/{loan_request_id}/tweak/products/
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 getbasequeryset
Schemas 307
The contract defines 307 schemas that model the data the API accepts and returns. The most detailed are LoanRequest (184 properties), PatchedLoanRequest (184 properties), PatchedSharedRealty (118 properties), SharedRealty (118 properties). Each schema is shown below with its type and property counts.
ProofInstance
object
10 properties
3 required
ReducedFinancedItemCreditToTakeoverTyped
ResetStatus
object
2 properties
2 required
StatusChangeType
object
Can be managed at /resources/status-change-type
3 properties
3 required
FsmaStatus
object
Can be managed at /resources/fsma-status
3 properties
3 required
Phone
object
3 properties
3 required
FinancialAssetUsageType
object
Can be managed at /resources/financial-asset-usage-type
3 properties
3 required
CoLivingGroupType
object
Can be managed at /resources/co-living-group-type
3 properties
3 required
LoanRequestGenericExternalReference
object
3 properties
3 required
GuaranteeType
object
Can be managed at /resources/guarantee-type
3 properties
3 required
CivilStatus
object
Can be managed at /resources/civil-status
3 properties
3 required
AcquisitionSource
object
Can be managed at /resources/acquisition-source
4 properties
4 required
LoanRequestPurpose
object
Can be managed at /resources/loan-request-purpose
4 properties
3 required
Consultation
object
12 properties
8 required
PatchedLoanRequestGenericExternalReference
object
3 properties
PolymorphicHistory
object
Serializer to handle multiple subclasses of another class - The parent class needs to set the name of the field in 'shapefield' in Meta (e.g. liabilitytype) -…
5 properties
5 required
DependentIncome
object
Gate the appliesduringretirement field behind brokerageenableappliesduringretirement: strip it from input and drop it from output while the flag is off, so it…
9 properties
8 required
PatchedLiability
PatchedLoanOffer
object
57 properties
ReducedFinancedItemRealtyTyped
DeclarationType
object
Serializers for all Enums. Must be subclassed to be used. All fields are readonly except for id & definition.
2 properties
2 required
CompanyType
object
Can be managed at /resources/company-types
3 properties
3 required
EnergyRating
object
Can be managed at /resources/energy-rating
3 properties
3 required
PatchedNoUrlDocumentProofObject
object
Same as the document proof object serializer without the url, mime type and generated document
13 properties
SocialInsuranceStartDate
object
Can be managed at /resources/social-insurance-start-date
3 properties
3 required
ReducedProductVersion
object
Used as a serializer mixin for filtering library documents
18 properties
18 required
ReducedRealtyAddress
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
2 properties
2 required
AdditionalFinancingNeedType
object
Can be managed at /resources/additional-financing-need-type
4 properties
3 required
AIVerificationType
object
Can be managed at /resources/ai-verification-type
3 properties
3 required
RentalLiability
object
10 properties
7 required
MissingDocumentsContainer
object
Container for the missing documents. The lists only contain values that have missing documents. Other are ignored (empty)
3 properties
3 required
HistoryLogLevel
object
Can be managed at /resources/history-log-level
3 properties
3 required
AlimonyLiabilityTyped
InsuranceSimulationStatus
object
Can be managed at /resources/insurance-simulation-status
3 properties
3 required
SharedRealty
object
118 properties
13 required
AllowedProductVariability
object
7 properties
2 required
LoanRequestGeneratedDocument
object
Serializer for signed urls for Generated documents.
11 properties
1 required
Notary
object
The same as ThirdPartySerializer but specifically for a Notary, without VAT, with bank account
10 properties
10 required
Enum
object
Serializer for enums. Not a model serializer because AbstractEnum is Abstract.
2 properties
2 required
RealtyUsageType
object
Can be managed at /resources/realty-usage-type
3 properties
3 required
LoanRequest
object
184 properties
28 required
NonRequiredAddress
object
Inheriting from base address serializer and set with a few optional fields. Use this serializer to add any future non required fields.
16 properties
5 required
DynamicProduct
object
29 properties
29 required
ComplianceSection
object
3 properties
3 required
Variability
object
Can be managed at /resources/variability
4 properties
3 required
ShareProofs
object
4 properties
3 required
EmploymentType
object
Can be managed at /resources/employment-type
3 properties
3 required
RentalLiabilityTyped
FinancialPlanLoanAmountField
object
12 properties
2 required
FinancialPlanOwnFundItem
object
6 properties
4 required
RealtyPurpose
object
Can be managed at /resources/realty-purpose
3 properties
3 required
Nested2ClientProfile
object
5 properties
5 required
NestedRealtyObjective
object
2 properties
2 required
DecisionEndpoint
object
12 properties
8 required
ConditionFunctionName
object
Can be managed at /resources/condition-function-name
3 properties
3 required
SourceDataField
object
4 properties
4 required
PatchedFinancialAsset
object
5 properties
Client2Client
object
6 properties
4 required
ComplianceQuestion
object
3 properties
3 required
NestedRenovation
object
7 properties
3 required
ClientTitle
object
Can be managed at /resources/client-title
3 properties
3 required
LoanRequestMilestoneItem
object
3 properties
2 required
ConstructionType
object
Can be managed at /resources/construction-type
3 properties
3 required
IntegrationAction
object
Can be managed at /resources/integration-action
3 properties
3 required
ACardDetails
object
Can be managed at /resources/a-card-details
3 properties
3 required
AmountType
object
Can be managed at /resources/amount-type
3 properties
3 required
DeclarationStatusEnum
string
REGISTERED - Registered ACCEPTED - Accepted PROCESSED - Processed REJECTED - Rejected FAILED - Failed STATUSCHECKFAILURE - Status Check Failure GETVALIDATIONFA…
Dependent
object
1 property
1 required
DetailedNotary
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
8 properties
8 required
ExternalCalculatorType
object
Can be managed at /resources/external-calculator-type
3 properties
3 required
ComplianceAnswerType
object
Can be managed at /resources/compliance-answer-type
3 properties
3 required
NewRealtyOption
object
Can be managed at /resources/new-realty-option
3 properties
3 required
ReducedInsuranceSimulation
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
2 properties
2 required
ReducedProofRequirement
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
1 property
1 required
PatchedLiabilityInsurance
object
14 properties
LandPurchaseType
object
Can be managed at /resources/land-purchase-type
3 properties
3 required
RealtyCollateralOwnerOutput
object
101 properties
6 required
ParameterType
object
Can be managed at /resources/parameter-type
3 properties
3 required
FinancialPlanOwnFundType
object
Can be managed at /resources/financial-plant-own-fund-type
4 properties
4 required
Status
object
Can be managed at /resources/status
11 properties
6 required
AlimonyLiability
object
11 properties
7 required
GuaranteeItem
object
3 properties
3 required
ReducedFinancedItemCreditToTakeover
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
8 properties
8 required
LoanType
object
Can be managed at /resources/loan-type
4 properties
3 required
ReducedProductItem
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
3 properties
3 required
BorrowerNotification
object
7 properties
6 required
DocumentStatus
object
Can be managed at /resources/document-status
3 properties
3 required
ConditionOfProperty
object
Can be managed at /resources/condition-of-property
3 properties
3 required
ComplianceAnswerFreeTextTyped
EmploymentContractType
object
Can be managed at /resources/employment-contract-type
3 properties
3 required
Profile2Phone
object
4 properties
1 required
ParticipantAuthorization
object
Can be managed at /resources/participant-authorization
3 properties
3 required
PersonalizedInformation
object
Can be managed at /resources/personalized-information
3 properties
3 required
PatchedClient2Client
object
6 properties
CustomerSegment
object
Can be managed at /resources/customer-segment
3 properties
3 required
EmploymentIncome
object
28 properties
7 required
Status7e0Enum
string
error - Error finished - Finished initialized - Initialized running - Running to be retried - To be retried
CreditLiabilityTyped
DownloadZippedDocuments
object
Zip file download
2 properties
2 required
PurchaseSaleType
object
Can be managed at /resources/purchase-sale-type
3 properties
3 required
ObjectComparison
object
3 properties
3 required
ConsultationReduced
object
12 properties
7 required
ProofAudience
object
Can be managed at /resources/proof-audience
3 properties
3 required
FinancialAsset
object
5 properties
3 required
StreetType
object
Can be managed at /resources/street-type
3 properties
3 required
ComplianceAnswerBooleanTyped
FinancedItemType
object
Can be managed at /resources/financed-item-type
3 properties
3 required
Product
object
4 properties
4 required
LiabilityType
object
Can be managed at /resources/liability-type
7 properties
5 required
EducationType
object
Can be managed at /resources/education
3 properties
3 required
LoanRequestSource
object
Can be managed at /resources/loan-request-source
3 properties
3 required
RealtyAcquisitionType
object
Can be managed at /resources/realty-acquisition-type
3 properties
3 required
LocalizedBorrowerNotification
object
5 properties
5 required
Integrator
object
9 properties
8 required
ReducedBaseUser
object
User reduced representation
5 properties
5 required
Broker
object
17 properties
10 required
LoanRequestType
object
Can be managed at /resources/loan-request-type
3 properties
3 required
ComfortType
object
Can be managed at /resources/comfort-type
3 properties
3 required
ProductItemCost
object
14 properties
10 required
Language
object
Can be managed at /resources/language
3 properties
3 required
SeverityType
object
Can be managed at /resources/severity-type
3 properties
3 required
ReducedStatusChangeCondition
object
1 property
1 required
CompanyProfileForEmploymentIncome
object
Employer company profile
20 properties
3 required
LivingStatus
object
Can be managed at /resources/living-status
3 properties
3 required
ProductItem
object
Surface the extra-margin override on a ProductItem-backed serializer. The host serializer must declare these fields (the mixin doesn't add them; a mixin's clas…
67 properties
38 required
LoanRequestDataConnection
object
15 properties
13 required
ReducedFinancedItemRealty
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
3 properties
3 required
CompanyTaxType
object
Can be managed at /resources/company-tax-type
3 properties
3 required
LegalStatusType
object
Can be managed at /resources/legal-status-type
3 properties
3 required
FactCheckResponse
object
2 properties
2 required
PatchedSourceDataField
object
4 properties
FiscalPurposeType
object
Can be managed at /resources/fiscal-purpose-type
3 properties
3 required
Address
object
16 properties
8 required
EmploymentIncomeTyped
DocumentAIVerification
object
11 properties
11 required
CreditTakeOver
object
Can be managed at /resources/credit-takeover
3 properties
3 required
PatchedGenericComment
object
Serializer to handle multiple subclasses of another class - The parent class needs to set the name of the field in 'shapefield' in Meta (e.g. liabilitytype) -…
8 properties
SharedAddressUniqueTogetherDisabled
object
Inheriting from base address serializer and set with a few optional fields. Use this serializer to add any future non required fields.
16 properties
6 required
OwnershipType
object
Can be managed at /resources/ownership-type
3 properties
3 required
ReducedBailiff
object
Bailiff reduced representation
6 properties
6 required
RentalIncome
object
12 properties
7 required
Profile2Email
object
2 properties
1 required
FinancialPlanLoanAmountType
object
Can be managed at /resources/financial-plan-loan-amount-type
4 properties
4 required
Discount2ndLevel
object
13 properties
9 required
StatusChangeEvaluation
object
4 properties
4 required
ComplianceAnswerBoolean
object
5 properties
5 required
ContactDetail
object
7 properties
7 required
HouseholdIncome
object
8 properties
8 required
FireInsurance
object
10 properties
5 required
BankGuarantee
object
10 properties
2 required
UserRole
object
Can be managed at /resources/user-role
3 properties
3 required
PatchedLoanRequestDataConnection
object
15 properties
Discount
object
8 properties
8 required
DocumentsPush
object
8 properties
6 required
PatchedFireInsurance
object
10 properties
ProductType
object
Can be managed at /resources/product-type
3 properties
3 required
CompanyProfile2Website
object
2 properties
1 required
PatchedLoanRequest
object
184 properties
FinancialPlanOwnFundField
object
9 properties
2 required
NestedBaseRate
object
4 properties
4 required
ProductCostPromotionType
object
Can be managed at /resources/product-cost-promotion-type
3 properties
3 required
LoanRequestObjective
object
3 properties
2 required
_LoanOffer
object
5 properties
4 required
Funder
object
2 properties
2 required
DataConnectionStatus
object
Can be managed at /resources/data-connection-status
3 properties
3 required
LoanRequestSubPurpose
object
Can be managed at /resources/loan-request-sub-purpose
5 properties
3 required
FinancialPlanLoanAmountItem
object
6 properties
4 required
Relationship
object
Can be managed at /resources/relationship
3 properties
3 required
DependentIncomeTyped
LoanRequestMilestoneType
object
Serializers for all Enums. Must be subclassed to be used. All fields are readonly except for id & definition.
3 properties
3 required
HouseholdIncomeTyped
ReducedEstimator
object
Estimator reduced representation
6 properties
6 required
ReducedRelatedRealty
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
2 properties
2 required
Sector
object
Can be managed at /resources/sector
3 properties
3 required
AnnualizationMethod
object
Can be managed at /resources/annualization-method
3 properties
3 required
Solution
object
1 property
1 required
PaginatedLoanRequestList
object
4 properties
2 required
BankBranch
object
Can be managed at /resources/bank-branch
3 properties
3 required
BaseUserProfile
object
Moves UniqueValidator's from the validation stage to the save stage. It solves the problem with nested validation for unique fields on update. If you want more…
11 properties
3 required
Email
object
Moves UniqueValidator's from the validation stage to the save stage. It solves the problem with nested validation for unique fields on update. If you want more…
2 properties
2 required
RealtyType
object
Can be managed at /resources/realty-type
3 properties
3 required
CreditLiability
object
32 properties
7 required
NotaryDocument
object
2 properties
2 required
DetailedBroker
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
19 properties
19 required
MinimalBaseProduct
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
1 property
1 required
MessageContent
object
2 properties
2 required
ComplianceAnswerSelect
object
5 properties
4 required
ReducedLibraryDocument
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
1 property
1 required
CommunityPropertyInvolvement
object
Can be managed at /resources/community-property-involvement
3 properties
3 required
MortgageRegistration
object
Serializer for MortgageRegistration information Requires a loan request as instance.
3 properties
3 required
ProofStatus
object
Can be managed at /resources/proof-status
3 properties
3 required
ExtendedFinancialAsset
object
6 properties
4 required
ComplianceAnswerMultiSelect
object
5 properties
5 required
PatchedAdditionalFinancingNeed
object
4 properties
ProductItemCostPromotion
object
3 properties
3 required
InsurancePackage
object
Can be managed at /resources/insurance-package
3 properties
3 required
ReducedClientProfile
object
Client profile reduced representation
3 properties
3 required
PatchedInsuranceSimulation
object
17 properties
Declaration
object
11 properties
7 required
PatchedSharedRealty
object
118 properties
ForceUpdateStatus
object
2 properties
RealtyProofInstance
object
13 properties
6 required
RealtyDocument
object
2 properties
2 required
Explanation
object
2 properties
2 required
FinancedItem
PatchedToggleCancel
object
2 properties
ClientDocument
object
3 properties
3 required
NumberOfClosedFinancialYears
object
Can be managed at /resources/number-of-closed-financial-years
3 properties
3 required
Parameter
object
3 properties
3 required
NestedClientProfile
object
10 properties
8 required
BaseProductDiscounts
object
To be used in the ProductItemSerializer
9 properties
9 required
Metric
object
2 properties
2 required
PatchedLoanRequestMilestoneItem
object
3 properties
ComplianceCheck
object
5 properties
5 required
ComplianceAnswerSelectTyped
ResidencePermit
object
Can be managed at /resources/residence-permit
3 properties
3 required
LoanRequestDocument
object
19 properties
11 required
ReducedBroker
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
8 properties
8 required
DisbursementSchedule
object
Can be managed at /resources/disbursement-schedule
3 properties
3 required
RentalIncomeTyped
RenovationType
object
Can be managed at /resources/renovation-type
3 properties
3 required
DocumentSelection
object
2 properties
2 required
DetailedLeadGenerator
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
8 properties
8 required
FieldHistory
object
6 properties
6 required
PatchedBankGuarantee
object
10 properties
GuaranteeRealty
object
8 properties
7 required
Discount3rdLevel
object
9 properties
8 required
Profile2Address
object
16 properties
4 required
StatusChangeCondition
object
7 properties
7 required
DynamicProductSet
object
11 properties
10 required
Liability
SourceComparisonStatusEnum
string
match - MATCH mismatch - MISMATCH nodata - NODATA
Borrower
object
10 properties
1 required
Instrument
object
24 properties
4 required
SourceComparison
object
6 properties
6 required
StatusChangeValidation
object
3 properties
3 required
PatchedResetStatus
object
2 properties
StatusChangeConditionEvaluation
object
2 properties
2 required
ComplianceAnswerMultiSelectTyped
ReducedClient
object
2 properties
ClientProfileGenericExternalReference
object
3 properties
3 required
PatchedGuarantee
object
5 properties
User
object
Base serializer for users (e.g. analysts)
6 properties
6 required
HistoryType
object
Can be managed at /resources/history-type
3 properties
3 required
SourceDataFieldStatus
object
Can be managed at /resources/source-data-field-status
3 properties
3 required
ReducedCreditProvider
object
To be used for a short summary of the CreditProvider
9 properties
9 required
PricingSheet
object
9 properties
8 required
LoanOfferStatus
object
Can be managed at /resources/loan-offer-status
4 properties
3 required
Income
ProductCostType
object
Can be managed at /resources/product-cost-type
3 properties
3 required
RealtyCollateralOwner
object
101 properties
4 required
Guarantee
object
4 properties
4 required
ReducedInsuranceProvider
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
4 properties
4 required
ReducedDocumentProofObject
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
5 properties
5 required
DocumentSignedUrl
object
20 properties
14 required
ReducedLoanRequest
object
Loan request reduced representation
5 properties
5 required
RiskEnum
string
low - low medium - medium high - high
ContactType
object
Can be managed at /resources/contact-type
3 properties
3 required
FieldComparison
object
3 properties
3 required
GenericComment
object
Serializer to handle multiple subclasses of another class - The parent class needs to set the name of the field in 'shapefield' in Meta (e.g. liabilitytype) -…
8 properties
7 required
NoUrlDocumentProofObject
object
Same as the document proof object serializer without the url, mime type and generated document
13 properties
8 required
PatchedForceUpdateStatus
object
2 properties
BaseUserProfileWithContacts
object
Moves UniqueValidator's from the validation stage to the save stage. It solves the problem with nested validation for unique fields on update. If you want more…
7 properties
6 required
ReducedRealty
object
3 properties
OtherCreditProviderRequest
object
Other credit providers for the loan request
5 properties
5 required
IncomeType
object
Can be managed at /resources/income-type
5 properties
5 required
PatchedBorrowerNotification
object
7 properties
NestedSignedDocument
object
3 properties
3 required
RedirectionPath
object
Can be managed at /resources/redirection-path
3 properties
3 required
DocumentType
object
Can be managed at /resources/document-type
10 properties
3 required
PatchedIncome
LenderOnboardingStatus
object
Can be managed at /resources/lender-onboarding-status
3 properties
3 required
DecisionType
object
Can be managed at /resources/decision-type
3 properties
3 required
SignDocument
object
2 properties
2 required
LoanRequestMilestone
object
3 properties
2 required
NestedMortgageRank
object
6 properties
5 required
ReducedLoanOffer
object
Baseclass for Reduced serializers. Will validate whether the objects exists, and returns the instance in tointernalvalue Subclasses must implement Meta with at…
5 properties
5 required
ToggleCancel
object
2 properties
2 required
Sex
object
Can be managed at /resources/sex
3 properties
3 required
PhoneCountryCode
object
Can be managed at /resources/phone-country-code
4 properties
4 required
FinancialAssetType
object
Can be managed at /resources/financial-asset-type
3 properties
3 required
TaxType
object
Can be managed at /resources/tax-type
3 properties
3 required
LegitimisationType
object
Can be managed at /resources/legitimisation-type
3 properties
3 required
PoliticallyExposedPersonType
object
Can be managed at /resources/politically-exposed-person-type
3 properties
3 required
InsuranceSimulation
object
17 properties
4 required
FloodRiskType
object
Can be managed at /resources/flood-risk-type
3 properties
3 required
DecisionOutcome
object
Can be managed at /resources/decision-outcome
5 properties
5 required
DataPush
object
12 properties
8 required
PatchedClientProfileGenericExternalReference
object
3 properties
Fiduciary
object
3 properties
3 required
Periodicity
object
Can be managed at /resources/periodicity
3 properties
3 required
LoanOffer
object
57 properties
49 required
BelgianStandardLoanRequestExport
object
37 properties
36 required
RegularityType
object
Can be managed at /resources/regularity-type
3 properties
3 required
ComplianceAnswer
IdDocumentType
object
Can be managed at /resources/id-document-type
3 properties
3 required
SigningRequest
object
3 properties
1 required
RealtyOwnership
object
2 properties
2 required
OwnCompanyOrRelatives
object
Can be managed at /resources/own-company-or-relatives
3 properties
3 required
RentalType
object
Can be managed at /resources/rental-type
3 properties
3 required
Message
object
4 properties
4 required
SolutionRecommendations
object
2 properties
2 required
ComplianceAnswerFreeText
object
5 properties
4 required
Country
object
Can be managed at /resources/country
3 properties
3 required
RealtyCollateralOwners
object
6 properties
6 required
AdditionalFinancingNeed
object
4 properties
3 required
LiabilityInsurance
object
14 properties
10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oper Credits 12
Other APIs Oper Credits publishes across the network.
Oper Credits Agent Documents API
Oper Credits Appointment Booking Websites API
Oper Credits Approvals API
Oper Credits Bank Release Policy API
Oper Credits Base Products API
Oper Credits Calculate API
Oper Credits Check Invite Token API
Oper Credits Check Reset Password API
Oper Credits Client Users API
Oper Credits Clients API
Oper Credits Commissions API
Oper Credits Communication History API
#Loan Requests
Where this information came from
This is an independent, third-party profile of Oper Credits Loan Requests API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.