Simulation List
List all simulations, with filtering and pagination options.
query Parameters
filterByTextText to filter by borrower's name, tax ID, or branch description
filterStatusLastDateFromMinimum simulation status date (inclusive).
filterStatusLastDateToMaximum simulation status date (inclusive).
filterSimulationStatusCurrent simulation status. Possible values can be obtained from WorkflowStatesSimulationGet taxonomy endpoint
lineCountMaximum number of records to return
nextRecordSimulation Identifier before which results simulations are
previousRecordSimulation Identifier after which results simulations are
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulation List › Responses
OK
totalRecordsTotal number of records found
hasMoreResultsIndicates if there are more results available
List of simulation details
Simulation Create
Creates a Simulation with the specified information containing in the provided object
Simulation gets automatically associated with the logged broker and userID
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulation Create › Responses
Simulation's identification information
Simulation Detail
Gets detailed information about a specific simulation previously created.
Contains information about:
- Simulation's Loan data (LoanAmount, IndexType, Duration, etc...)
- Borrower details (Age, Income, etc...)
- Property details (EstimatedValue, Address, etc...)
- Insurance details (Type, MonthlyCost, etc...)
- Bank Charges details (Description, Amount, etc...)
path Parameters
simulationUniqueIdUnique identifier that represents the simulation unequivocally
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulation Detail › Responses
Simulation details successfully returned.
Simulation Cancel
Cancels the specified simulation if it's in a cancelable status.
path Parameters
simulationUniqueIdUnique identifier that represents the simulation unequivocally
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulation Cancel › Request Body
simulationCancelReasonIdSimulation Cancel reason ID (can be obtained from the corresponding taxonomy endpoint)
cancelCommentsAny additional comments to the cancel reason
Simulation Cancel › Responses
OK
Simulation Update
Updates only the provided fields from the request object
Eg. if loan amount is not provided it won't update and remain the old value.
Simulations that are completed will not be updated.
The Simulation will pass through the same validation process as when creating a new simulation. So all rules must be followed.
path Parameters
simulationUniqueIdUnique identifier that represents the simulation unequivocally
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulation Update › Responses
Simulation's identification information
Simulation Validate
Validates if the provided Simulation data is valid for creation
This same validation is applied when creating a simulation
Eg. valid combinations of Regime/Destination/Purpose, Rate type rules (fixed, variable, mixed), etc...
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Simulation Validate › Responses
Empty error object