Party API (1.0)

Download OpenAPI specification:Download

Introduction

Party API allows an agent to manage parties which are various stakeholders in the realty business. Parties can be associated with leads, assignments, clearing etc.

Parties are divided into different types:

Person - An individual person.
Estate - An estate of an deceased person. The estate has shareholders who can be individuals and also other estates.
Organization - An organization which can be a company, public entity, NGO or any other legal entity.

Each party type has its own endpoint with POST, PUT and GET methods and there is common DELETE endpoint.

Compliance verification for a party is required by KYC (Know Your Customer) and AML (Anti-Money Laundering) process. The verification results are handled through /partyComplianceVerifications endpoint. Compliance must be verified for each person attached to the party.

There also is an endpoint /parties to query parties with different search criteria. To find out whether an individual person is already defined as party, use can use the GET /parties endpoint for this purpose.

Contact

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

Party

Party API allows you to fetch parties by using different search criteria and remove parties

Fetch parties

Fetch parties by using different search criteria. You can combine the search criteria, for example to search for active organization parties for a specified agent office.

Authorizations:

bearerAuth

query Parameters

partyId	Array of strings <uuid> (PartyId) [^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...] Example: partyId=1803ca58-50ea-422b-a1f8-330289b67fe2 Search by the party identifier to fetch the specified party.
partyTypeCode	Array of strings (PartyTypeCode) Items Enum: "PERSON_PARTY" "ESTATE_PARTY" "ORGANIZATION_PARTY" Example: partyTypeCode=PERSON_PARTY Search by the party role to fetch the specified types of parties.
partyRoleCode	Array of strings (PartyRoleCode) Items Enum: "PROCUREMENT_VISITOR" "BUYER_CUSTOMER" "SELLER_CUSTOMER" "ACCOUNTING_CUSTOMER" "CONSENTOR" "TENANT" "LANDLORD" "ESTATE_SHAREHOLDER" "ATTORNEY_IN_FACT" "INVESTOR" Example: partyRoleCode=SELLER_CUSTOMER Search by the party roles to fetch parties having specific party roles.
partyTag	Array of strings Example: partyTag=Yksityissijoittaja Search by the party tags to fetch parties having specific tags provided by the agent.
partyName	string Example: partyName=Matti Virtanen Search by a name to fetch parties with this name or persons within the parties with this name.
officialId	string Example: officialId=FI02472382 Search by the official identifier fetch parties with this identifier or persons within the parties with this identifier.
schemeIdForOfficialId	string (SchemeId) Example: schemeIdForOfficialId=VAT Scheme id identifies what type of identifier is being searched for. This query parameter can be defined together with the `officialId` parameter.
agentId	Array of strings <uuid> (AgentId) [^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...] Example: agentId=5d2a6d47-da73-4b11-8940-27cffabb6de5 Search by the agent identifiers to get a list of parties the agents are responsible for.
agencyOfficeId	Array of strings <uuid> (AgencyOfficeId) [^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...] Example: agencyOfficeId=212114ec-819e-483c-a8e0-f82289ac6e19 Search by the agency office identifiers to get a list of parties that belong to certain agency offices.
freeTextSearch	string Example: freeTextSearch=Lakitoimisto Tampere Search by a free text to match parties with the given search text.
email	string Example: email=liisa.lehtinen@example.com Search by an email address to match parties associated with the given email address.
startIndex	integer <int32> >= 0 Example: startIndex=20 Paginate returned parties starting from this index. Index starts from 0.
endIndex	integer <int32> >= 1 Example: endIndex=40 Paginate returned parties ending to this index.
modifiedAfter	string <date-time> (Timestamp) Example: modifiedAfter=2024-09-05T13:50:22.204Z Search by timestamp to get a list of parties which have been modified after the specified time.
sort	Array of strings Example: sort=partyTypeCode\|asc Sort parties based on the specified fields. Each fields must also include a sort order as follows: `sort={fieldName}\|{asc\|desc}&sort={anotherFieldName}\|{asc\|desc}`

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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": 3,
"parties": [{"partyId": "3647910b-26f3-4761-82c9-cd1b6b494023",
"partyTypeCode": "ORGANIZATION_PARTY",
"partyName": "Pohjolan Matkat Oy",
"officialIdentifiers": [{"officialId": "FI02472382",
"schemeId": "VAT"
},
{"officialId": "0247238-6",
"schemeId": "FI:ORGNR"
}
],
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2019-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2019-07-15"
}
],
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Yrityksen vaihde"
},
{"contactMethodCode": "EMAIL",
"value": "pohjolanmatkat.info@example.com",
"description": "Ainoastaan yleiset kyselyt"
}
],
"creationTime": "2020-08-31T11:42:02Z",
"modificationTime": "2021-08-31T11:42:02Z"
},
{"partyId": "7ee90cd7-1189-4166-88d8-5117c7333639",
"partyTypeCode": "PERSON_PARTY",
"partyName": "Liisa Lehtinen",
"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-07-15"
}
],
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Myös SMS-viestit",
"primaryContactMethod": true
},
{"contactMethodCode": "EMAIL",
"value": "liisa.lehtinen@example.com",
"description": "Email harvoin käytössä"
}
],
"persons": [{"personRoleCode": "INDIVIDUAL",
"firstName": "Liisa",
"lastName": "Lehtinen"
}
],
"creationTime": "2020-08-31T11:42:02Z",
"modificationTime": "2021-09-30T11:42:02Z"
},
{"partyId": "9ae034b7-9461-448a-ad86-f99025247119",
"partyTypeCode": "ESTATE_PARTY",
"partyName": "Matti Virtasen jakamaton kuolinpesä",
"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-12-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2014-07-01"
}
],
"contactMethods": [{"contactMethodCode": "EMAIL",
"value": "jussi.laihanen@lakitoimistoaula.fi",
"description": "Pesänhoitaja"
}
],
"persons": [{"personRoleCode": "DECEASED",
"firstName": "Matti",
"lastName": "Virtanen"
}
],
"creationTime": "2020-08-31T11:42:02Z",
"modificationTime": "2021-10-31T11:42:02Z"
}
]
}

