Hakemusrajapinnat
Huoneistotietojärjestelmän hakemusrajapintojen tekninen dokumentaatio
(päivitetty 13.1.2020)
HUOM! Palvelut eivät ole vielä käytössä, ja niihin saattaa tulla muutoksia. Katso tarkempi aikataulu.
Yleistä
Hakemusrajapinta on huoneistotietojärjestelmän palvelu, jonka kautta käyttäjä voi integraattorin välittämänä toimittaa sähköisesti hakemuksia sekä asiakirjoja Maanmittauslaitokselle. Rajapintapalvelujen käyttö edellyttää sopimusta.
Hakemusrajapintapalveluihin on suunniteltu mm. seuraavia toiminnallisuuksia:
- Omistuksen rekisteröiminen
- Panttauksen rekisteröiminen
- Turva-asiakirjojen säilyttäjän ilmoitus (RS-menettelyn alkaessa)
- Hakemuksen tilakysely
- Hakemusten täydennys
- RS-menettelyn päättyminen, omistuksen ja panttauksen ilmoittaminen sekä rajoitukset
Nämä hakemusrajapinnat on suunnattu pankkien käyttöön. Pankki lähettää hakemuksia rajapintaan sekä hakijana että asiakkaansa asiamiehenä. Hakemukset lähetetään KVP-tiimin hallinnoimaan MIAS-komponenttiin, joka tarkistaa, että integraattorin antamat sopimustiedot vastaavat varmenteen CN-kenttiä. MIAS sitten reitittää hakemuksen URL:n perusteella oikeaan järjestelmään. Integraattorit voivat kysyä ongelmatapauksissa apua Rocketchat-kanavalta.
KVP-kehitysympäristön url
https://kvp-kehitys-ws.nls.fi/htj
Esimerkki:
curl -v --insecure --cert test.crt --key test.key --request POST --databinary @testiHakemus.json --header "Content-Type: application/json" https://kvp-kehitys-ws.nls.fi/htj/v1/yhtiot/123456-7/osakeryhmat/osryh2/hakemukset/panttauksen-poistaminen
Sopimustiedot
Sopimustunnus ja Y-tunnus ovat pankkikohtaisia ja pakollisia, sopimusyhteyshenkilön (lähettäjä) nimi ja yhteystiedot voidaan jättää pois.
Schemat ja esimerkit
hakemusrajapinta_esimsanomat_20191104.zip
hakemusrajapinta_skeemat_20191104.zip
Omistuksen kirjaaminen
URL-osoitteen formaatti: /v1/yhtiot/{ytunnus}/osakeryhmat/{osakeryhmatunnus}/hakemukset/omistuksen-kirjaaminen
Pankki lähettää omistuksen kirjaamishakemuksen asiakkaansa puolesta varmistaakseen, että hän saa pantatun kohteen omistusoikeuden.
Esimerkkisanoma: Omistuksen kirjaaminen
{ "sopimustiedot": { "sopimustunnus": "Sopimus12345", "lahettaja": { "ytunnus": "7772165-8" } }, "hakemus": { "asiointikieli": "fi", "yhteyshenkilo": { "nimi": "Yrjö Yhteyshenkilö", "sahkopostiosoite": "[email protected]", "puhelinnumero": "+35851234567" }, "luovutus": { "saantopvm": "30.05.2018", "saantolaji": "KAUPPA", "luovuttajat": [ { "henkilolaji": "YHTIO_TAI_SAATIO", "omistusosuusOsoittaja": 1, "omistusosuusNimittaja": 2, "tunnus": "0245954-4", "toiminimi": "Oy Capital Investment Ab" } ], "saajat": [ { "henkilolaji": "LUONNOLLINEN_HENKILO", "etunimi": "Hasse", "sukunimi": "Hakija", "tunnus": "120464-126J", "omistusosuusOsoittaja": 1, "omistusosuusNimittaja": 2, "katuosoite": "Osoite", "postinumero": "00100", "sahkopostiosoite": "string@stri" } ] } } }
Panttaus
URL-osoitteen formaatti: /v1/yhtiot/{ytunnus}/osakeryhmat/{osakeryhmatunnus}/hakemukset/panttaus
Pankki hakee panttausta varmistaakseen, että asiakkaan velka tulee tavalla tai toisella maksetuksi. Toimiessaan ripeästi pankki varmistaa panttaukselleen parhaan vapaan etusijan ja siten lukitsee järjestyksen, jossa asiakkaan velat maksetaan pois. (Etusijajärjestyksen muuttamista tulee mahdolliseksi hakea myöhemmässä vaiheessa)
Esimerkkisanoma: Panttaus
{ "sopimustiedot": { "sopimustunnus": "Sopimus12345", "lahettaja": { "ytunnus": "1701655-1" } }, "hakemus": { "asiointikieli": "fi", "yhteyshenkilo": { "nimi": "Yrjö Yhteyshenkilö", "puhelinnumero": "+3581234567", "sahkopostiosoite": "[email protected]" }, "panttaukset": [ { "omistajat": [ { "henkilolaji": "LUONNOLLINEN_HENKILO", "omistusosuusNimittaja": 1, "omistusosuusOsoittaja": 1, "tunnus": "121212-123A", "toiminimi": "Anssi Kukkonen" } ], "kokoArvo": false, "pantinsaajat": [ { "tunnus": "200498-945W", "henkilolaji": "LUONNOLLINEN_HENKILO", "nimi": "Jane James" }, { "tunnus": "271172-9672", "henkilolaji": "LUONNOLLINEN_HENKILO", "nimi": "John Doe" } ], "rahamaara": 60000 } ] } }
Panttauksen poistaminen
URL-osoitteen formaatti: /v1/yhtiot/{ytunnus}/osakeryhmat/{osakeryhmatunnus}/hakemukset/panttauksen-poistaminen
Esimerkkisanoma: Panttauksen poisto
{ "sopimustiedot": { "sopimustunnus": "Sopimus12345", "lahettaja": { "ytunnus": "7772165-8", "yhteyshenkilo": "Mikko Yhteyshenkilö", "sahkopostiosoite": "[email protected]", "puhelinnumero": "+3581234567" } }, "hakemus": { "asiointikieli": "fi", "yhteyshenkilo": { "nimi": "Yrjö Yhteyshenkilö", "sahkopostiosoite": "[email protected]", "puhelinnumero": "+35851234567" }, "hakemustunnus": "51aff448-ec10-4a8d-82ca-d4b3016734a8" } }
RS-ilmoituksen kirjaaminen
(RS-aloitusilmoitus eli turva-asiakirjojen säilyttäjän ilmoitus)
URL-osoitteen formaatti: /v1/yhtiot/{ytunnus}/hakemukset/rs-ilmoituksen-kirjaaminen
Ilmoittava RS-pankki tulee yksilöidä lähettäjä-osion ytunnus-kentällä. Vain ilmoittava pankki voi poistaa RS-rajoituksen.
Esimerkkisanoma: RS-ilmoituksen kirjaaminen
{ "sopimustiedot": { "sopimustunnus": "Sopimus12345", "lahettaja": { "ytunnus": "7772165-8", "yhteyshenkilo": "Mikko Yhteyshenkilö", "sahkopostiosoite": "[email protected]", "puhelinnumero": "+3581234567" } }, "osakeryhmat":[ "osryh1", "osryh16", "osryh24" ] }
Vastaus
Onnistunut vastaus (paitsi rs-ilmoitus)
{ "status": "ok", "message": { "hakemustunnus": "2e750922-8da8-47c6-9bb1-64f577919f7f" } }
Onnistunut rs-ilmoitus -vastaus { "status": "ok", "message": { "hakemustunnus": "f6047450-eeed-4e06-9cd5-e0fa2e37a44d", "rajoitukset": [ { "rajoitustunnus": "5165", "osakeryhmatunnus": "osryh1" }, { "rajoitustunnus": "5173", "osakeryhmatunnus": "osryh16" }, { "rajoitustunnus": "5181", "osakeryhmatunnus": "osryh24" } ] } }
Virhevastaus
{ "status": "error", "message": "hallintaoikeutta ei löytynyt: 0245954-4" }