BCTT Partners Portal API - Developer Portal
  • Documentation
  • API Reference
Authentication
    Authenticatepost
Partners
    Callback UpdateputCallback DeletedeleteCallback ListgetCallback Echopost
Processes
    Process DetailgetProcess UpdateputProcess ListgetProcess CreatepostProcess SubmitpostProcess Canceldelete
ProcessesBorrower
    Borrower GetgetBorrower UpdateputBorrower DeletedeleteBorrower ListgetBorrower Createpost
ProcessesDocument
    Document GetgetDocument UpdateputDocument DeletedeleteDocument ListgetDocument Createpost
ProcessesESIS
    Process ESIS GetgetProcess ESIS Emailget
ProcessesMessage
    Processes Message ListgetProcesses Message Createpost
ProcessesProperty
    Property ListgetProperty Updateput
Simulations
    Simulation ListgetSimulation CreatepostSimulation DetailgetSimulation CanceldeleteSimulation UpdatepatchSimulation Validatepost
SimulationsESIS
    Simulation ESIS GetgetSimulation ESIS Emailget
SimulationsMessages
    Simulations Message ListgetSimulations Message Createpost
Taxonomy
    Broker Types GetgetBroker Sub Types GetgetBroker Classifications GetgetBroker Fee Types GetgetBroker Statuses GetgetBroker IVA Regimes GetgetBroker Retention Regimes GetgetBroker Extract Periodicity GetgetCountries GetgetCountry With Districts GetgetDistricts GetgetDistricts With Counties GetgetCounties GetgetCounty With Parishes GetgetParishes GetgetDocument Types GetgetDocument Categories GetgetProduct Purposes GetgetLoan Purposes GetgetProduct Schemes GetgetIndex Type Sub Categories GetgetIndex Types GetgetIndex Type List Mixed GetgetFixed Fixed Period GetgetMixed Fixed Period GetgetBank Charge Types GetgetProperty Typologies GetgetEntity Types GetgetIdentification Documents GetgetMarital Statuses GetgetMatrimonial Regimes GetgetResidence Types GetgetGenders GetgetProfessions GetgetEmployment Contract Types GetgetEmployment Situations GetgetEmployment Department Positions GetgetKey Borrower Relations GetgetProposal Cancel Reasons GetgetProposal Reject Reasons GetgetSimulation Reject Reasons GetgetWorkflow Phases GetgetWorkflow States Simulation GetgetWorkflow States Proposal GetgetRetrieves a paginated list of notification typesget
Schemas
Partners Portal API
Partners Portal API

SimulationsESIS

Endpointhttps://api-qua-portalparceiros.bancoctt.pt

Simulation ESIS Get

GET
https://api-qua-portalparceiros.bancoctt.pt
/v1/simulations/{simulationUniqueId}/esis

Obtain the ESIS document of a simulation.

Simulation ESIS Get › path Parameters

simulationUniqueId
string · uuid · required

Simulation's unique identifier

Simulation ESIS Get › query Parameters

ignoreRules
boolean · required

Ignore rules acts as an indicator to follow Law 24 2023 ESIS

Simulation ESIS Get › Headers

Authorization
string · required

Bearer token for authentication. Format: Bearer {token}

Simulation ESIS Get › Responses

OK

esis
string

ESIS file in Base64 string format

GET/v1/simulations/{simulationUniqueId}/esis
curl --request GET \
  --url 'https://api-qua-portalparceiros.bancoctt.pt/v1/simulations/:simulationUniqueId/esis?ignoreRules=%3Cbool%3E' \
  --header 'Authorization: <string>'
shell
Example Responses
{
  "esis": "<Base64_String>"
}
json
application/json

Simulation ESIS Email

GET
https://api-qua-portalparceiros.bancoctt.pt
/v1/simulations/{simulationUniqueId}/esis/email

Send ESIS via email of the simulation

Simulation ESIS Email › path Parameters

simulationUniqueId
string · uuid · required

Simulation's unique identifier

Simulation ESIS Email › query Parameters

ignoreRules
boolean · required

Ignore rules acts as an indicator to follow Law 24 2023 ESIS

sendAddress
string · required

Email address to send the ESIS to.

Simulation ESIS Email › Headers

Authorization
string · required

Bearer token for authentication. Format: Bearer {token}

Simulation ESIS Email › Responses

OK with a boolean representing if the operation was successful or not

object
GET/v1/simulations/{simulationUniqueId}/esis/email
curl --request GET \
  --url 'https://api-qua-portalparceiros.bancoctt.pt/v1/simulations/:simulationUniqueId/esis/email?ignoreRules=%3Cbool%3E&sendAddress=%3Cstring%3E' \
  --header 'Authorization: <string>'
shell
Example Responses
{
  "operationStatus": {
    "operationStatusCode": "020101",
    "operationStatusMessage": "Process Updated successfully"
  }
}
json
application/json

SimulationsSimulationsMessages