Delete party

Deletes a party and ALL related entities (for example assignments and trade settlements). Party can be deleted if there is no retention basis that prevents deletion.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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

{ }

Person Party

Person Party API allows you to create, update and fetch person as a party

Create a person party

Create a new person party.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the details for the person party.

required	object (Party) Party details, including the official identifiers.
required	object (PersonWrite) Person details.
creationTime	string <date-time> (CreationTime) Creation time of the party. The creation time is automatically set, if this field is not provided.

Responses

Request samples

Payload

Content type

application/json

{"party": {"partyTypeCode": "PERSON_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2017-03-25"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"roleCode": "RESPONSIBLE_AGENT"
},
{"agentId": "386654b2-882f-442e-9ffe-7d6b6e367715",
"agencyOfficeId": "74f83b16-ed1b-432a-b633-5c685cf9d8af",
"roleCode": "ACQUISITION_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SPOUSE",
"sinceDate": "2014-05-12"
}
],
"partyTags": [{"tag": "Asuntosijoittaja",
"sinceDate": "2014-01-01"
}
],
"attorneysInFact": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"partyTypeCode": "PERSON_PARTY",
"powerOfAttorneyDocumentId": "d02833e1-f50e-46ea-a295-0bd637d3d366",
"description": "Valtakirja annettu puolisolle"
}
],
"visibleToOtherUsers": true,
"invoicing": {"invoicingMethodCode": "PAPER"
}
},
"personParty": {"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"firstName": "Liisa",
"lastName": "Lehtinen",
"dateOfBirth": "1989-10-24",
"nationality": "FI",
"preferredLanguageCode": "fi",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Myös SMS-viestit",
"primaryContactMethod": true
},
{"contactMethodCode": "EMAIL",
"value": "liisa.lehtinen@example.com",
"description": "Email harvoin käytössä"
}
],
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Mannerheimintie 6 B 16",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
],
"consentCodes": ["DIGITAL_MARKETING_ALLOWED",
"PRIVACY_CONTENT_ALLOWED_TO_DELIVER_BY_EMAIL"
]
}
}

Response samples

Content type

application/json

{"partyId": "1ba7f781-77a0-451b-a2fa-5f293050c940"
}

Fetch a person party

Fetch details for the specified person party.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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

{"partyId": "7ee90cd7-1189-4166-88d8-5117c7333639",
"party": {"partyTypeCode": "PERSON_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2017-03-25"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"roleCode": "RESPONSIBLE_AGENT"
},
{"agentId": "386654b2-882f-442e-9ffe-7d6b6e367715",
"agencyOfficeId": "74f83b16-ed1b-432a-b633-5c685cf9d8af",
"roleCode": "ACQUISITION_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SPOUSE",
"sinceDate": "2014-05-12"
}
],
"partyTags": [{"tag": "Asuntosijoittaja",
"sinceDate": "2014-01-01"
}
],
"attorneysInFact": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"partyTypeCode": "PERSON_PARTY",
"powerOfAttorneyDocumentId": "d02833e1-f50e-46ea-a295-0bd637d3d366",
"description": "Valtakirja annettu puolisolle"
}
],
"visibleToOtherUsers": true,
"invoicing": {"invoicingMethodCode": "EMAIL"
}
},
"personParty": {"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"firstName": "Liisa",
"lastName": "Lehtinen",
"dateOfBirth": "1989-10-24",
"nationality": "FI",
"preferredLanguageCode": "fi",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Myös SMS-viestit",
"primaryContactMethod": true
},
{"contactMethodCode": "EMAIL",
"value": "liisa.lehtinen@example.com",
"description": "Email harvoin käytössä"
}
],
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Mannerheimintie 6 B 16",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
],
"consentCodes": ["DIGITAL_MARKETING_ALLOWED",
"PRIVACY_CONTENT_ALLOWED_TO_DELIVER_BY_EMAIL"
],
"complianceVerification": {"partyIdentified": true,
"complianceVerificationId": "f8eb65e9-ae7b-40e6-a958-1ccfc98fda4d"
}
},
"creationTime": "2021-05-13T16:07:23+00:00",
"modificationTime": "2021-05-15T08:04:44+00:00"
}

