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

ProcessesProperty

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

Property List

GET
https://api-qua-portalparceiros.bancoctt.pt
/v1/processes/{processUniqueId}/property

Retrieves the primary property's detail data for a process. This endpoint validates the existence of the specified mortgage process for the current broker before retrieving property details. If the process does not exist or does not belong to the broker, a validation error is returned. The response is localized using the language configured in the current request context.

Property List › path Parameters

processUniqueId
string · uuid · required

Unique identifier of the process

Property List › Headers

Authorization
string · required

Bearer token for authentication. Format: Bearer {token}

Property List › Responses

The primary property details were successfully retrieved.

object[]
GET/v1/processes/{processUniqueId}/property
curl --request GET \
  --url https://api-qua-portalparceiros.bancoctt.pt/v1/processes/:processUniqueId/property \
  --header 'Authorization: <string>'
shell
Example Responses
{
  "propertyList": [
    {
      "propertyUniqueID": "b3d9f6a1-2c34-4e9f-9f5a-1d2e3f4a5b6c",
      "yearBuilt": 1998,
      "acquisitionAmount": 150000,
      "acquisitionDate": "2020-09-01",
      "estimatedAmount": 160000,
      "doorNumber": "A",
      "floor": "2",
      "districtID": 1,
      "districtDescription": "Aveiro",
      "countyID": 1,
      "countyDescription": "ANADIA",
      "parishID": 4186,
      "parishDescription": "AVELAS DE CAMINHO",
      "zipCode": "1000-001",
      "zipCodeLocal": "Lisbon",
      "typologyID": 1,
      "typologyDescription": "Flat",
      "grossBuiltArea": 120.5,
      "address": "Rua Exemplo 123"
    }
  ]
}
json
application/json

Property Update

PUT
https://api-qua-portalparceiros.bancoctt.pt
/v1/processes/{processUniqueId}/property/{propertyUniqueId}

Updates the primary property's detail data for a process. This endpoint updates the primary property associated with a mortgage process. The request body is mapped to a service-level model and validated against the process, property, and broker context. If validation errors occur, they are returned to the caller. Upon successful validation, the update is persisted using the current broker and user identifiers for auditing purposes.

Property Update › path Parameters

processUniqueId
string · uuid · required

Unique identifier of the mortgage process.

propertyUniqueId
string · uuid · required

Unique identifier of the property to update.

Property Update › Headers

Authorization
string · required

Bearer token for authentication. Format: Bearer {token}

Property Update › Request Body

grossBuiltArea
number · double

Gross built area in square meters (optional)

yearBuilt
integer · int32

Year the property was built (optional)

acquisitionAmount
number · double

Acquisition amount paid for the property (optional)

acquisitionDate
string · date-time

Date of property acquisition (optional)

address
string

Street address of the property (optional)

doorNumber
string

Door number of the property (optional)

floor
string

Floor of the property (optional)

districtId
integer · int32

Identifier of the district where the property is located (optional)

countyId
integer · int32

Identifier of the county where the property is located (optional)

parishId
integer · int32

Identifier of the parish where the property is located (optional)

zipCode
string

Postal code (optional)

zipCodeLocal
string

Locality for the postal code (optional)

Property Update › Responses

The property was successfully updated.

object
PUT/v1/processes/{processUniqueId}/property/{propertyUniqueId}
curl --request PUT \
  --url https://api-qua-portalparceiros.bancoctt.pt/v1/processes/:processUniqueId/property/:propertyUniqueId \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "grossBuiltArea": 120.5,
  "yearBuilt": 1998,
  "acquisitionAmount": 150000,
  "acquisitionDate": "2020-09-01",
  "address": "Rua Exemplo 123",
  "doorNumber": "A",
  "floor": "2",
  "districtId": 1,
  "countyId": 1,
  "parishId": 4186,
  "zipCode": "1000-001",
  "zipCodeLocal": "Lisbon"
}
'
shell
Example Request Body
{
  "grossBuiltArea": 120.5,
  "yearBuilt": 1998,
  "acquisitionAmount": 150000,
  "acquisitionDate": "2020-09-01",
  "address": "Rua Exemplo 123",
  "doorNumber": "A",
  "floor": "2",
  "districtId": 1,
  "countyId": 1,
  "parishId": 4186,
  "zipCode": "1000-001",
  "zipCodeLocal": "Lisbon"
}
json
Example Responses
{
  "operationStatus": {
    "operationStatusCode": "020101",
    "operationStatusMessage": "Process Updated successfully"
  }
}
json
application/json

ProcessesMessageSimulations