Digital Trade API (1.0)

Download OpenAPI specification:Download

Introduction

Digital Trade API allows an agent to manage digital trade (DIAS) process.

Contact

If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.

Error codes

Below is the summary of most common error codes included in the response's errorCode field.

HTTP status code	Error code	Meaning
400	`BAD_REQUEST_PARAMETERS`	Invalid request with e.g. missing mandatory parameters.
400	`BAD_REQUEST_BODY`	Invalid request body with e.g. missing mandatory fields.
400	`VALUE_REQUIRED`	Mandatory value missing for the request.
400	`INVALID_TYPE`	Invalid data type provided for the value in the request.
400	`INVALID_STATUS`	Unable to perform the request operation due to invalid state.
401	`UNAUTHORIZED`	Unauthorized request.
404	`INVALID_ID`	Missing or invalid identifier.
404	`INVALID_API_KEY`	Missing or invalid API key.
410	`GONE`	The requested resource is no longer available.
415	`UNSUPPORTED_MEDIA_TYPE`	Unsupported media type.
500	`TECHNICAL_ERROR`	A technical error has occurred.
503	`SERVICE_UNAVAILABLE`	Service is unavailable.

Banks

Banks API allows you to fetch banks available for digital trade

Fetch list of banks which can be used in digital trade

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type

application/json

{"totalCount": 1,
"banks": [{"name": "Nordea",
"businessId": "1234567-8",
"groupName": "Nordea Group",
"groupBusinessId": "1234567-8"
}
]
}

Share Trade

Share Trade API allows you to create, update and fetch digital share trade.

Property Trade

Property Trade API allows you to create, update and fetch digital property trade.

Create a new draft of digital property trade (DIAS)

Create a new draft of digital property trade. This starts the DIAS process.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Request body contains details of the property trade draft.

	object (RealEstateTransferNotice) Real estate transfer notice information.
	object (FinancialAccount) Financial payment account, at a payment service provider.
required	Array of objects (PortionOfTransfer) An array containing portions of transfer.
mortgageDeedCodes required	Array of strings List of mortgage deed codes.
nonTransferableMortgageDeedCodes	Array of strings List of non transferable mortgage deed codes.
required	Array of objects (PropertyDocument) An array of documents.
required	object (TradeContactInformation) Contact information of the initiator.
deedOfTransferType required	string (DeedOfTransferType) Enum: "SALES_DEED" "GIFT_DEED" "PRECONTRACT" Type of the deed of transfer.
required	Array of objects (ConsentorParty) An array containing consentorParties.
compensationUponDelayedPaymentInCents	integer >= 0 Default: 0 Amount in cents to be paid as compensation upon delayed payment.
facilityId	string Identification number of the facility.
required	Array of objects (TransferTerm) Transfer terms.
transferRealEstateType required	string (TransferRealEstateType) Enum: "RESERVE_PARCEL_OF_LAND" "WHOLE_PROPERTY" "DESIGNATED_SHARE" "PARCEL_OF_LAND" Type of the real estate to be transferred.
required	Array of objects (PropertySellerParty) An array of sellers.
sellingPriceInCents required	integer >= 0 Selling price in cents.
required	Array of objects (PropertyBuyerParty) An array of buyers.
tradeSettlementId required	string <uuid> TradeSettlementId related to the trade.
propertyId	string Property identifier.

Responses

Request samples

Payload

Content type

application/json