Update a person party

Update the details of the person party whose id is given as a path variable.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the person party to be updated.

partyId required	string <uuid> (PartyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Unique identifier for the party in the UUID format.
required	object (Party) Party details, including the official identifiers.
required	object (PersonWrite) Person details.

Responses

Request samples

Payload

Content type

application/json

{"partyId": "7ee90cd7-1189-4166-88d8-5117c7333639",
"party": {"partyTypeCode": "PERSON_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2017-03-25"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"roleCode": "RESPONSIBLE_AGENT"
},
{"agentId": "386654b2-882f-442e-9ffe-7d6b6e367715",
"agencyOfficeId": "74f83b16-ed1b-432a-b633-5c685cf9d8af",
"roleCode": "ACQUISITION_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SPOUSE",
"sinceDate": "2014-05-12"
}
],
"partyTags": [{"tag": "Asuntosijoittaja",
"sinceDate": "2014-01-01"
}
],
"attorneysInFact": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"partyTypeCode": "PERSON_PARTY",
"powerOfAttorneyDocumentId": "d02833e1-f50e-46ea-a295-0bd637d3d366",
"description": "Valtakirja annettu puolisolle"
}
],
"visibleToOtherUsers": true,
"invoicing": {"invoicingMethodCode": "EMAIL"
}
},
"personParty": {"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"firstName": "Liisa",
"lastName": "Lehtinen",
"dateOfBirth": "1989-10-24",
"nationality": "FI",
"preferredLanguageCode": "fi",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Myös SMS-viestit",
"primaryContactMethod": true
},
{"contactMethodCode": "EMAIL",
"value": "liisa.lehtinen@example.com",
"description": "Email harvoin käytössä"
}
],
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Mannerheimintie 6 B 16",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
],
"consentCodes": ["DIGITAL_MARKETING_ALLOWED",
"PRIVACY_CONTENT_ALLOWED_TO_DELIVER_BY_EMAIL"
]
}
}

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"
}
]
}

Estate Party

Estate Party API allows you to create, update and fetch estate as a party

Create an estate party

Create a new estate party.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the details for the estate party.

required	object (Party) Party details, including the official identifiers.
required	object (EstatePartyWrite) Estate party details.
creationTime	string <date-time> (CreationTime) Creation time of the party. The creation time is automatically set, if this field is not provided.

Responses

Request samples

Payload

Content type

application/json

{"party": {"partyTypeCode": "ESTATE_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-12-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2014-07-01"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SPOUSE",
"sinceDate": "2004-02-10"
},
{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SIBLING",
"sinceDate": "1960-01-29"
}
],
"partyTags": [{"tag": "Asuntosijoittaja",
"sinceDate": "2015-01-01"
}
],
"visibleToOtherUsers": true
},
"estateParty": {"estateName": "Matti Virtasen jakamaton kuolinpesä",
"deceasedPerson": {"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"firstName": "Matti",
"lastName": "Virtanen",
"nationality": "FI",
"preferredLanguageCode": "fi",
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Kirkkokatu 5 A 35",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
]
},
"estateShareholders": [{"partyId": "6abbd9a5-560d-4505-9d27-72909c8f2d9d",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "bfcb3c62-e805-4db4-831a-cddd81e0cda9",
"partyTypeCode": "ESTATE_PARTY"
}
],
"estateAdministrators": [{"partyId": "fa1e2be9-c562-4647-b4b6-459441bb0e2f",
"partyTypeCode": "ORGANIZATION_PARTY"
}
],
"contactMethods": [{"contactMethodCode": "EMAIL",
"value": "jussi.laihanen@example.com",
"description": "Pesänhoitaja"
}
]
}
}

Response samples

Content type

application/json

{"partyId": "1ba7f781-77a0-451b-a2fa-5f293050c940"
}

Fetch an estate party

Fetch details for the specified estate party.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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

