Ohjelmistokehittäjille
Tältä sivulta löydät kootusti tietoa ja ohjeita rekisterin rajapinnoista sekä sidosryhmätestauksesta:
- Dokumentaatio-sivu: erilaiset tekniset ohjeet, kuten rajapintakuvaukset
- Sidosryhmätestaus-sivu: sidosryhmätestauksen ohjeet
- Varmenne-sivu: tietoa rajapintojen käyttöön tarvittavista varmenteista.
Lue teknisten ohjeiden lisäksi myös tärkeät ohjeet tietojen ilmoittamiseen ja kyselemiseen:
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje: mitä ilmoitusvelvollisuus tarkoittaa, mitä luottoja rekisteriin pitää ilmoittaa, mitä tietosisältöjä luotoista ilmoitetaan, missä määräajoissa ja miten.
- Tietojen luovuttaminen positiivisesta luottotietorekisteristä -sivu: mitä tietoja rekisteristä voi kysellä, eli mitä tietoja rekisteristä luovutetaan, kenelle ja mihin käyttötarkoituksiin.
Tekniset rajapinnat ja niiden käyttö
Rekisterin käyttäjät eli tietojen ilmoittajat ja tiedon hyödyntäjät käyttävät rajapintoja. Teknisellä rajapinnalla tarkoitetaan tiettyjen määritysten mukaista liittymää, jota käytetään tiedon vaihtoon ulkopuolisen toimijan ja rekisterin välillä. Rekisterin rajapinnat ovat REST-rajapintoja, joissa on JSON-tietosisältö.
Rajapinnan käyttöä varten käyttäjä tarvitsee Verohallinnon myöntämän varmenteen, jolla tunnistetaan rajapintaa käyttävä organisaatio ja varmistetaan aineiston muuttumattomuus. Varmenteesta ja sen noutamisesta löydät lisätietoa Varmenne-sivulta. Tuotannossa on käytössä eri varmenteet kuin testausympäristössä.
Ilmoittamisen rajapinnat ja niiden osoitteet
Luotonantajilla on käytössään alla olevat tietojen ilmoittamisen rajapinnat. Niiden käyttöön luotonantaja tarvitsee ilmoittamisen varmenteen.
Uusi luotto: https://api.positiivinenluottotietorekisteri.fi/AddLoans
- Ilmoita rajapinnassa olemassa oleva luottokanta. Ilmoita tässä rajapinnassa myös uusien luottojen tiedot.
- Luoton tietojen ilmoittaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Luoton tietojen muutos: https://api.positiivinenluottotietorekisteri.fi/UpdateLoans
- Ilmoita rajapinnassa tietyt luottojen tiedoissa tapahtuvat muutokset. Huomaa, että tässä rajapinnassa ei ilmoiteta seuraavia muutoksia: maksutapahtumat, maksuviiveet, tieto eräännyttämisestä sekä luoton päättyminen tai siirtyminen. Ne ilmoitetaan muissa rajapinnoissa.
- Luoton tietojen ilmoittaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Maksutapahtuma: https://api.positiivinenluottotietorekisteri.fi/Repayments
- Ilmoita rajapinnassa luottojen maksutapahtumat.
- Luoton tietojen ilmoittaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Maksuviive: https://api.positiivinenluottotietorekisteri.fi/DelayedRepayments
- Ilmoita rajapinnassa yli 60 päivää eräpäivästä viivästyneet maksuerät sekä tieto siitä, että luotto on eräännytetty.
- Luoton tietojen ilmoittaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Luoton päättyminen: https://api.positiivinenluottotietorekisteri.fi/TerminateLoans
- Ilmoita rajapinnassa, kun luotto päättyy tai se siirretään toiselle luotonantajalle.
- Luoton tietojen ilmoittaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Lähetetyn aineiston tilan kysely: https://api.positiivinenluottotietorekisteri.fi/GetBatchStatus
- Kysy lähetetyn aineiston tila aina aineiston lähetyksen jälkeen aineistoviitteellä. Vastaussanomassa palautetaan mahdolliset aineiston virheet.
- Luoton tietojen ilmoittaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Luoton tietojen tarkistaminen: https://api.positiivinenluottotietorekisteri.fi/GetLoan
- Voit tarkistaa rajapinnassa yksittäisen luoton tiedot luoton numerolla.
- Luoton tietojen tarkistaminen – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen ilmoittaminen positiiviseen luottotietorekisteriin -ohje.
Tietojen kyselyn rajapinta
Luotonantajilla on käytössään alla oleva tietojen kyselyn rajapinta. Sen käyttöön luotonantaja tarvitsee tietojen hyödyntämisen varmenteen.
Luottotietorekisteriotteen kysely: https://api.positiivinenluottotietorekisteri.fi/GetCreditRegisterExtract
- Kysele luottotietorekisteriote rajapinnasta henkilötunnuksella.
- Luottotietorekisteriotteen kysely – rajapintakuvaus dokumentaatio-sivulla.
- Tietojen luovuttaminen positiivisesta luottotietorekisteristä -ohje.