Process Detail
Retrieves detailed information for a specific process. This endpoint returns detailed data for a mortgage process identified by its unique identifier. It validates that the process exists and belongs to the current broker before retrieving the data. The response is localized using the language specified in the request context.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process Detail › Responses
The process details were successfully retrieved.
processUniqueIDUnique identifier for the process
processNumberNumeric process number
simulationUniqueIDUnique identifier of the related simulation
simulationNumberNumeric simulation identifier
creationDateCreation date of the process
lastActionDateLast action date of the process
branchIDIdentifier of the branch handling the process
branchDescriptionDescription of the branch
processStatusIDIdentifier for the process status
processStatusDescriptionDescription of the process status
Process Update
Updates an existing process in creation state. This endpoint updates process data while the process is in the "In Creation" state. The request payload is mapped and validated against the specified process and broker context before changes are persisted.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process Update › Request Body
loanAmountRequested loan amount (optional)
loanDurationMonthsDuration of the loan in months (optional)
productSchemeIdIdentifier of the selected product scheme (optional)
loanPurposeIdIdentifier of the loan purpose (optional)
productPurposeIdIdentifier of the product purpose (optional)
hasCrossSellingIndicates whether cross-selling options are selected (optional)
branchIdIdentifier of the branch handling the process (optional)
Process Update › Responses
The process was successfully updated.
Process List
Retrieves a filtered list of processes. This endpoint returns a paginated and optionally filtered list of mortgage processes for the current broker. Filters may include text search, credit decision presence, contract date range, process status, and pagination controls. Results are localized using the request language context.
query Parameters
filterByTextfilterHasCreditDecisionIdfilterContractDateStartfilterContractDateTofilterProcessStatusIdlineCountpreviousRecordnextRecordHeaders
AuthorizationBearer token for authentication. Format: Bearer {token}
Process List › Responses
The list of processes was successfully retrieved.
totalRecordsTotal number of process records matching the query
hasMoreResultsIndicates whether more results are available beyond the current page
Process Create
Creates a new process from an accepted simulation. This endpoint creates a new mortgage process in the "In Acceptance" state based on the provided simulation data. The request payload is validated against the broker context before the process is created and associated with the current user.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process Create › Request Body
simulationUniqueIdUnique identifier of the simulation to create a process for
keyBorrowerEmailEmail address of the primary (key) borrower
keyBorrowerNameFull name of the primary (key) borrower
keyBorrowerIdentificationDocTypeIdIdentification document type identifier for the primary borrower
keyBorrowerIdentificationDocNumberIdentification document number for the primary borrower
keyBorrowerResidencePrimary borrower's residence/address (optional)
keyBorrowerIdentificationDocExpirationDateIdentification document expiration date for the primary borrower (optional)
borrowerEmailEmail of the secondary borrower (optional)
borrowerNameFull name of the secondary borrower (optional)
borrowerResidenceResidence/address of the secondary borrower (optional)
borrowerIdentificationDocTypeIdIdentification document type identifier for the secondary borrower (optional)
borrowerIdentificationDocNumberIdentification document number for the secondary borrower (optional)
borrowerIdentificationDocExpirationDateIdentification document expiration date for the secondary borrower (optional)
Process Create › Responses
The process was successfully created.
Process Submit
Submits a process for further processing. This endpoint submits a mortgage process currently in the "In Creation" state. Validation ensures the process has no pending items and is eligible for submission before the state transition is executed.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process Submit › Responses
The process was successfully submitted.
Process Cancel
Cancels a process in creation state. This endpoint cancels a mortgage process that is still in the "In Creation" state. The cancellation request is validated against the broker context and recorded using the current user for auditing purposes.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process Cancel › Responses
The process was successfully canceled.