{"partyId": "9ae034b7-9461-448a-ad86-f99025247119",
"party": {"partyTypeCode": "ESTATE_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-12-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2014-07-01"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SPOUSE",
"sinceDate": "2004-02-10"
},
{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SIBLING",
"sinceDate": "1960-01-29"
}
],
"partyTags": [{"tag": "Asuntosijoittaja",
"sinceDate": "2015-01-01"
}
],
"visibleToOtherUsers": true
},
"estateParty": {"estateName": "Matti Virtasen jakamaton kuolinpesä",
"deceasedPerson": {"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"firstName": "Matti",
"lastName": "Virtanen",
"nationality": "FI",
"preferredLanguageCode": "fi",
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Kirkkokatu 5 A 34",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
]
},
"estateShareholders": [{"partyId": "6abbd9a5-560d-4505-9d27-72909c8f2d9d",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "bfcb3c62-e805-4db4-831a-cddd81e0cda9",
"partyTypeCode": "ESTATE_PARTY"
}
],
"estateAdministrators": [{"partyId": "fa1e2be9-c562-4647-b4b6-459441bb0e2f",
"partyTypeCode": "ORGANIZATION_PARTY"
}
],
"complianceVerification": {"partyIdentified": true,
"complianceVerificationId": "f8eb65e9-ae7b-40e6-a958-1ccfc98fda4d"
},
"contactMethods": [{"contactMethodCode": "EMAIL",
"value": "jussi.laihanen@example.com",
"description": "Pesänhoitaja"
}
]
},
"creationTime": "2021-03-13T12:07:23+00:00",
"modificationTime": "2021-08-15T08:04:44+00:00"
}

Update an estate party

Update the details of the estate party whose id is given as a path variable.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the estate party to be updated.

partyId required	string <uuid> (PartyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Unique identifier for the party in the UUID format.
required	object (Party) Party details, including the official identifiers.
required	object (EstatePartyWrite) Estate party details.

Responses

Request samples

Payload

Content type

application/json

{"partyId": "9ae034b7-9461-448a-ad86-f99025247119",
"party": {"partyTypeCode": "ESTATE_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2015-12-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2014-07-01"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"roleCode": "RESPONSIBLE_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SPOUSE",
"sinceDate": "2004-02-10"
},
{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "SIBLING",
"sinceDate": "1960-01-29"
}
],
"partyTags": [{"tag": "Asuntosijoittaja",
"sinceDate": "2015-01-01"
}
],
"visibleToOtherUsers": true
},
"estateParty": {"estateName": "Matti Virtasen jakamaton kuolinpesä",
"deceasedPerson": {"officialIdentifiers": [{"officialId": "241089-901K",
"schemeId": "FI:PERSON"
}
],
"firstName": "Matti",
"lastName": "Virtanen",
"nationality": "FI",
"preferredLanguageCode": "fi",
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Kirkkokatu 3 A 35",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
]
},
"estateShareholders": [{"partyId": "6abbd9a5-560d-4505-9d27-72909c8f2d9d",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "bfcb3c62-e805-4db4-831a-cddd81e0cda9",
"partyTypeCode": "ESTATE_PARTY"
}
],
"estateAdministrators": [{"partyId": "fa1e2be9-c562-4647-b4b6-459441bb0e2f",
"partyTypeCode": "ORGANIZATION_PARTY"
}
],
"contactMethods": [{"contactMethodCode": "EMAIL",
"value": "jussi.laihanen@example.com",
"description": "Pesänhoitaja"
}
]
}
}

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"
}
]
}

Organization Party

Organization Party API allows you to create, update and fetch organisation as a party

Create an organization party

Create a new organization party.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the details for the organization party.

required	object (Party) Party details, including the official identifiers.
required	object (OrganizationPartyWrite) Organization party details.
creationTime	string <date-time> (CreationTime) Creation time of the party. The creation time is automatically set, if this field is not provided.

Responses

Request samples

Payload

Content type

application/json