{"realEstateTransferNotice": {"purposeOfUse": "RESIDENTIAL_PLOT",
"isTransferBetweenRelatives": true,
"isShorePlot": true,
"buildingInformation": "TRANSFER_ALL_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"agentBankAccount": {"financialAccountId": "F12180000012345678",
"ownerName": "Realtor LKV",
"financialInstitutionId": "DABAFIHH"
},
"portionsOfTransfer": [{"portion": "1/2",
"sellerSocialSecurityNumbers": ["string"
],
"sellerBusinessIds": ["stringstri"
]
}
],
"mortgageDeedCodes": ["string"
],
"nonTransferableMortgageDeedCodes": ["string"
],
"documents": [{"documentId": "12345678-1234-1234-1234-123456789012",
"documentTypeCode": "TRADE_REGISTER_EXTRACT",
"documentName": "Kauppakirjan liite 1",
"businessId": "FI99999999"
}
],
"tradeContactInformation": {"firstName": "Matti",
"lastName": "Virtanen",
"emailAddress": "matti.virtanen@esimerkki.fi",
"phoneNumber": "+358401234567"
},
"deedOfTransferType": "SALES_DEED",
"consentorParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"consentorType": "WIDOW",
"sellerSocialSecurityNumber": "010101-123A"
}
],
"compensationUponDelayedPaymentInCents": 100000,
"facilityId": "123456789",
"transferTerms": [{"title": "Kauppahinta",
"description": "Kauppahinta on maksettava kokonaisuudessaan kaupantekopäivänä."
}
],
"transferRealEstateType": "WHOLE_PROPERTY",
"sellerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"bankBusinessId": "FI99999999",
"businessIds": ["stringstri"
],
"agentCommission": {"amountInCents": 100000,
"referenceNumber": "123456789",
"message": "Payment for agent"
},
"roles": ["ORGANIZATION"
]
}
],
"sellingPriceInCents": 25000000,
"buyerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"businessIds": ["stringstri"
],
"roles": ["ORGANIZATION"
],
"bankBusinessId": "FI99999999",
"portion": "1/2",
"onWhoseBehalfTheRegistrationOfOwnershipIsAppliedFor": "OWN"
}
],
"tradeSettlementId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
"propertyId": "123-456-7890-1111"
}

Response samples

Content type

application/json

{"tradeId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b"
}

Get a draft of digital property trade (DIAS)

Get a draft of digital property trade.

Authorizations:

bearerAuth

path Parameters

tradeId

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the share trade

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type

application/json