{"party": {"partyTypeCode": "ORGANIZATION_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2019-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2019-07-15"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"roleCode": "RESPONSIBLE_AGENT"
},
{"agentId": "386654b2-882f-442e-9ffe-7d6b6e367715",
"roleCode": "ACQUISITION_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "ACCOUNTING_PARTNER",
"sinceDate": "2020-10-05"
}
],
"partyTags": [{"tag": "PK-yritys",
"sinceDate": "2021-04-15"
}
],
"attorneysInFact": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"partyTypeCode": "ORGANIZATION_PARTY",
"powerOfAttorneyDocumentId": "399f1e99-6131-4971-b86e-f2e4d74b4793"
}
],
"visibleToOtherUsers": true,
"invoicing": {"invoicingMethodCode": "EINVOICING",
"eInvoicing": {"eInvoicingAddress": "003702472382",
"operatorId": "E204503",
"operatorName": "OpusCapita Solutions Oy"
}
}
},
"organizationParty": {"officialIdentifiers": [{"officialId": "FI02472382",
"schemeId": "VAT"
},
{"officialId": "0247238-6",
"schemeId": "FI:ORGNR"
}
],
"officialName": "Pohjolan Matkat Oy",
"marketingName": "Pohjolan Matkat",
"nationality": "FI",
"preferredLanguageCode": "fi",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Yrityksen vaihde"
},
{"contactMethodCode": "EMAIL",
"value": "pohjolanmatkat.info@example.com",
"description": "Ainoastaan yleiset kyselyt"
}
],
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "PL 342",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
},
{"addressTypeCode": "VISITING_ADDRESS",
"addressLine1": "Yliopistonkatu 55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
],
"beneficialOwners": [ ],
"nameHolders": [{"partyId": "e8d19c3f-2a95-4a65-9316-15363a2a0dcb"
},
{"partyId": "efc41e37-5573-4e9b-a3f7-e13147f16e89"
}
]
}
}

Response samples

Content type

application/json

{"partyId": "1ba7f781-77a0-451b-a2fa-5f293050c940"
}

Fetch an organization party

Fetch details for the specified organization party.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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

{"partyId": "a0ab6e4c-0c88-4f58-94b7-a97796735135",
"party": {"partyTypeCode": "ORGANIZATION_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2019-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2019-07-15"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"roleCode": "RESPONSIBLE_AGENT"
},
{"agentId": "386654b2-882f-442e-9ffe-7d6b6e367715",
"roleCode": "ACQUISITION_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "ACCOUNTING_PARTNER",
"sinceDate": "2020-10-05"
}
],
"partyTags": [{"tag": "PK-yritys",
"sinceDate": "2021-04-15"
}
],
"attorneysInFact": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"partyTypeCode": "ORGANIZATION_PARTY",
"powerOfAttorneyDocumentId": "399f1e99-6131-4971-b86e-f2e4d74b4793"
}
],
"visibleToOtherUsers": true,
"invoicing": {"invoicingMethodCode": "EINVOICING",
"eInvoicing": {"eInvoicingAddress": "003702472382",
"operatorId": "E204503",
"operatorName": "OpusCapita Solutions Oy"
}
}
},
"organizationParty": {"officialIdentifiers": [{"officialId": "FI02472382",
"schemeId": "VAT"
},
{"officialId": "0247238-6",
"schemeId": "FI:ORGNR"
}
],
"officialName": "Pohjolan Matkat Oy",
"marketingName": "Pohjolan Matkat",
"nationality": "FI",
"preferredLanguageCode": "fi",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Yrityksen vaihde"
},
{"contactMethodCode": "EMAIL",
"value": "pohjolanmatkat.info@example.com",
"description": "Ainoastaan yleiset kyselyt"
}
],
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "PL 342",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
},
{"addressTypeCode": "VISITING_ADDRESS",
"addressLine1": "Yliopistonkatu 55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
],
"beneficialOwners": [ ],
"nameHolders": [{"partyId": "e8d19c3f-2a95-4a65-9316-15363a2a0dcb",
"partyTypeCode": "PERSON_PARTY"
},
{"partyId": "efc41e37-5573-4e9b-a3f7-e13147f16e89",
"partyTypeCode": "PERSON_PARTY"
}
]
},
"creationTime": "2021-03-13T12:07:23+00:00",
"modificationTime": "2021-08-15T08:04:44+00:00"
}

Update an organization party

Update the details of the organization party whose id is given as a path variable.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the organization party to be updated.

partyId required	string <uuid> (PartyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Unique identifier for the party in the UUID format.
required	object (Party) Party details, including the official identifiers.
required	object (OrganizationPartyWrite) Organization party details.

Responses

Request samples

Payload

Content type

application/json

{"partyId": "a0ab6e4c-0c88-4f58-94b7-a97796735135",
"party": {"partyTypeCode": "ORGANIZATION_PARTY",
"partyRoles": [{"partyRoleCode": "SELLER_CUSTOMER",
"sinceDate": "2019-07-15"
},
{"partyRoleCode": "BUYER_CUSTOMER",
"sinceDate": "2019-07-15"
}
],
"agencyOfficeId": "212114ec-819e-483c-a8e0-f82289ac6e19",
"agents": [{"agentId": "da3a543e-4220-4c1f-8cda-2ae0b2e596e0",
"roleCode": "RESPONSIBLE_AGENT"
},
{"agentId": "386654b2-882f-442e-9ffe-7d6b6e367715",
"roleCode": "ACQUISITION_AGENT"
}
],
"relatedParties": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"relatedPartyRoleCode": "ACCOUNTING_PARTNER",
"sinceDate": "2020-10-05"
}
],
"partyTags": [{"tag": "PK-yritys",
"sinceDate": "2021-04-15"
}
],
"attorneysInFact": [{"partyId": "292e85f2-390b-4d23-a70f-302e0534a46b",
"partyTypeCode": "ORGANIZATION_PARTY",
"powerOfAttorneyDocumentId": "399f1e99-6131-4971-b86e-f2e4d74b4793"
}
],
"visibleToOtherUsers": true,
"invoicing": {"invoicingMethodCode": "EINVOICING",
"eInvoicing": {"eInvoicingAddress": "003702472382",
"operatorId": "E204503",
"operatorName": "OpusCapita Solutions Oy"
}
}
},
"organizationParty": {"officialIdentifiers": [{"officialId": "FI02472382",
"schemeId": "VAT"
},
{"officialId": "0247238-6",
"schemeId": "FI:ORGNR"
}
],
"officialName": "Pohjolan Matkat Oy",
"marketingName": "Pohjolan Matkat",
"nationality": "FI",
"preferredLanguageCode": "fi",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678",
"description": "Yrityksen vaihde"
},
{"contactMethodCode": "EMAIL",
"value": "pohjolanmatkat.info@example.com",
"description": "Ainoastaan yleiset kyselyt"
}
],
"addresses": [{"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "PL 342",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
},
{"addressTypeCode": "VISITING_ADDRESS",
"addressLine1": "Yliopistonkatu 55",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
}
],
"beneficialOwners": [ ],
"nameHolders": [{"partyId": "e8d19c3f-2a95-4a65-9316-15363a2a0dcb"
},
{"partyId": "efc41e37-5573-4e9b-a3f7-e13147f16e89"
}
]
}
}

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"
}
]
}

Party Compliance Verification

Party Compliance Verification API allows you to create and fetch compliance verifications for a party

Create a party compliance verification

Create a new party compliance verification.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the details for the party compliance verification.

required

object (ComplianceVerification)

Compliance verification details as part of KYC (Known Your Customer) and AML (Anti-Money Laundering) process.

Responses

Request samples

Payload

Content type

application/json

{"complianceVerification": {"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"partyIdentified": true,
"identityVerification": {"identificationMethodCode": "IDENTIFIED_BY_PERSONNEL",
"countryCode": "FI",
"identificationDocument": {"identificationDocumentTypeCode": "IDENTITY_CARD",
"officialDocumentId": "536212634",
"dateOfIssue": "2019-12-28",
"expirationDate": "2024-12-28",
"issuingAuthority": "POLIISI/HELSINKI VÄESTÖREKISTERIKESKUS",
"documentId": "fe8260e6-598d-4590-8ca1-e2d919d3b774"
}
},
"pepVerificationCompleted": true,
"pepVerification": {"pepVerificationMethodCode": "SIGNED_FORM_BY_PARTY",
"isPoliticallyExposedPerson": true,
"pepDescription": "Isä on toiminut poliittisen puolueen johtoelimen jäsenenä vuodesta 2018.",
"dateVerificationSigned": "2021-09-12",
"documentId": "f5158346-c8b3-43a2-8497-541ba0b3d578"
}
}
}

Response samples

Content type

application/json

{"complianceVerificationId": "5314ed18-b9cf-42dc-b889-4af9ad8071a2"
}

Fetch party compliance verifications

Fetch party compliance verifications by using different search criteria. You can combine the search criteria, for example to search for only the latest verification for a party.

Authorizations:

bearerAuth

query Parameters