{"realEstateTransferNotice": {"purposeOfUse": "RESIDENTIAL_PLOT",
"isTransferBetweenRelatives": true,
"isShorePlot": true,
"buildingInformation": "TRANSFER_ALL_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"agentBankAccount": {"financialAccountId": "F12180000012345678",
"ownerName": "Realtor LKV",
"financialInstitutionId": "DABAFIHH"
},
"portionsOfTransfer": [{"portion": "1/2",
"sellerSocialSecurityNumbers": ["string"
],
"sellerBusinessIds": ["stringstri"
]
}
],
"mortgageDeedCodes": ["string"
],
"nonTransferableMortgageDeedCodes": ["string"
],
"documents": [{"documentId": "12345678-1234-1234-1234-123456789012",
"documentTypeCode": "TRADE_REGISTER_EXTRACT",
"documentName": "Kauppakirjan liite 1",
"businessId": "FI99999999"
}
],
"tradeContactInformation": {"firstName": "Matti",
"lastName": "Virtanen",
"emailAddress": "matti.virtanen@esimerkki.fi",
"phoneNumber": "+358401234567"
},
"deedOfTransferType": "SALES_DEED",
"consentorParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"consentorType": "WIDOW",
"sellerSocialSecurityNumber": "010101-123A"
}
],
"compensationUponDelayedPaymentInCents": 100000,
"facilityId": "123456789",
"transferTerms": [{"title": "Kauppahinta",
"description": "Kauppahinta on maksettava kokonaisuudessaan kaupantekopäivänä."
}
],
"transferRealEstateType": "WHOLE_PROPERTY",
"sellerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"bankBusinessId": "FI99999999",
"businessIds": ["stringstri"
],
"agentCommission": {"amountInCents": 100000,
"referenceNumber": "123456789",
"message": "Payment for agent"
},
"roles": ["ORGANIZATION"
]
}
],
"sellingPriceInCents": 25000000,
"buyerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"businessIds": ["stringstri"
],
"roles": ["ORGANIZATION"
],
"bankBusinessId": "FI99999999",
"portion": "1/2",
"onWhoseBehalfTheRegistrationOfOwnershipIsAppliedFor": "OWN"
}
],
"tradeSettlementId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
"propertyId": "123-456-7890-1111",
"initiatorPersonId": "1234567",
"tradeInitiatedTime": "2021-09-21T17:32:28Z",
"events": [{"eventType": "buyer-bank-started-preparations",
"eventPhase": "COMPLETED",
"eventPhaseDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"eventTime": "2021-09-21T17:32:28Z",
"eventDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"tradePhase": "COMPLETED",
"isTradeCancellable": true
}

Update a draft of digital property trade (DIAS)

Update a draft of digital property trade.

Authorizations:

bearerAuth

path Parameters

tradeId

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the share trade

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Request body contains details of the property trade draft.

	object (RealEstateTransferNotice) Real estate transfer notice information.
	object (FinancialAccount) Financial payment account, at a payment service provider.
required	Array of objects (PortionOfTransfer) An array containing portions of transfer.
mortgageDeedCodes required	Array of strings List of mortgage deed codes.
nonTransferableMortgageDeedCodes	Array of strings List of non transferable mortgage deed codes.
required	Array of objects (PropertyDocument) An array of documents.
required	object (TradeContactInformation) Contact information of the initiator.
deedOfTransferType required	string (DeedOfTransferType) Enum: "SALES_DEED" "GIFT_DEED" "PRECONTRACT" Type of the deed of transfer.
required	Array of objects (ConsentorParty) An array containing consentorParties.
compensationUponDelayedPaymentInCents	integer >= 0 Default: 0 Amount in cents to be paid as compensation upon delayed payment.
facilityId	string Identification number of the facility.
required	Array of objects (TransferTerm) Transfer terms.
transferRealEstateType required	string (TransferRealEstateType) Enum: "RESERVE_PARCEL_OF_LAND" "WHOLE_PROPERTY" "DESIGNATED_SHARE" "PARCEL_OF_LAND" Type of the real estate to be transferred.
required	Array of objects (PropertySellerParty) An array of sellers.
sellingPriceInCents required	integer >= 0 Selling price in cents.
required	Array of objects (PropertyBuyerParty) An array of buyers.
tradeSettlementId required	string <uuid> TradeSettlementId related to the trade.
propertyId	string Property identifier.

Responses

Request samples

Payload

Content type

application/json

{"realEstateTransferNotice": {"purposeOfUse": "RESIDENTIAL_PLOT",
"isTransferBetweenRelatives": true,
"isShorePlot": true,
"buildingInformation": "TRANSFER_ALL_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"agentBankAccount": {"financialAccountId": "F12180000012345678",
"ownerName": "Realtor LKV",
"financialInstitutionId": "DABAFIHH"
},
"portionsOfTransfer": [{"portion": "1/2",
"sellerSocialSecurityNumbers": ["string"
],
"sellerBusinessIds": ["stringstri"
]
}
],
"mortgageDeedCodes": ["string"
],
"nonTransferableMortgageDeedCodes": ["string"
],
"documents": [{"documentId": "12345678-1234-1234-1234-123456789012",
"documentTypeCode": "TRADE_REGISTER_EXTRACT",
"documentName": "Kauppakirjan liite 1",
"businessId": "FI99999999"
}
],
"tradeContactInformation": {"firstName": "Matti",
"lastName": "Virtanen",
"emailAddress": "matti.virtanen@esimerkki.fi",
"phoneNumber": "+358401234567"
},
"deedOfTransferType": "SALES_DEED",
"consentorParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"consentorType": "WIDOW",
"sellerSocialSecurityNumber": "010101-123A"
}
],
"compensationUponDelayedPaymentInCents": 100000,
"facilityId": "123456789",
"transferTerms": [{"title": "Kauppahinta",
"description": "Kauppahinta on maksettava kokonaisuudessaan kaupantekopäivänä."
}
],
"transferRealEstateType": "WHOLE_PROPERTY",
"sellerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"bankBusinessId": "FI99999999",
"businessIds": ["stringstri"
],
"agentCommission": {"amountInCents": 100000,
"referenceNumber": "123456789",
"message": "Payment for agent"
},
"roles": ["ORGANIZATION"
]
}
],
"sellingPriceInCents": 25000000,
"buyerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"businessIds": ["stringstri"
],
"roles": ["ORGANIZATION"
],
"bankBusinessId": "FI99999999",
"portion": "1/2",
"onWhoseBehalfTheRegistrationOfOwnershipIsAppliedFor": "OWN"
}
],
"tradeSettlementId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
"propertyId": "123-456-7890-1111"
}

Response samples

Content type

application/json

{"tradeId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b"
}

Get a draft preview document of digital property trade (DIAS)

Get a draft preview document of the digital property trade.

Authorizations:

bearerAuth

path Parameters

tradeId

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the share trade

header Parameters

Request-ID required	string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.
Accept required	string Value: "application/pdf" Example: application/pdf A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Get configs for a digital property trade (DIAS)

Get configs for a digital property trade (DIAS) based on details of the trade.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Request body contains details of the property trade needed for getting configs.

mortgageDeedCodes required	Array of strings List of mortgage deed codes.
nonTransferableMortgageDeedCodes	Array of strings List of non transferable mortgage deed codes.
compensationUponDelayedPaymentInCents	integer >= 0 Default: 0 Amount in cents to be paid as compensation upon delayed payment.
sellerBankBusinessId	string Business ID of the bank in FI99999999 format
buyerBankBusinessId	string Business ID of the bank in FI99999999 format
facilityId	string Identification number of the facility.
transferRealEstateType	string Enum: "WHOLE_PROPERTY" "DESIGNATED_SHARE" Type of the real estate to be transferred.

Responses

Request samples

Payload

Content type

application/json

{"mortgageDeedCodes": ["string"
],
"nonTransferableMortgageDeedCodes": ["string"
],
"compensationUponDelayedPaymentInCents": 100000,
"sellerBankBusinessId": "FI99999999",
"buyerBankBusinessId": "FI99999999",
"facilityId": "123456789",
"transferRealEstateType": "WHOLE_PROPERTY"
}

Response samples

Content type

application/json

{"deedOfTransferRequiredTerms": [{"title": "Omistusoikeuden siirtyminen",
"description": "Omistusoikeus kaupan kohteeseen siirtyy ostajalle, kun koko kauppahinta on maksettu"
}
],
"options": {"deedOfTransferType": {"values": [{"value": "SALES_DEED",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
},
"purposeOfUse": {"values": [{"value": "RESIDENTIAL_PLOT",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
},
"zoningType": {"values": [{"value": "CITY_PLAN",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
},
"buildingInformation": {"values": [{"value": "TRANSFER_ALL_BUILDINGS",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
},
"transferRealEstateType": {"values": [{"value": "WHOLE_PROPERTY",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
},
"onWhoseBehalfTheRegistrationOfOwnershipIsAppliedFor": {"values": [{"value": "OWN",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
},
"consentorType": {"values": [{"value": "WIDOW",
"type": "STRING_OPTION",
"supported": true,
"optionDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
]
}
}
}

Get status of digital property trade (DIAS)

Get status of digital property trade.

Authorizations:

bearerAuth

path Parameters

tradeId

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the share trade

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Responses

Response samples

Content type

application/json

{"realEstateTransferNotice": {"purposeOfUse": "RESIDENTIAL_PLOT",
"isTransferBetweenRelatives": true,
"isShorePlot": true,
"buildingInformation": "TRANSFER_ALL_BUILDINGS",
"zoningType": "CITY_PLAN"
},
"agentBankAccount": {"financialAccountId": "F12180000012345678",
"ownerName": "Realtor LKV",
"financialInstitutionId": "DABAFIHH"
},
"portionsOfTransfer": [{"portion": "1/2",
"sellerSocialSecurityNumbers": ["string"
],
"sellerBusinessIds": ["stringstri"
]
}
],
"mortgageDeedCodes": ["string"
],
"nonTransferableMortgageDeedCodes": ["string"
],
"documents": [{"documentId": "12345678-1234-1234-1234-123456789012",
"documentTypeCode": "TRADE_REGISTER_EXTRACT",
"documentName": "Kauppakirjan liite 1",
"businessId": "FI99999999"
}
],
"tradeContactInformation": {"firstName": "Matti",
"lastName": "Virtanen",
"emailAddress": "matti.virtanen@esimerkki.fi",
"phoneNumber": "+358401234567"
},
"deedOfTransferType": "SALES_DEED",
"consentorParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"consentorType": "WIDOW",
"sellerSocialSecurityNumber": "010101-123A"
}
],
"compensationUponDelayedPaymentInCents": 100000,
"facilityId": "123456789",
"transferTerms": [{"title": "Kauppahinta",
"description": "Kauppahinta on maksettava kokonaisuudessaan kaupantekopäivänä."
}
],
"transferRealEstateType": "WHOLE_PROPERTY",
"sellerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"bankBusinessId": "FI99999999",
"businessIds": ["stringstri"
],
"agentCommission": {"amountInCents": 100000,
"referenceNumber": "123456789",
"message": "Payment for agent"
},
"roles": ["ORGANIZATION"
],
"signingTimestamps": [{"type": "DIAS",
"timestamp": "2021-09-21T17:32:28Z"
}
]
}
],
"sellingPriceInCents": 25000000,
"buyerParties": [{"person": {"firstName": "Matti",
"lastName": "Virtanen",
"socialSecurityNumber": "010101-123A",
"emailAddress": "matti.virtanen@esimerkki.fi"
},
"organization": {"name": "Esimerkki Oy",
"businessId": "FI99999999"
},
"businessIds": ["stringstri"
],
"roles": ["ORGANIZATION"
],
"bankBusinessId": "FI99999999",
"portion": "1/2",
"onWhoseBehalfTheRegistrationOfOwnershipIsAppliedFor": "OWN",
"signingTimestamps": [{"type": "DIAS",
"timestamp": "2021-09-21T17:32:28Z"
}
]
}
],
"tradeSettlementId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
"propertyId": "123-456-7890-1111",
"initiatorPersonId": "1234567",
"tradeInitiatedTime": "2021-09-21T17:32:28Z",
"kvpSalesDeedPreview": {"documentId": "12345678-1234-1234-1234-123456789012",
"documentName": "KVP kauppakirja esikatselu"
},
"kvpSalesDeed": {"documentId": "12345678-1234-1234-1234-123456789012",
"documentName": "KVP kauppakirja esikatselu"
},
"tradeRejection": {"reasonDescription": "The buyer did not have the funds to pay for the apartment.",
"rejectedTime": "2021-09-21T17:32:28Z",
"rejectedByBusinessId": "1234567"
},
"events": [{"eventType": "buyer-bank-started-preparations",
"eventPhase": "COMPLETED",
"eventPhaseDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
],
"eventTime": "2021-09-21T17:32:28Z",
"eventDescription": [{"languageCode": "fi",
"text": "Suomeksi"
}
]
}
],
"tradePhase": "COMPLETED",
"isTradeCancellable": true
}

Cancel the digital property trade (DIAS) process

Cancel the digital property trade (DIAS) process.

Authorizations:

bearerAuth

path Parameters

tradeId

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the share trade

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Contains the details for cancelling the trade

reasonDescription

required

string

Description of the reason for the trade cancelation.

Responses

Request samples

Payload

Content type

application/json

{"reasonDescription": "The buyer did not have the funds to pay for the apartment."
}

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Execute digital property trade (DIAS) action

Execute digital property trade (DIAS) action. Can be used for starting the signing phase of the trade, when the trade is in APPROVAL_PHASES_COMPLETED phase.

Authorizations:

bearerAuth

path Parameters

tradeId

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

Identifier of the share trade

header Parameters

Request-ID

required

string <uuid>

Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9

A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes.

Request Body schema: application/json

Contains the details for updating the property trade

actionCode

required

string

Enum: "START_SIGNING" "SUBMIT_FOR_APPROVALS"

Action to be taken on the trade.

START_SIGNING Starts the signing process of the trade if the trade is in APPROVAL_PHASES_COMPLETED phase.
SUBMIT_FOR_APPROVALS Submits the trade for approvals when the draft is ok.

Responses

Request samples

Payload

Content type

application/json

{"actionCode": "START_SIGNING"
}

Response samples

Content type

application/json

{"errorCode": "BAD_REQUEST_PARAMETERS",
"message": "Invalid request parameters",
"description": "Request parameters are missing or have invalid type.",
"errors": [{"target": "assignmentId",
"errorCode": "VALUE_REQUIRED",
"message": "Mandatory request parameter assignmentId is missing"
},
{"target": "authorId",
"errorCode": "INVALID_TYPE",
"message": "Request parameter authorId must be a string"
}
]
}

Digital Trade API (1.0)

Introduction

Contact

Error codes

Banks

Fetch list of banks which can be used in digital trade

Authorizations:

header Parameters

Responses

Response samples

Share Trade

Create a new digital share trade (DIAS)

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get a status digital share trade (DIAS)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Cancel the digital share trade (DIAS) process

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Execute digital share trade (DIAS) action

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Property Trade

Create a new draft of digital property trade (DIAS)

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get a draft of digital property trade (DIAS)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update a draft of digital property trade (DIAS)

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get a draft preview document of digital property trade (DIAS)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get configs for a digital property trade (DIAS)

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get status of digital property trade (DIAS)

Authorizations:

path Parameters

header Parameters

Responses