partyId	string <uuid> (PartyId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Example: partyId=1803ca58-50ea-422b-a1f8-330289b67fe2 Search by the party identifier to fetch the all the compliance verifications for the specified party.
latest	boolean Example: latest=true Search to find the latest compliance verification for the specified party. This parameter can be used together with `partyId` query parameter.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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": 2,
"complianceVerifications": [{"complianceVerificationId": "659aa81f-b0cb-46f0-8d5a-b90ab01e4431",
"complianceVerification": {"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"partyIdentified": true,
"identityVerification": {"identificationMethodCode": "IDENTIFIED_BY_PERSONNEL",
"countryCode": "FI",
"identificationDocument": {"identificationDocumentTypeCode": "IDENTITY_CARD",
"officialDocumentId": "536212634",
"dateOfIssue": "2019-12-28",
"expirationDate": "2024-12-28",
"issuingAuthority": "POLIISI/HELSINKI VÄESTÖREKISTERIKESKUS",
"documentId": "fe8260e6-598d-4590-8ca1-e2d919d3b774"
}
},
"pepVerificationCompleted": true,
"pepVerification": {"pepVerificationMethodCode": "SIGNED_FORM_BY_PARTY",
"isPoliticallyExposedPerson": true,
"pepDescription": "Isä on toiminut poliittisen puolueen johtoelimen jäsenenä vuodesta 2018.",
"dateVerificationSigned": "2021-09-12",
"documentId": "f5158346-c8b3-43a2-8497-541ba0b3d578"
},
"complianceVerificationDocumentStatusCode": "UNSIGNED"
},
"creationTime": "2021-06-05T11:03:43+00:00",
"modificationTime": "2021-06-06T09:04:44+00:00"
},
{"complianceVerificationId": "239e418d-beed-4a19-97fa-0593462d81b4",
"complianceVerification": {"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"partyIdentified": true,
"identityVerification": {"identificationMethodCode": "IDENTIFIED_BY_PERSONNEL",
"countryCode": "FI",
"identificationDocument": {"identificationDocumentTypeCode": "DRIVING_LICENSE",
"officialDocumentId": "SE234542",
"dateOfIssue": "2018-12-28",
"expirationDate": "2024-12-28",
"issuingAuthority": "Transportstyrelsen",
"documentId": "3e48cccb-039d-4538-9e36-3c4def03f056"
}
},
"pepVerificationCompleted": true,
"pepVerification": {"pepVerificationMethodCode": "SIGNED_FORM_BY_PARTY",
"isPoliticallyExposedPerson": false,
"pepDescription": "Ei poliittisia kytkentöjä.",
"dateVerificationSigned": "2021-09-12",
"documentId": "7704466b-4a2f-4a5f-80e8-27796fa19ed6"
},
"complianceVerificationDocumentStatusCode": "UNSIGNED"
},
"creationTime": "2016-09-06T11:03:43+00:00",
"modificationTime": "2016-09-03T08:07:13+00:00"
}
]
}

Update a compliance verification

Update the details of the compliance verification whose id is given as a path variable.

Authorizations:

bearerAuth

path Parameters

complianceVerificationId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique compliance verification identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Contains the compliance verification to be updated.

complianceVerificationId required	string <uuid> (ComplianceVerificationId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Unique identifier for the party compliance verification id in the UUID format.
required	object (ComplianceVerificationUpdate) Compliance verification details as part of KYC (Known Your Customer) and AML (Anti-Money Laundering) process.

Responses

Request samples

Payload

Content type

application/json

{"complianceVerificationId": "659aa81f-b0cb-46f0-8d5a-b90ab01e4431",
"complianceVerification": {"partyId": "ace3c93a-c347-41e8-a069-6a4e550258f7",
"partyIdentified": true,
"identityVerification": {"identificationMethodCode": "IDENTIFIED_BY_PERSONNEL",
"countryCode": "FI",
"identificationDocument": {"identificationDocumentTypeCode": "IDENTITY_CARD",
"officialDocumentId": "536212634",
"dateOfIssue": "2019-12-28",
"expirationDate": "2024-12-28",
"issuingAuthority": "POLIISI/HELSINKI VÄESTÖREKISTERIKESKUS",
"documentId": "fe8260e6-598d-4590-8ca1-e2d919d3b774"
}
},
"pepVerificationCompleted": true,
"pepVerification": {"pepVerificationMethodCode": "SIGNED_FORM_BY_PARTY",
"isPoliticallyExposedPerson": true,
"pepDescription": "Isä on toiminut poliittisen puolueen johtoelimen jäsenenä vuodesta 2018.",
"dateVerificationSigned": "2021-09-12",
"documentId": "f5158346-c8b3-43a2-8497-541ba0b3d578"
},
"complianceVerificationDocumentStatusCode": "UNSIGNED"
}
}

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"
}
]
}

Generate and save compliance verification PDF-document

Generates a PDF document with party compliance verification form content and saves it to Document API. If this compliance verification has unsigned compliance verification PDF it will be overwritten.

Authorizations:

bearerAuth

path Parameters

complianceVerificationId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique compliance verification identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Empty body

object (PostPartyComplianceVerificationPdfRequest)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"complianceVerificationDocumentId": "d68b6dbe-9772-4950-aac5-7b3579eb82ad"
}

Notes

Notes API allows you to create, fetch, update and delete notes

Create a new note

Create a new note. One party can have maximum 20 notes.

Authorizations:

bearerAuth

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Request body contains details of the note to be created.

note required	string The content of the note
partyId required	string <uuid> The party id related to the note.

Responses

Request samples

Payload

Content type

application/json

{"note": "This is a note.",
"partyId": "123e4567-e89b-12d3-a456-426655440000"
}

Response samples

Content type

application/json

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

Search notes

Search notes with specified parameters.

Authorizations:

bearerAuth

query Parameters

partyId

required

string <uuid>

Identifier of the party for which notes are searched.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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,
"notes": [{"noteId": "c6d2288d-2ecb-448a-aef3-fd5144920e0b",
"note": "This is a note.",
"partyId": "123e4567-e89b-12d3-a456-426655440000",
"creationTime": "2021-01-01T00:00:00Z",
"modificationTime": "2021-01-01T00:00:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426655440000",
"modifiedBy": "123e4567-e89b-12d3-a456-426655440000"
}
]
}

Update a note

Update a note.

Authorizations:

bearerAuth

path Parameters

noteId

required

string <uuid>

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

Identifier of the note

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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
required

Request body contains details of the note to be updated.

note

required

string

The content of the note

Responses

Request samples

Payload

Content type

application/json

{"note": "This is a note."
}

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"
}
]
}

Delete a note

Delete a note.

Authorizations:

bearerAuth

path Parameters

noteId

required

string <uuid>

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

Identifier of the note

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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

{"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"
}
]
}

GDPR

GDPR API allows you to view parties retention bases

Fetch retention bases for Party

Fetch summary of retention bases for given party.

Authorizations:

bearerAuth

path Parameters

partyId

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

Example: ddc25849-7bc7-43c0-9c3b-602cb03f7806

Unique party identifier in UUID format.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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

{"partyId": "73460928-e87d-4fd8-a246-3d9a2531be7f",
"partyCreationTime": "2023-11-14T23:59:59Z",
"legalRetentionBases": {"generatedAssignmentNumber": {"validUntil": "2020-01-14",
"validityStatusCode": "EXPIRED"
},
"finishedAssignment": {"validUntil": "2020-02-05",
"validityStatusCode": "EXPIRED"
},
"completedTrade": {"validUntil": "2020-02-04",
"validityStatusCode": "EXPIRED"
},
"generatedInvoiceNumber": {"validUntil": "2024-03-13",
"validityStatusCode": "VALID"
}
},
"technicalRetentionBases": {"marketingConsent": true,
"isEstatePartyMember": false,
"isOrganizationPartyMember": false,
"partyDataIsInUse": true
}
}

Fetch parties that should be removed

Fetch parties that have no ongoing activity or active retention basis and should therefore be removed. Parties are ordered by time when the last retention basis for each party was expired.

Authorizations:

bearerAuth

query Parameters

agencyOfficeId required	Array of strings <uuid> (AgencyOfficeId) non-empty [^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...] Example: agencyOfficeId=7bdffe48-0077-4de0-acd4-d9b9b1ab49f8
startIndex	integer <int32> >= 0 Default: 0 Example: startIndex=20 Paginate returned documents starting from this index. Index starts from 0.
size	integer <int32> [ 1 .. 200 ] Default: 100 Example: size=40 Documents returned per page.

header Parameters

Request-ID

required

string <uuid> ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8...

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": 2,
"parties": [{"partyId": "756b0618-9b15-49d3-9564-7bda05c12532",
"partyTypeCode": "PERSON_PARTY",
"partyName": "Teuvo Testiläinen",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678"
},
{"contactMethodCode": "EMAIL",
"value": "teuvo@example.com"
}
],
"address": {"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "Mannerheimintie 6 B 16",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
},
"retentionBasesEnded": "2023-11-14T23:59:59Z",
"partyRemovalStartedTime": "2024-04-21T13:02:40Z"
},
{"partyId": "0da95ea1-7a4f-47c0-8ed9-ab8bda738478",
"partyTypeCode": "ORGANIZATION_PARTY",
"partyName": "Maansiirtourakointi A. Jokinen Oy",
"contactMethods": [{"contactMethodCode": "PHONE",
"value": "+358501235678"
},
{"contactMethodCode": "EMAIL",
"value": "maansiirto@example.com"
}
],
"address": {"addressTypeCode": "POSTAL_ADDRESS",
"addressLine1": "PL 342",
"postcode": "33100",
"postalArea": "Tampere",
"localityName": "Tampere",
"countryCode": "FI"
},
"retentionBasesEnded": "2023-11-16T23:59:59Z"
}
]
}

GDPR settings

GDPR settings API can be used by main users of the agency or agency office to configure automatic removal of agency's parties

agencyOfficeId required	string <uuid> (AgencyOfficeId) ^([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[8... Unique identifier for the agency office in the UUID format.
automaticPartyRemovalEnabled required	boolean (AutomaticPartyRemovalEnabled) If set to true agency's parties will be automatically removed 30 days after their retention basis has expired.

Party API (1.0)

Introduction

Contact

Party

Fetch parties

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Delete party

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Person Party

Create a person party

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch a person party

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update a person party

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Estate Party

Create an estate party

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch an estate party

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update an estate party

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Organization Party

Create an organization party

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch an organization party

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update an organization party

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required