{"components":{"schemas":{"FullDate":{"format":"date-time","description":"Päivämäärä ja kellonaika ilman aikavyöhyketietoa.","type":"string"},"Date":{"format":"date","description":"Päivämäärä.","type":"string"}},"responses":{"Pong":{"description":"Pong","content":{"application/json":{"schema":{"type":"object","required":["serverTimestamp"],"properties":{"serverTimestamp":{"format":"date-time","description":"Päivämäärä ja kellonaika ilman aikavyöhyketietoa.","type":"string"}}}}}}}},"servers":[{"description":"Asiakastestausympäristö","url":"/api/v1"}],"openapi":"3.0.2","paths":{"/oleskelu/paatos":{"post":{"summary":"Oleskelupäätös","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"diaariVuosi":{"description":"Diaarin vuosi","maximum":2099,"type":"number","minimum":1900},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"jarjestysnumero":{"description":"Asian diaarin järjestysnumero","maximum":999999,"type":"number","minimum":1},"loppupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Tiedon loppupäivä. Voidaan jättää pois jos tieto on toistaiseksi voimassa."},"diaariryhmaTeksti":{"minLength":1,"description":"Diaariryhmä selväkielisenä","type":"string","maxLength":80},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (4).","type":"string","enum":["4"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Tiedon alkupäivä."},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1},"diaariryhmaKoodi":{"description":"Diaariryhmä koodina:\n  * 110: Ensimmäistä oleskelulupaa koskeva hakemus\n  * 120: Jatkolupahakemus\n  * 130: Pysyvää oleskelulupaa koskeva hakemus\n  * 140: EU-oleskeluoikeus\n  * 141: Oleskeluasema\n  * 150: Voimassa olevaa lupaa koskevat asiat\n  * 210: Turvapaikkahakemus\n  * 230: Kiintiöpakolaisvalinta, UNHCR:n esitys, Humanitaarinen maahanmuutto, VN:n päätös\n  * 250: Tilapäinen suojelu\n  * 450: Maasta karkottaminen\n","type":"number","enum":[110,120,130,140,141,150,210,230,250,450]},"asiaId":{"description":"Asian tekninen avain","type":"number"}},"required":["henkilotunnus","asiaId","jarjestysnumero","diaariryhmaKoodi","diaariryhmaTeksti","diaariVuosi","alkupaiva","kayttajatunnus","viranomaisnumero","viranomaistyyppi"]}],"type":"object","properties":{"paatosperuste":{"description":"Päätösperuste","additionalProperties":false,"type":"object","properties":{"koodi":{"minLength":1,"description":"Päätösperuste koodina. Arvo tarkastetaan VTJ:ssä olevaa koodistoa vasten.","type":"string"},"teksti":{"allOf":[{"additionalProperties":false,"type":"object","properties":{"swe":{"minLength":1,"description":"Koodiarvon kuvaus ruotsiksi.","type":"string","maxLength":80},"fin":{"minLength":1,"description":"Koodiarvon kuvaus suomeksi.","type":"string","maxLength":80},"eng":{"minLength":1,"description":"Koodiarvon kuvaus englanniksi.","type":"string","maxLength":80}},"required":["fin","swe","eng"]}],"description":"Päätösperusteen selväkielinen kuvaus."}},"required":["koodi","teksti"]},"paatosLainkohdat":{"minLength":1,"description":"Päätöksen perustelun lainkohdat vapaana tekstinä.","type":"string","maxLength":80},"paatostyyppi":{"description":"Päätöstyyppi","additionalProperties":false,"type":"object","properties":{"koodi":{"minLength":1,"description":"Päätöstyyppi koodina. Arvo tarkastetaan VTJ:ssä olevaa koodistoa vasten.","type":"string"},"teksti":{"allOf":[{"additionalProperties":false,"type":"object","properties":{"swe":{"minLength":1,"description":"Koodiarvon kuvaus ruotsiksi.","type":"string","maxLength":80},"fin":{"minLength":1,"description":"Koodiarvon kuvaus suomeksi.","type":"string","maxLength":80},"eng":{"minLength":1,"description":"Koodiarvon kuvaus englanniksi.","type":"string","maxLength":80}},"required":["fin","swe","eng"]}],"description":"Päätöstyypin selväkielinen kuvaus."}},"required":["koodi","teksti"]},"lajikoodi":{"description":"Tapahtumatyyppi. Oleskelupäätöksellä yksi seuraavista:\n* 100: Oleskelulupa\n* 101: Peruutettu oleskelulupa\n* 210: Rekisteröity EU-oleskeluoikeus\n* 211: Peruutettu EU-oleskeluoikeus\n","type":"number","enum":[100,101,210,211]},"pysyva":{"description":"Onko päätös pysyvä.","type":"boolean"},"paatoslaji":{"description":"Päätöksen laji:\n* A: jatkuva oleskelulupa\n* B: tilapäinen oleskelulupa\n* E: EU-kansalainen\n* EP\n* ETA: ETA-ansalainen\n* ETAP: ETA-kansalaisen perheenjäsen\n* P: pysyvä oleskelulupa\n* P-EU: pitkään oleskelleen kolmannen maan kansalaisen EU-oleskelulupa\n* P-EY: pitkään oleskelleen kolmannen maan kansalaisen EU-oleskelulupa\n","type":"string","enum":["A","B","E","EP","ETA","ETAP","P","P-EU","P-EY"]},"paatosTyoOikeusLainkohta":{"minLength":1,"description":"Päätöksen työnteon sallimisen lainkohta vapaana tekstinä muodossa NNsNNmNN.","type":"string","maxLength":10},"paatosnumero":{"description":"Oleskelupäätöksen numero","type":"number","minimum":1},"paatospaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Oleskelupäätöksen päivämäärä."},"paatosLainvoimaisuuspaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Päätöksen lainvoimaisuuspäivämäärä."}},"required":["lajikoodi","paatosnumero","paatospaiva","paatostyyppi","paatosperuste"],"example":{"kayttajatunnus":"user1234","paatostyyppi":{"koodi":"LAKKAUTETTU","teksti":{"swe":"Inställd","fin":"Lakkautettu","eng":"Discontinued"}},"diaariryhmaTeksti":"EU-oleskeluoikeus","pysyva":true,"viranomaistyyppi":4,"alkupaiva":"2026-03-16","viranomaisnumero":123,"diaariryhmaKoodi":140,"asiaId":987654,"diaariVuosi":2026,"paatosperuste":{"koodi":"EI_KIELITUTKINTOA","teksti":{"swe":"Avlade inte språkexamen","fin":"Ei suorittanut kielitutkintoa","eng":"Did not pass the language test"}},"paatosLainkohdat":"Tilapäinen määräaikainen","henkilotunnus":"020292-904T","jarjestysnumero":36700,"loppupaiva":"2026-03-30","lajikoodi":211,"paatoslaji":"E","paatosTyoOikeusLainkohta":"78§3m1k","paatospaiva":"2026-03-17","paatosLainvoimaisuuspaiva":"2026-03-17"}}}}},"description":"Oleskelulupapäätös tai EU-kansalaisen oleskeluoikeuspäätös.","responses":{"200":{"description":"Oleskelutiedot rekisteröity onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Oleskelu"]}},"/ero/avioliitto":{"post":{"summary":"Avioeron ilmoittaminen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["puolisoA","puolisoB","paatospaiva","ratkaisu","viranomaisnumero","viranomaistyyppi","kayttajatunnus"],"properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"puolisoA":{"description":"Avioeron vireillepanija","properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},"puolisoB":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö (lisäkenttänä sukupuoli)","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi","sukupuoli"],"properties":{"sukupuoli":{"description":"Henkilön sukupuoli","type":"string","enum":["1","2"]},"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}}],"description":"Avioeron toinen osapuoli."},"ratkaisu":{"description":"Ratkaisun tyyppi.","type":"string","enum":["ERO","MITATOITY","KUMOTTU"]},"viranomaistyyppi":{"type":"string","enum":["4"]},"paatospaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}}},"examples":{"ero":{"summary":"Avioeron ilmoittaminen","value":{"kayttajatunnus":"kayttajatunnus","puolisoA":{"henkilotunnus":"091001A9359"},"puolisoB":{"henkilotunnus":"240297-950S"},"ratkaisu":"ERO","viranomaistyyppi":"4","paatospaiva":"2024-09-10","viranomaisnumero":999999}}}}}},"description":"Rajapinta avioeron ilmoittamiseen.\n","responses":{"200":{"description":"Ero ilmoitettu onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"501":{"description":"Toiminnallisuutta ei ole vielä toteutettu"},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Erot"]}},"/nimenmuutos":{"post":{"summary":"Nimenmuutoksen tekeminen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"uusiNimi":{"description":"Ilmoittajan uusi nimi.","type":"string"},"nimilaji":{"description":"Nimilaji. 01 = sukunimi, 02 = etunimet","type":"string","enum":["01","02"]},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (1).","type":"string","enum":["1"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["henkilotunnus","kayttajatunnus","viranomaisnumero","viranomaistyyppi","uusiNimi","nimilaji"],"example":{"uusiNimi":"Jantunen","nimilaji":"01","henkilotunnus":"020292-904T","viranomaistyyppi":4,"viranomaisnumero":123}}}}},"responses":{"200":{"description":"Nimenmuutos toteutettu onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Nimenmuutos"]}},"/kuolema/julistus":{"post":{"summary":"Henkilön kuolleeksijulistuksen rekisteröinti","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kuolleeksijulistamispaiva":{"format":"date","description":"Vainajan kuolleeksijulistamispäivä.","type":"string"},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Vainajan henkilötunnus.","type":"string","maxLength":11},"sukunimi":{"minLength":1,"description":"Vainajan sukunimi.","type":"string","maxLength":100},"aidinHenkilotunnus":{"minLength":11,"description":"Vainajan äidin henkilötunnus. Pakollinen tieto jos vainajan suku- ja etunimiä ei ole annettu.","type":"string","maxLength":11},"kuolinpaiva":{"format":"date","description":"Vainajan kuolinpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Vainajan etunimet.","type":"string","maxLength":100},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["henkilotunnus","kuolinpaiva","kuolleeksijulistamispaiva","kayttajatunnus","viranomaisnumero"],"example":{"kuolleeksijulistamispaiva":"2024-04-12","kayttajatunnus":"abc1234","henkilotunnus":"010101-999X","laakarinYksilointitunnus":"352091","sukunimi":"Testinen","kuolinpaiva":"2023-12-08","etunimet":"Tes Esti","viranomaisnumero":123}}}}},"description":"Kuolleeksijulistuksen rajapinta on käytössä ainoastaan viranomaisilla, jotka käsittelevät kuolleeksi julistamisia.","responses":{"200":{"description":"Henkilön kuolleeksi julistus rekisteröity onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"henkilotunnus":{"minLength":11,"description":"Kuolleeksi julistetun henkilön henkilötunnus","type":"string","maxLength":11}},"example":{"henkilotunnus":"010101-999X"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"429":{"description":"Asiakkaan pyyntömäärää on rajoitettu","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Kuolema"]}},"/ping":{"get":{"summary":"Ping","description":"Endpoint yhteyden toimivuuden tarkistamiseen. Palauttaa palvelimen aikaleiman.\n","responses":{"200":{"description":"Pong","content":{"application/json":{"schema":{"type":"object","required":["serverTimestamp"],"properties":{"serverTimestamp":{"format":"date-time","description":"Päivämäärä ja kellonaika ilman aikavyöhyketietoa.","type":"string"}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"429":{"description":"Asiakkaan pyyntömäärää on rajoitettu","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}]}},"/lapsen-tiedot":{"post":{"summary":"Lapsen tietojen ilmoittaminen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"aidinkieli":{"oneOf":[{"description":"Kielikoodi","additionalProperties":false,"type":"object","required":["kielikoodi"],"properties":{"kielikoodi":{"pattern":"^[a-z]{3}$","description":"Kielikoodi","type":"string"}}},{"description":"Kielikoodi ja selkokielinen kielen nimi","additionalProperties":false,"type":"object","required":["kielikoodi","kielenNimi"],"properties":{"kielikoodi":{"description":"Kielikoodi 980 = selkokielinen nimi annettava","type":"string","enum":["980"]},"kielenNimi":{"description":"Kielen selkokielinen nimi, kun kielelle ei ole olemassa kolmemerkkistä ISO 639-2 -kielikoodia.","maximum":30,"type":"string"}}}],"description":"Kielitieto"},"seurakunta":{"allOf":[{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}],"description":"Seurakuntakoodi"},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"kutsumanimi":{"allOf":[{"minLength":1,"description":"Nimi","type":"string","maxLength":100}],"description":"Lapsen kutsumanimi"},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (5 = seurakunnat).","type":"string","enum":["5"]},"sukunimi":{"allOf":[{"minLength":1,"description":"Nimi","type":"string","maxLength":100}],"description":"Lapsen sukunimi"},"etunimet":{"allOf":[{"minLength":1,"description":"Nimi","type":"string","maxLength":100}],"description":"Lapsen etunimet"},"rekisterointipaiva":{"format":"date","description":"Kastepäivä, päivä jolloin lapsi on otettu seurakunnan jäseneksi","type":"string"},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["henkilotunnus","etunimet","sukunimi","aidinkieli","kayttajatunnus","viranomaisnumero","viranomaistyyppi","rekisterointipaiva","seurakunta"],"example":{"aidinkieli":{"kielikoodi":"980","kielenNimi":"Kosovo"},"kayttajatunnus":"abc1234","seurakunta":"123456","henkilotunnus":"020292-904T","kutsumanimi":"Luca","viranomaistyyppi":5,"sukunimi":"Papagalli-Guardiano Tes","etunimet":"Luca Elio Enzo","viranomaisnumero":123,"rekisterointipaiva":"2024-04-12"}}}}},"responses":{"200":{"description":"Lapsen tiedot rekisteröity onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Lapsen tiedot"]}},"/uskontokunta":{"post":{"summary":"Uskontokuntaan rekisteröinti","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"seurakunta":{"allOf":[{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}],"description":"Seurakuntakoodi"},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (5 = seurakunnat).","type":"string","enum":["5"]},"rekisterointipaiva":{"format":"date","description":"Päivä, jolloin henkilö on rekisteröity seurakunnan jäseneksi","type":"string"},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["henkilotunnus","kayttajatunnus","viranomaisnumero","viranomaistyyppi","rekisterointipaiva","seurakunta"],"example":{"kayttajatunnus":"abc1234","seurakunta":123456,"henkilotunnus":"020292-904T","viranomaistyyppi":5,"viranomaisnumero":123,"rekisterointipaiva":"2024-04-12"}}}}},"responses":{"200":{"description":"Uskontokuntaan liittyminen rekisteröity onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Uskontokunta"]}},"/vihkiminen":{"post":{"summary":"Vihkiminen avioliittoon","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"puolisoA":{"description":"Vihittävä henkilötunnuksellinen puoliso.","additionalProperties":false,"type":"object","properties":{"uusiSukunimi":{"minLength":1,"description":"Henkilön sukunimi vihkimisen jälkeen, jos nimi muuttuu.","type":"string","maxLength":100},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"jarjestysnumero":{"description":"Rekisteröitävän liiton järjestysnumero, eli monesko avioliitto tämä on henkilölle.","maximum":99,"type":"number","minimum":1}},"required":["henkilotunnus","jarjestysnumero"]},"puolisoB":{"oneOf":[{"description":"Vihittävä henkilötunnuksellinen puoliso.","additionalProperties":false,"type":"object","properties":{"uusiSukunimi":{"minLength":1,"description":"Henkilön sukunimi vihkimisen jälkeen, jos nimi muuttuu.","type":"string","maxLength":100},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"jarjestysnumero":{"description":"Rekisteröitävän liiton järjestysnumero, eli monesko avioliitto tämä on henkilölle.","maximum":99,"type":"number","minimum":1}},"required":["henkilotunnus","jarjestysnumero"]},{"description":"Vihittävä henkilötunnukseton puoliso.","additionalProperties":false,"type":"object","properties":{"sukupuoli":{"description":"Henkilötunnuksettoman puolison sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"uusiSukunimi":{"minLength":1,"description":"Henkilön sukunimi vihkimisen jälkeen, jos nimi muuttuu.","type":"string","maxLength":100},"jarjestysnumero":{"description":"Rekisteröitävän liiton järjestysnumero, eli monesko avioliitto tämä on henkilölle.","maximum":99,"type":"number","minimum":1},"sukunimi":{"minLength":1,"description":"Henkilötunnuksettoman puolison sukunimi.","type":"string","maxLength":100},"syntymapaiva":{"format":"date","description":"Henkilötunnuksettoman puolison syntymäpäivä.","type":"string"},"siviilisaaty":{"description":"Henkilötunnuksettoman puolison siviilisääty ennen avioliittoa.\n0 = Ei tietoa,\n1 = Naimaton,\n4 = Eronnut,\n5 = Leski,\n7 = Eronnut rekisteröidystä parisuhteesta,\n8 = Leski rekisteröidystä parisuhteesta,\n","type":"string","enum":["0","1","4","5","7","8"]},"etunimet":{"minLength":1,"description":"Henkilötunnuksettoman puolison etunimet.","type":"string","maxLength":100}},"required":["etunimet","sukunimi","sukupuoli","syntymapaiva","siviilisaaty","jarjestysnumero"]}],"description":"Vihittävä henkilötunnuksellinen tai henkilötunnukseton puoliso. Vain toinen vihittävistä puolisoista voi olla henkilötunnukseton.\n"},"vihkipaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Vihkipäivä."},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (4 = oikeuslaitokset, 5 = seurakunnat).","type":"string","enum":["4","5"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["puolisoA","puolisoB","vihkipaiva","kayttajatunnus","viranomaisnumero","viranomaistyyppi"],"example":{"kayttajatunnus":"abc1234","puolisoA":{"henkilotunnus":"020292-904T","jarjestysnumero":1},"puolisoB":{"sukupuoli":"1","uusiSukunimi":"Syvärinen","jarjestysnumero":2,"sukunimi":"Papagalli-Guardiano Tes","syntymapaiva":"1999-06-06","siviilisaaty":"4","etunimet":"Luca Elio Enzo"},"vihkipaiva":"2025-09-05","viranomaistyyppi":5,"viranomaisnumero":123}}}}},"responses":{"200":{"description":"Vihkiminen rekisteröity onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Vihkiminen"]}},"/huolto/paivitys":{"patch":{"summary":"Lapsen huollon päivitys","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (S = sosiaalilautakunta, 4 = oikeuslaitokset, T = hyvinvointialueet).","type":"string","enum":["4","S","T"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["kayttajatunnus","viranomaisnumero","viranomaistyyppi"]}],"type":"object","properties":{"huollettavanHenkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huollettavan henkilötunnus."},"lisattavatHuollot":{"description":"Lisättävät huoltosuhteet. Lisättävä huoltaja ei saa entuudestaan olla lapsen huoltaja tai aikaisempi huoltosuhde on päätettävä samalla päivämäärällä (ks. `paatettavatHuollot`).\nHuoltosuhteen ja muiden lisättävien tietojen loppupäiväksi asetetaan huollettavan 18-vuotispäivä.\n","type":"array","items":{"type":"object","required":["huoltaja","alkupaiva","huoltajanRooli","huoltajanLaji"],"properties":{"huoltajanLaji":{"description":"Huoltajan laji (2 = määrätty huoltaja, 3 = tiedonsaantioikeutettu).","type":"string","enum":["2","3"]},"huoltajanRooli":{"description":"Huoltajan rooli. Yksi seuraavista:\n* 1: Isä\n* 2: Äiti\n* 3: Adoptioisä\n* 4: Adoptioäiti\n* 6: Vahvistettu äiti\n* `null`: Oheishuoltaja\n","type":["string","null"],"enum":["1","2","3","4","6",null]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Huoltosuhteen alkupäivä. Käytetään myös mahdollisesti lisättävien oikeuksien alkupäivänä."},"huoltaja":{"oneOf":[{"type":"object","title":"Henkilötunnuksellinen huoltaja","required":["henkilotunnus"],"properties":{"henkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huoltajan henkilötunnus."}}},{"additionalProperties":false,"type":"object","title":"Henkilötunnukseton huoltaja","required":["etunimet","sukunimi","sukupuoli","syntymapaiva"],"properties":{"sukupuoli":{"description":"Henkilötunnuksettoman huoltajan sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"sukunimi":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan sukunimi.","type":"string","maxLength":100},"syntymapaiva":{"format":"date","description":"Henkilötunnuksettoman huoltajan syntymäpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan etunimet.","type":"string","maxLength":100}}}],"description":"Huoltajan tiedot. Huoltaja voi olla joko henkilötunnuksellinen tai henkilötunnukseton henkilö."},"sisaltotekstiKaytossa":{"description":"Liitetäänkö annettu sisältöteksti (`huollonSisalto`-kenttä) tähän huoltosuhteeseen.","type":"boolean"},"asuminen":{"description":"Huollon asumisen tiedot.","type":"object","required":["tyyppi","alkupaiva"],"properties":{"virallinenAsuinpaikka":{"description":"Lapsen virallisen asuinpaikan on sovittu tai määrätty olevan tämän henkilön luona.\nArvon on oltava `true` täsmälleen yhdelle huoltajalle, jos kyseessä on vuoroasuminen (asumisen tyypit 4-7).\nMuille vuoroasumisen huoltajille ja muuntyyppisten asumisten (asumisen tyypit 1-3 ja 8) yhteydessä käytetään arvoa `false` tai jätetään kenttä asettamatta.\n","type":"boolean"},"tyyppi":{"description":"Asumisen tyyppi. Yksi seuraavista:\n* 1: Vanhempien luona. Tätä koodia tulee käyttää vain, jos asiasta on oikeuden päätös.\nOletuksena lapsi asuu vanhempien luona, eikä tätä tarvitse ilmoittaa erikseen.\n* 2: Äidin luona\n* 3: Isän luona\n* 4: Vuoroasuminen\n* 5: Vuoroasuminen äidin ja oheishuoltajan luona\n* 6: Vuoroasuminen isän ja oheishuoltajan luona\n* 7: Vuoroasuminen vanhempien ja oheishuoltajan luona\n* 8: Oheishuoltajan/oheishuoltajien luona\n","type":"string","enum":["1","2","3","4","5","6","7","8"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Asumisen alkupäivä. Tyypillisesti sama kuin huoltopäätöksen alkupäivämäärä, mutta asuminen voidaan asettaa alkamaan myös myöhemmin."}}},"oikeudet":{"description":"Huollon oikeudet. Pakollinen tieto tiedonsaantioikeutetulle.","type":"array","items":{"type":"object","required":["koodi"],"properties":{"koodi":{"description":"Oikeuden koodi. Yksi seuraavista (P = päätösoikeus, T = tiedonsaantioikeus):\n* P100: Nimet\n* P101: Etunimet\n* P102: Sukunimi\n* P200: Passi ja muut matkustusasiakirjat\n* P300: Kaikki sosiaali- ja terveyspalvelut\n* P301: Kaikki sosiaalipalvelut\n* P302: Kaikki terveyspalvelut\n* P400: Asuinpaikka\n* P401: Asuinpaikka Suomessa\n* P402: Asuinpaikan muutto ulkomaille\n* P500: Varhaiskasvatus, opetus ja koulutus\n* P501: Varhaiskasvatus\n* P502: Opetus ja koulutus\n* P700: Muut asiat\n* P701: Uskonnollisen yhdyskunnan jäsenyys\n* P702: Kansalaisuus\n* P703: Äidinkieli\n* T000: Kaikki lasta koskevat tiedot\n* T100: Kaikki sosiaali- ja terveyspalvelut\n* T101: Kaikki sosiaalipalvelut\n* T102: Kaikki terveyspalvelut\n* T200: Varhaiskasvatus, opetus ja koulutus\n* T201: Varhaiskasvatus\n* T202: Opetus ja koulutus\n\nPäätösoikeuksia voi antaa ainoastaan määrätyille huoltajille (huoltajan laji 2) ja tiedonsaantioikeuksia ainoastaan tiedonsaantioikeutetulle (huoltajan laji 3).\n","type":"string","enum":["P100","P101","P102","P200","P300","P301","P302","P400","P401","P402","P500","P501","P502","P700","P701","P702","P703","T000","T100","T101","T102","T200","T201","T202"]}}}}}}},"paatettavatHuollot":{"description":"Päätettävät huoltosuhteet.","type":"array","items":{"type":"object","required":["huoltaja","loppupaiva"],"properties":{"loppupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Huoltosuhteen loppupäivä. Huoltosuhteeseen mahdollisesti liittyvät asumisen tiedot ja oikeudet päätetään automaattisesti samalla loppupäivällä."},"huoltaja":{"oneOf":[{"type":"object","title":"Henkilötunnuksellinen huoltaja","required":["henkilotunnus"],"properties":{"henkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huoltajan henkilötunnus."}}},{"additionalProperties":false,"type":"object","title":"Henkilötunnukseton huoltaja","required":["etunimet","sukunimi","sukupuoli","syntymapaiva"],"properties":{"sukupuoli":{"description":"Henkilötunnuksettoman huoltajan sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"sukunimi":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan sukunimi.","type":"string","maxLength":100},"syntymapaiva":{"format":"date","description":"Henkilötunnuksettoman huoltajan syntymäpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan etunimet.","type":"string","maxLength":100}}}],"description":"Huoltajan tiedot. Huoltaja voi olla joko henkilötunnuksellinen tai henkilötunnukseton henkilö."}}}},"huollonSisalto":{"description":"Huollon vapaamuotoisen sisällön tiedot. Voidaan käyttää, jos huollon oikeuksien käyttäminen ei ole mahdollista tai tarkoituksenmukaista.\nHuomaa, että huollon sisällön käyttäminen estää sähköisen puolesta-asioinnin. Suositeltu tapa on käyttää kooditettuja päätösoikeuksia (`oikeudet`-kenttä).\nHuollon sisältö tulee käyttöön määräyksenvaraisille huoltajille (lisätyt ja päivitettävät), joille on kutsussa asetettu `sisaltotekstiKaytossa: true`.\nJos sisältö annetaan, kooditettujen päätösoikeuksen antaminen ei ole sallittua. Jos huoltajilla on entuudestaan kooditettuja päätösoikeuksia, ne tulee päättää samalla pyynnöllä.\nJos huollolla on entuudestaan tekstimuotoinen sisältö käytössä, se korvataan annetulla sisällöllä.\n","type":"object","required":["teksti","alkupaiva"],"properties":{"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Lisättävän tiedon alkupäivä."},"teksti":{"minLength":1,"description":"Huollon sisällön vapaamuotoinen kuvaus. Tekstissä sallittujen merkkien joukko on rajoitettu ISO Latin 1 -merkistöön.\nTekstissä ei saa esiintyä henkilötunnuksia, verkko-osoitteita tai HTML-koodia.\n","type":"string","maxLength":4000}}},"paivitettavatHuollot":{"description":"Asumisten ja oikeuksien muutokset olemassaoleville huolloille.","type":"array","items":{"type":"object","required":["huoltaja"],"properties":{"oikeuksienMuutokset":{"type":"array","items":{"oneOf":[{"description":"Lisättävä huollon oikeus. Oikeuden loppupäiväksi asetetaan huollettavan 18-vuotispäivä.","type":"object","required":["koodi","alkupaiva"],"properties":{"koodi":{"description":"Oikeuden koodi. Yksi seuraavista (P = päätösoikeus, T = tiedonsaantioikeus):\n* P100: Nimet\n* P101: Etunimet\n* P102: Sukunimi\n* P200: Passi ja muut matkustusasiakirjat\n* P300: Kaikki sosiaali- ja terveyspalvelut\n* P301: Kaikki sosiaalipalvelut\n* P302: Kaikki terveyspalvelut\n* P400: Asuinpaikka\n* P401: Asuinpaikka Suomessa\n* P402: Asuinpaikan muutto ulkomaille\n* P500: Varhaiskasvatus, opetus ja koulutus\n* P501: Varhaiskasvatus\n* P502: Opetus ja koulutus\n* P700: Muut asiat\n* P701: Uskonnollisen yhdyskunnan jäsenyys\n* P702: Kansalaisuus\n* P703: Äidinkieli\n* T000: Kaikki lasta koskevat tiedot\n* T100: Kaikki sosiaali- ja terveyspalvelut\n* T101: Kaikki sosiaalipalvelut\n* T102: Kaikki terveyspalvelut\n* T200: Varhaiskasvatus, opetus ja koulutus\n* T201: Varhaiskasvatus\n* T202: Opetus ja koulutus\n\nPäätösoikeuksia voi antaa ainoastaan määrätyille huoltajille (huoltajan laji 2) ja tiedonsaantioikeuksia ainoastaan tiedonsaantioikeutetulle (huoltajan laji 3).\n","type":"string","enum":["P100","P101","P102","P200","P300","P301","P302","P400","P401","P402","P500","P501","P502","P700","P701","P702","P703","T000","T100","T101","T102","T200","T201","T202"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Lisättävän tiedon alkupäivä."}}},{"description":"Päätettävä huollon oikeus.","type":"object","required":["koodi","loppupaiva"],"properties":{"loppupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Päätettävän tiedon loppupäivä."},"koodi":{"description":"Oikeuden koodi. Yksi seuraavista (P = päätösoikeus, T = tiedonsaantioikeus):\n* P100: Nimet\n* P101: Etunimet\n* P102: Sukunimi\n* P200: Passi ja muut matkustusasiakirjat\n* P300: Kaikki sosiaali- ja terveyspalvelut\n* P301: Kaikki sosiaalipalvelut\n* P302: Kaikki terveyspalvelut\n* P400: Asuinpaikka\n* P401: Asuinpaikka Suomessa\n* P402: Asuinpaikan muutto ulkomaille\n* P500: Varhaiskasvatus, opetus ja koulutus\n* P501: Varhaiskasvatus\n* P502: Opetus ja koulutus\n* P700: Muut asiat\n* P701: Uskonnollisen yhdyskunnan jäsenyys\n* P702: Kansalaisuus\n* P703: Äidinkieli\n* T000: Kaikki lasta koskevat tiedot\n* T100: Kaikki sosiaali- ja terveyspalvelut\n* T101: Kaikki sosiaalipalvelut\n* T102: Kaikki terveyspalvelut\n* T200: Varhaiskasvatus, opetus ja koulutus\n* T201: Varhaiskasvatus\n* T202: Opetus ja koulutus\n\nPäätösoikeuksia voi antaa ainoastaan määrätyille huoltajille (huoltajan laji 2) ja tiedonsaantioikeuksia ainoastaan tiedonsaantioikeutetulle (huoltajan laji 3).\n","type":"string","enum":["P100","P101","P102","P200","P300","P301","P302","P400","P401","P402","P500","P501","P502","P700","P701","P702","P703","T000","T100","T101","T102","T200","T201","T202"]}}}]}},"asumisenMuutokset":{"type":"array","items":{"oneOf":[{"description":"Lisättävän huollon asumisen tiedot. Asumisen loppupäiväksi asetetaan huollettavan 18-vuotispäivä.\nHuollolle voi lisätä vain yhden asumisen. Jos asumisen tyyppi muuttuu, voimassaoleva asuminen on päätettävä samalla päivämäärällä.\n","type":"object","required":["tyyppi","alkupaiva"],"properties":{"virallinenAsuinpaikka":{"description":"Lapsen virallisen asuinpaikan on sovittu tai määrätty olevan tämän henkilön luona.\nArvon on oltava `true` täsmälleen yhdelle huoltajalle, jos kyseessä on vuoroasuminen (asumisen tyypit 4-7).\nMuille vuoroasumisen huoltajille ja muuntyyppisten asumisten (asumisen tyypit 1-3 ja 8) yhteydessä käytetään arvoa `false` tai jätetään kenttä asettamatta.\n","type":"boolean"},"tyyppi":{"description":"Asumisen tyyppi. Yksi seuraavista:\n* 1: Vanhempien luona. Tätä koodia tulee käyttää vain, jos asiasta on oikeuden päätös.\nOletuksena lapsi asuu vanhempien luona, eikä tätä tarvitse ilmoittaa erikseen.\n* 2: Äidin luona\n* 3: Isän luona\n* 4: Vuoroasuminen\n* 5: Vuoroasuminen äidin ja oheishuoltajan luona\n* 6: Vuoroasuminen isän ja oheishuoltajan luona\n* 7: Vuoroasuminen vanhempien ja oheishuoltajan luona\n* 8: Oheishuoltajan/oheishuoltajien luona\n","type":"string","enum":["1","2","3","4","5","6","7","8"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Lisättävän tiedon alkupäivä."}}},{"description":"Huollon asumisen päättäminen.\n","type":"object","required":["loppupaiva"],"properties":{"loppupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Päätettävän tiedon loppupäivä."}}},{"description":"Päivitä vuoroasumisen virallinen asuinpaikka.\n","type":"object","required":["muutospaiva","virallinenAsuinpaikka"],"properties":{"muutospaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Virallisen asuinpaikan muutospäivä."},"virallinenAsuinpaikka":{"description":"Lapsen virallisen asuinpaikan on sovittu tai määrätty olevan tämän henkilön luona.\nArvon on oltava `true` täsmälleen yhdelle huoltajalle, jos kyseessä on vuoroasuminen (asumisen tyypit 4-7).\nMuille vuoroasumisen huoltajille ja muuntyyppisten asumisten (asumisen tyypit 1-3 ja 8) yhteydessä käytetään arvoa `false` tai jätetään kenttä asettamatta.\n","type":"boolean"}}}]}},"huoltaja":{"oneOf":[{"type":"object","title":"Henkilötunnuksellinen huoltaja","required":["henkilotunnus"],"properties":{"henkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huoltajan henkilötunnus."}}},{"additionalProperties":false,"type":"object","title":"Henkilötunnukseton huoltaja","required":["etunimet","sukunimi","sukupuoli","syntymapaiva"],"properties":{"sukupuoli":{"description":"Henkilötunnuksettoman huoltajan sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"sukunimi":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan sukunimi.","type":"string","maxLength":100},"syntymapaiva":{"format":"date","description":"Henkilötunnuksettoman huoltajan syntymäpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan etunimet.","type":"string","maxLength":100}}}],"description":"Huoltajan tiedot. Huoltaja voi olla joko henkilötunnuksellinen tai henkilötunnukseton henkilö."},"sisaltotekstiKaytossa":{"description":"Arvolla `true` uusi sisältöteksti (`huollonSisalto`-kenttä) liitetään tähän huoltosuhteeseen. Olemassaolevaa sisältötekstiä ei voi ottaa käyttöön takautuvasti.\nArvolla `false` olemassaoleva sisältöteksti otetaan pois käytöstä tältä huoltosuhteelta.\nJos pyynnössä on annettu uusi sisältöteksti, se on otettava käyttöön kaikilla huoltosuhteilla, joilla on entuudestaan sisältöteksti käytössä, tai näiltä huoltosuhteilta\non otettava sisältöteksti pois käytöstä.\n","type":"boolean"}}}}},"required":["huollettavanHenkilotunnus"]},"examples":{"huollonPaattaminen":{"summary":"Päätetään huoltosuhde","description":"Huoltosuhde ulkohenkilöhuoltajaan päätetään","value":{"huollettavanHenkilotunnus":"030323A901B","paatettavatHuollot":[{"loppupaiva":"2025-08-04","huoltaja":{"sukupuoli":"1","sukunimi":"Papagalli-Guardiano Tes","syntymapaiva":"1999-06-06","etunimet":"Luca Elio Enzo"}}],"kayttajatunnus":"abc1234","viranomaistyyppi":"S","viranomaisnumero":123}},"virallinenAsuinpaikka":{"summary":"Päivitetään virallinen asuinpaikka","description":"Päivitetään vuoroasumisen virallinen asuinpaikka toisen vanhemman luo","value":{"huollettavanHenkilotunnus":"010125A9994","kayttajatunnus":"abc1234","viranomaistyyppi":"S","viranomaisnumero":123,"paivitettavatHuollot":[{"asumisenMuutokset":[{"muutospaiva":"2025-06-01","virallinenAsuinpaikka":false}],"huoltaja":{"henkilotunnus":"151289-900B"}},{"asumisenMuutokset":[{"muutospaiva":"2025-06-01","virallinenAsuinpaikka":true}],"huoltaja":{"henkilotunnus":"111190-907E"}}]}},"oikeuksienPaivitys":{"summary":"Oikeuksien päivittäminen","description":"Huoltajalta päätetään kaksi päätösoikeutta ja lisätään yksi uusi","value":{"huollettavanHenkilotunnus":"010125A9994","kayttajatunnus":"abc1234","viranomaistyyppi":"S","viranomaisnumero":123,"paivitettavatHuollot":[{"oikeuksienMuutokset":[{"loppupaiva":"2025-05-01","koodi":"P501"},{"loppupaiva":"2025-05-01","koodi":"P703"},{"koodi":"P500","alkupaiva":"2025-05-01"}],"huoltaja":{"henkilotunnus":"151289-900B"}}]}},"asumisenLisaaminen":{"summary":"Lisätään vuoroasuminen","description":"Lisätään vuoroasuminen, kun asumista ei ole entuudestaan","value":{"huollettavanHenkilotunnus":"010125A9994","kayttajatunnus":"abc1234","viranomaistyyppi":"S","viranomaisnumero":123,"paivitettavatHuollot":[{"asumisenMuutokset":[{"virallinenAsuinpaikka":true,"tyyppi":"4","alkupaiva":"2025-05-01"}],"huoltaja":{"henkilotunnus":"151289-900B"}},{"asumisenMuutokset":[{"tyyppi":"4","alkupaiva":"2025-05-01"}],"huoltaja":{"henkilotunnus":"111190-907E"}}]}},"uusiSisalto":{"summary":"Lisätään huollon sisältö","description":"Otetaan uusi sisältöteksti käyttöön lisättävälle oheishuoltajalle sekä olemassaoleville huoltajille.","value":{"huollettavanHenkilotunnus":"010125A9994","lisattavatHuollot":[{"huoltajanLaji":"2","huoltajanRooli":null,"alkupaiva":"2025-06-01","huoltaja":{"henkilotunnus":"070702A901R"},"sisaltotekstiKaytossa":true}],"kayttajatunnus":"abc1234","viranomaistyyppi":"S","huollonSisalto":{"alkupaiva":"2025-06-01","teksti":"Lapsen äidilla on oikeus hoitaa lapsen raha-asioita. Lapsen isä on lapsen täysivaltainen huoltaja."},"viranomaisnumero":123,"paivitettavatHuollot":[{"huoltaja":{"henkilotunnus":"151289-900B"},"sisaltotekstiKaytossa":true},{"huoltaja":{"henkilotunnus":"111190-907E"},"sisaltotekstiKaytossa":true}]}},"paataSisalto":{"summary":"Poistetaan huollon sisältö käytöstä","description":"Otetaan sisältöteksti pois käytöstä. Lisäksi toiselle huoltajalle tulee käyttöön päätösoikeuksia.","value":{"huollettavanHenkilotunnus":"010125A9994","kayttajatunnus":"abc1234","viranomaistyyppi":"S","viranomaisnumero":123,"paivitettavatHuollot":[{"huoltaja":{"henkilotunnus":"151289-900B"},"sisaltotekstiKaytossa":false},{"oikeuksienMuutokset":[{"koodi":"P100","alkupaiva":"2025-05-01"},{"koodi":"P500","alkupaiva":"2025-05-01"}],"huoltaja":{"henkilotunnus":"111190-907E"},"sisaltotekstiKaytossa":false}]}},"huoltajanLisaaminen":{"summary":"Tiedonsaantioikeutetun huoltajan lisääminen","description":"Lisätään tiedonsaantioikeutettu joka ei entuudestaan ole lapsen huoltaja","value":{"huollettavanHenkilotunnus":"030425A901N","lisattavatHuollot":[{"huoltajanLaji":"3","huoltajanRooli":"1","alkupaiva":"2025-08-01","huoltaja":{"henkilotunnus":"070702A901R"},"oikeudet":[{"koodi":"T102"},{"koodi":"T201"}]}],"kayttajatunnus":"abc1234","viranomaistyyppi":"S","viranomaisnumero":123}}}}}},"description":"Päivittää lapsen huollon tietoja. Tällä metodilla voi lisätä ja päättää huoltoja sekä lisätä tai päättää olemassaolevan huollon asumistietoja tai oikeuksia.\n","responses":{"200":{"description":"Huolto tallennettu onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"429":{"description":"Asiakkaan pyyntömäärää on rajoitettu","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Huolto"]}},"/satu/aktivoi":{"post":{"summary":"Satun aktivointi","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (4).","type":"string","enum":["4"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["henkilotunnus","kayttajatunnus","viranomaisnumero","viranomaistyyppi"],"example":{"henkilotunnus":"020292-904T","viranomaistyyppi":4,"viranomaisnumero":123}}}}},"responses":{"200":{"description":"Asiointitunnus aktivoitu onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"asiointitunnus":{"minLength":9,"description":"Aktivoitu asiointitunnus","type":"string","maxLength":9}},"example":{"asiointitunnus":"12345"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Satu"]}},"/syntyma":{"post":{"summary":"Lapsen syntymän rekisteröinti","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sukupuoli":{"description":"Lapsen sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"syntymapaiva":{"format":"date","description":"Lapsen syntymäpäivä.","type":"string"},"jarjestyskirjain":{"description":"Synnyttäjän monikkoraskauden lasten erottelu järjestyskirjaimella. Sallitut arvot A \u2013 H:\n\n- A: ensimmäinen lapsi. Jos raskaudesta syntyy vain yksi lapsi, käytetään järjestyskirjainta A.\n\n- B: toinen samasta raskaudesta syntyvä lapsi\n\n- C: kolmas samasta raskaudesta syntyvä lapsi\n\n- ...\n\n- H: kahdeksas samasta raskaudesta syntyvä lapsi\n","type":"string","enum":["A","B","C","D","E","F","G","H"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1},"synnyttajanHenkilotunnus":{"minLength":11,"description":"Synnyttävän vanhemman henkilötunnus.","type":"string","maxLength":11}},"required":["synnyttajanHenkilotunnus","syntymapaiva","sukupuoli","jarjestyskirjain","kayttajatunnus","viranomaisnumero"],"example":{"sukupuoli":"2","kayttajatunnus":"abc1234","syntymapaiva":"2024-04-12","jarjestyskirjain":"A","viranomaisnumero":123,"synnyttajanHenkilotunnus":"010101-999X"}}}}},"responses":{"200":{"description":"Lapsen syntymä rekisteröity onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"lapsenHenkilotunnus":{"minLength":11,"description":"DVV:n syntyneelle lapselle antama henkilötunnus.","type":"string","maxLength":11}},"example":{"lapsenHenkilotunnus":"120424A999X"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Syntymä"]}},"/edunvalvonta":{"patch":{"summary":"Edunvalvonnan päivittäminen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["paahenkilo","viranomaistyyppi","kayttajatunnus"],"properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"paahenkilo":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"viranomaistyyppi":{"description":"1 = Rekisteriviranomainen","type":"string","enum":["1"]},"paivitettavatEdunvalvojat":{"type":"array","items":{"description":"Edunvalvoja","additionalProperties":false,"type":"object","required":["edunvalvoja","loppupaiva"],"properties":{"loppupaiva":{"nullable":true,"format":"date","description":"Päivämäärä.","type":"string"},"edunvalvoja":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi"],"properties":{"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}},{"description":"Viranomaisnumerollinen","additionalProperties":false,"type":"object","required":["viranomaisnumero"],"properties":{"viranomaisnumero":{"type":"number"}}},{"description":"Y-tunnuksellinen","additionalProperties":false,"type":"object","required":["ytunnus"],"properties":{"ytunnus":{"type":"string"}}}]}}}},"edunvalvonnanPaivitys":{"description":"Edunvalvonnan lisätiedot","additionalProperties":false,"type":"object","required":["alkupaiva","jako","rajoitus"],"properties":{"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"jako":{"type":"boolean"},"rajoitus":{"description":"EI_RAJOITETTU = Ei rajoitettu, OSITTAIN_RAJOITETTU = Osittain rajoitettu, JULISTETTU_VAJAAVALTAISEKSI = Julistettu vajaavaltaiseksi","type":"string","enum":["EI_RAJOITETTU","OSITTAIN_RAJOITETTU","JULISTETTU_VAJAAVALTAISEKSI"]}}},"viranomaisnumero":{"description":"777 (DVV) tai 718 (Ahvenanmaa)","type":"number","enum":[777,718]},"lisattavatEdunvalvojat":{"type":"array","items":{"description":"Edunvalvoja","additionalProperties":false,"type":"object","required":["edunvalvoja","alkupaiva"],"properties":{"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"edunvalvoja":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi"],"properties":{"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}},{"description":"Viranomaisnumerollinen","additionalProperties":false,"type":"object","required":["viranomaisnumero"],"properties":{"viranomaisnumero":{"type":"number"}}},{"description":"Y-tunnuksellinen","additionalProperties":false,"type":"object","required":["ytunnus"],"properties":{"ytunnus":{"type":"string"}}}]},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"}}}}}}}}},"responses":{"200":{"description":"Edunvalvonta päivitetty onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Edunvalvonta"]},"post":{"summary":"Edunvalvonnan luominen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["paahenkilo","viranomaisnumero","viranomaistyyppi","kayttajatunnus","edunvalvojat","rajoitus","alkupaiva"],"properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"paahenkilo":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"edunvalvojat":{"type":"array","items":{"description":"Edunvalvoja","additionalProperties":false,"type":"object","required":["edunvalvoja","alkupaiva"],"properties":{"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"edunvalvoja":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi"],"properties":{"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}},{"description":"Viranomaisnumerollinen","additionalProperties":false,"type":"object","required":["viranomaisnumero"],"properties":{"viranomaisnumero":{"type":"number"}}},{"description":"Y-tunnuksellinen","additionalProperties":false,"type":"object","required":["ytunnus"],"properties":{"ytunnus":{"type":"string"}}}]},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"}}}},"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"viranomaistyyppi":{"description":"1 = Rekisteriviranomainen","type":"string","enum":["1"]},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"jako":{"type":"boolean"},"viranomaisnumero":{"description":"777 (DVV) tai 718 (Ahvenanmaa)","type":"number","enum":[777,718]},"rajoitus":{"description":"EI_RAJOITETTU = Ei rajoitettu, OSITTAIN_RAJOITETTU = Osittain rajoitettu, JULISTETTU_VAJAAVALTAISEKSI = Julistettu vajaavaltaiseksi","type":"string","enum":["EI_RAJOITETTU","OSITTAIN_RAJOITETTU","JULISTETTU_VAJAAVALTAISEKSI"]}}}}}},"responses":{"200":{"description":"Edunvalvonta päivitetty onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Edunvalvonta"]}},"/ero/rekpa":{"post":{"summary":"Rekpa-eron ilmoittaminen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["puolisoA","puolisoB","paatospaiva","ratkaisu","viranomaisnumero","viranomaistyyppi","kayttajatunnus"],"properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"puolisoA":{"description":"Avioeron vireillepanija","properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},"puolisoB":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö (lisäkenttänä sukupuoli)","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi","sukupuoli"],"properties":{"sukupuoli":{"description":"Henkilön sukupuoli","type":"string","enum":["1","2"]},"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}}],"description":"Avioeron toinen osapuoli."},"ratkaisu":{"description":"Ratkaisun tyyppi.","type":"string","enum":["ERO","MITATOITY","KUMOTTU"]},"viranomaistyyppi":{"type":"string","enum":["4"]},"paatospaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}}},"examples":{"ero":{"summary":"Avioeron ilmoittaminen","value":{"kayttajatunnus":"kayttajatunnus","puolisoA":{"henkilotunnus":"091001A9359"},"puolisoB":{"henkilotunnus":"240297-950S"},"ratkaisu":"ERO","viranomaistyyppi":"4","paatospaiva":"2024-09-10","viranomaisnumero":999999}}}}}},"description":"Rajapinta rekpa-eron ilmoittamiseen.\n","responses":{"200":{"description":"Ero ilmoitettu onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"501":{"description":"Toiminnallisuutta ei ole vielä toteutettu"},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Erot"]}},"/nimenmuutos/haku":{"post":{"summary":"Nimen yleisyyden haku","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"nimilaji":{"minLength":2,"description":"Nimilaji enumin arvo","type":"string","maxLength":2},"nimi":{"description":"Nimi, jota tilastosta haetaan.","type":"string"},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (1).","type":"string","enum":["1"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["kayttajatunnus","viranomaisnumero","viranomaistyyppi","nimi","nimilaji"],"example":{"nimilaji":"01","nimi":"Jantunen","viranomaistyyppi":4,"viranomaisnumero":123}}}}},"responses":{"200":{"description":"Nimien määrä","content":{"application/json":{"schema":{"type":"object","properties":{"kuolleilla":{"description":"Löydettyjen nimien määrä kuolleilla ihmisillä","type":"number"},"yhteensa":{"description":"Löydettyjen nimien määrä yhteenä","type":"number"},"elavilla":{"description":"Löydettyjen nimien määrä elävillä ihmisillä","type":"number"}},"example":{"kuolleilla":50,"yhteensa":150,"elavilla":100}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Nimenmuutos"]}},"/huolto/ilmoitus":{"put":{"summary":"Lapsen huollon ilmoitus","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (S = sosiaalilautakunta, 4 = oikeuslaitokset, T = hyvinvointialueet).","type":"string","enum":["4","S","T"]},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["kayttajatunnus","viranomaisnumero","viranomaistyyppi"]}],"type":"object","properties":{"huollettavanHenkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huollettavan henkilötunnus."},"paatettavatHuollot":{"description":"Lista huoltajista, jotka eivät enää ole lapsen huoltajia ilmoituksen myötä. Nämä huollot asetetaan päättymään huoltopäätöksen päivämäärällä.\nTätä tietoa käytetään varmistuksena, että kaikki olemassa olevat huoltosuhteet joko päätetään tai päivitetään huoltoilmoituksella.\n","type":"array","items":{"oneOf":[{"type":"object","title":"Henkilötunnuksellinen huoltaja","required":["henkilotunnus"],"properties":{"henkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huoltajan henkilötunnus."}}},{"additionalProperties":false,"type":"object","title":"Henkilötunnukseton huoltaja","required":["etunimet","sukunimi","sukupuoli","syntymapaiva"],"properties":{"sukupuoli":{"description":"Henkilötunnuksettoman huoltajan sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"sukunimi":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan sukunimi.","type":"string","maxLength":100},"syntymapaiva":{"format":"date","description":"Henkilötunnuksettoman huoltajan syntymäpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan etunimet.","type":"string","maxLength":100}}}],"description":"Huoltajan tiedot. Huoltaja voi olla joko henkilötunnuksellinen tai henkilötunnukseton henkilö."}},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Huoltopäätöksen alkupäivämäärä. Kaikki ilmoitettavat tiedot ovat voimassa päätöksen päivämäärästä alkaen huollettavan 18-vuotispäivään saakka.\nHuollon asumisen osalta voi ilmoittaa päätöspäivää myöhemmän päivämäärän.\n"},"huollonSisalto":{"description":"Huollon vapaamuotoisen sisällön tiedot. Voidaan käyttää, jos huollon oikeuksien käyttäminen ei ole mahdollista tai tarkoituksenmukaista.\nHuomaa, että huollon sisällön käyttäminen estää sähköisen puolesta-asioinnin. Suositeltu tapa on käyttää kooditettuja päätösoikeuksia (`oikeudet`-kenttä).\nHuollon sisältö tulee käyttöön määrätyille huoltajille, joille on kutsussa asetettu `sisaltotekstiKaytossa: true`.\nJos sisältö annetaan, kooditettujen päätösoikeuksen antaminen ei ole sallittua.\n","type":"object","required":["teksti"],"properties":{"teksti":{"minLength":1,"description":"Huollon sisällön vapaamuotoinen kuvaus. Tekstissä sallittujen merkkien joukko on rajoitettu ISO Latin 1 -merkistöön.\nTekstissä ei saa esiintyä henkilötunnuksia, verkko-osoitteita tai HTML-koodia.\n","type":"string","maxLength":4000}}},"huollot":{"minItems":1,"description":"Kaikki huoltosuhteet, jotka tulevat voimaan huoltopäätöksellä.\n","type":"array","items":{"type":"object","required":["huoltaja","huoltajanRooli","huoltajanLaji"],"properties":{"huoltajanLaji":{"description":"Huoltajan laji (2 = määrätty huoltaja, 3 = tiedonsaantioikeutettu).","type":"string","enum":["2","3"]},"huoltajanRooli":{"description":"Huoltajan rooli. Yksi seuraavista:\n* 1: Isä\n* 2: Äiti\n* 3: Adoptioisä\n* 4: Adoptioäiti\n* 6: Vahvistettu äiti\n* `null`: Oheishuoltaja\n","type":["string","null"],"enum":["1","2","3","4","6",null]},"huoltaja":{"oneOf":[{"type":"object","title":"Henkilötunnuksellinen huoltaja","required":["henkilotunnus"],"properties":{"henkilotunnus":{"allOf":[{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}],"description":"Huoltajan henkilötunnus."}}},{"additionalProperties":false,"type":"object","title":"Henkilötunnukseton huoltaja","required":["etunimet","sukunimi","sukupuoli","syntymapaiva"],"properties":{"sukupuoli":{"description":"Henkilötunnuksettoman huoltajan sukupuoli (1 = mies, 2 = nainen).","type":"string","enum":["1","2"]},"sukunimi":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan sukunimi.","type":"string","maxLength":100},"syntymapaiva":{"format":"date","description":"Henkilötunnuksettoman huoltajan syntymäpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Henkilötunnuksettoman huoltajan etunimet.","type":"string","maxLength":100}}}],"description":"Huoltajan tiedot. Huoltaja voi olla joko henkilötunnuksellinen tai henkilötunnukseton henkilö."},"sisaltotekstiKaytossa":{"description":"Liitetäänkö annettu sisältöteksti (`huollonSisalto`-kenttä) tähän huoltosuhteeseen","type":"boolean"},"asuminen":{"description":"Huollon asumisen tiedot.","type":"object","required":["tyyppi","alkupaiva"],"properties":{"virallinenAsuinpaikka":{"description":"Lapsen virallisen asuinpaikan on sovittu tai määrätty olevan tämän henkilön luona.\nArvon on oltava `true` täsmälleen yhdelle huoltajalle, jos kyseessä on vuoroasuminen (asumisen tyypit 4-7).\nMuille vuoroasumisen huoltajille ja muuntyyppisten asumisten (asumisen tyypit 1-3 ja 8) yhteydessä käytetään arvoa `false` tai jätetään kenttä asettamatta.\n","type":"boolean"},"tyyppi":{"description":"Asumisen tyyppi. Yksi seuraavista:\n* 1: Vanhempien luona. Tätä koodia tulee käyttää vain, jos asiasta on oikeuden päätös.\nOletuksena lapsi asuu vanhempien luona, eikä tätä tarvitse ilmoittaa erikseen.\n* 2: Äidin luona\n* 3: Isän luona\n* 4: Vuoroasuminen\n* 5: Vuoroasuminen äidin ja oheishuoltajan luona\n* 6: Vuoroasuminen isän ja oheishuoltajan luona\n* 7: Vuoroasuminen vanhempien ja oheishuoltajan luona\n* 8: Oheishuoltajan/oheishuoltajien luona\n","type":"string","enum":["1","2","3","4","5","6","7","8"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Asumisen alkupäivä. Tyypillisesti sama kuin huoltopäätöksen alkupäivämäärä, mutta asuminen voidaan asettaa alkamaan myös myöhemmin."}}},"oikeudet":{"description":"Huollon oikeudet. Pakollinen tieto tiedonsaantioikeutetulle.","type":"array","items":{"type":"object","required":["koodi"],"properties":{"koodi":{"description":"Oikeuden koodi. Yksi seuraavista (P = päätösoikeus, T = tiedonsaantioikeus):\n* P100: Nimet\n* P101: Etunimet\n* P102: Sukunimi\n* P200: Passi ja muut matkustusasiakirjat\n* P300: Kaikki sosiaali- ja terveyspalvelut\n* P301: Kaikki sosiaalipalvelut\n* P302: Kaikki terveyspalvelut\n* P400: Asuinpaikka\n* P401: Asuinpaikka Suomessa\n* P402: Asuinpaikan muutto ulkomaille\n* P500: Varhaiskasvatus, opetus ja koulutus\n* P501: Varhaiskasvatus\n* P502: Opetus ja koulutus\n* P700: Muut asiat\n* P701: Uskonnollisen yhdyskunnan jäsenyys\n* P702: Kansalaisuus\n* P703: Äidinkieli\n* T000: Kaikki lasta koskevat tiedot\n* T100: Kaikki sosiaali- ja terveyspalvelut\n* T101: Kaikki sosiaalipalvelut\n* T102: Kaikki terveyspalvelut\n* T200: Varhaiskasvatus, opetus ja koulutus\n* T201: Varhaiskasvatus\n* T202: Opetus ja koulutus\n\nPäätösoikeuksia voi antaa ainoastaan määrätyille huoltajille (huoltajan laji 2) ja tiedonsaantioikeuksia ainoastaan tiedonsaantioikeutetulle (huoltajan laji 3).\n","type":"string","enum":["P100","P101","P102","P200","P300","P301","P302","P400","P401","P402","P500","P501","P502","P700","P701","P702","P703","T000","T100","T101","T102","T200","T201","T202"]}}}}}}}},"required":["huollettavanHenkilotunnus","huollot","paatettavatHuollot"]},"examples":{"vuoroasuminen":{"summary":"Ilmoitetaan äiti ja oheishuoltaja, joilla vuoroasuminen","description":"Ilmoitetaan äiti ja oheishuoltaja, joilla vuoroasuminen. Oheishuoltajalla on rajatut päätösoikeudet. Yhden huoltajan (isä) huoltosuhde päättyy.","value":{"huollettavanHenkilotunnus":"020224A9004","paatettavatHuollot":[{"henkilotunnus":"030303A9016"}],"kayttajatunnus":"abc1234","viranomaistyyppi":"S","alkupaiva":"2025-07-01","huollot":[{"huoltajanLaji":"2","huoltajanRooli":"2","huoltaja":{"henkilotunnus":"010100A914X"},"asuminen":{"virallinenAsuinpaikka":true,"tyyppi":"5","alkupaiva":"2025-08-01"}},{"huoltajanLaji":"2","huoltajanRooli":null,"huoltaja":{"henkilotunnus":"070777-9002"},"asuminen":{"tyyppi":"5","alkupaiva":"2025-01-01"},"oikeudet":[{"koodi":"P500"},{"koodi":"P700"}]}],"viranomaisnumero":123}},"sisalto":{"summary":"Huollon sisältö annettu tekstimuodossa","description":"Huollon sisältö annettu tekstimuodossa. Asuminen on isän luona.","value":{"huollettavanHenkilotunnus":"030325A900U","paatettavatHuollot":[],"kayttajatunnus":"abc1234","viranomaistyyppi":"S","alkupaiva":"2025-08-01","huollonSisalto":{"teksti":"Lapsen äidilla on oikeus hoitaa lapsen raha-asioita. Lapsen isä on lapsen täysivaltainen huoltaja."},"huollot":[{"huoltajanLaji":"2","huoltajanRooli":"2","huoltaja":{"henkilotunnus":"020292-904T"},"sisaltotekstiKaytossa":true},{"huoltajanLaji":"2","huoltajanRooli":"1","huoltaja":{"henkilotunnus":"010190-927K"},"sisaltotekstiKaytossa":true,"asuminen":{"tyyppi":"3","alkupaiva":"2025-08-01"}}],"viranomaisnumero":123}}}}}},"description":"Tallentaa kaikki lapsen huoltotiedot. Jos lapsella on entuudestaan voimassaolevia huoltotietoja, ne päätetään.\n","responses":{"200":{"description":"Huolto tallennettu onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"429":{"description":"Asiakkaan pyyntömäärää on rajoitettu","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Huolto"]}},"/oleskelu/hakemus":{"post":{"summary":"Oleskeluluvan jatkohakemus","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"diaariVuosi":{"description":"Diaarin vuosi","maximum":2099,"type":"number","minimum":1900},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"jarjestysnumero":{"description":"Asian diaarin järjestysnumero","maximum":999999,"type":"number","minimum":1},"loppupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Tiedon loppupäivä. Voidaan jättää pois jos tieto on toistaiseksi voimassa."},"diaariryhmaTeksti":{"minLength":1,"description":"Diaariryhmä selväkielisenä","type":"string","maxLength":80},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (4).","type":"string","enum":["4"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Tiedon alkupäivä."},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1},"diaariryhmaKoodi":{"description":"Diaariryhmä koodina:\n  * 110: Ensimmäistä oleskelulupaa koskeva hakemus\n  * 120: Jatkolupahakemus\n  * 130: Pysyvää oleskelulupaa koskeva hakemus\n  * 140: EU-oleskeluoikeus\n  * 141: Oleskeluasema\n  * 150: Voimassa olevaa lupaa koskevat asiat\n  * 210: Turvapaikkahakemus\n  * 230: Kiintiöpakolaisvalinta, UNHCR:n esitys, Humanitaarinen maahanmuutto, VN:n päätös\n  * 250: Tilapäinen suojelu\n  * 450: Maasta karkottaminen\n","type":"number","enum":[110,120,130,140,141,150,210,230,250,450]},"asiaId":{"description":"Asian tekninen avain","type":"number"}},"required":["henkilotunnus","asiaId","jarjestysnumero","diaariryhmaKoodi","diaariryhmaTeksti","diaariVuosi","alkupaiva","kayttajatunnus","viranomaisnumero","viranomaistyyppi"]}],"type":"object","properties":{"kestoHaettu":{"description":"Oleskeluluvan jatkohakemuksessa haettu voimassaolon kesto.","type":"string","enum":["MAARAAIKAINEN","TOISTAISEKSI"]},"vireilletulopaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Oleskeluluvan jatkohakemuksen vireilletulopäivä."},"lajikoodi":{"description":"Tapahtumatyyppi. Oleskeluluvan jatkohakemuksella aina 112.","type":"number","enum":[112]},"hakuperuste":{"description":"Oleskeluluvan jatkohakemuksen hakuperuste.","additionalProperties":false,"type":"object","properties":{"koodi":{"minLength":1,"description":"Oleskeluluvan jatkohakemuksen hakuperuste koodina. Arvo tarkastetaan VTJ:ssä olevaa koodistoa vasten.","type":"string"},"teksti":{"allOf":[{"additionalProperties":false,"type":"object","properties":{"swe":{"minLength":1,"description":"Koodiarvon kuvaus ruotsiksi.","type":"string","maxLength":80},"fin":{"minLength":1,"description":"Koodiarvon kuvaus suomeksi.","type":"string","maxLength":80},"eng":{"minLength":1,"description":"Koodiarvon kuvaus englanniksi.","type":"string","maxLength":80}},"required":["fin","swe","eng"]}],"description":"Hakuperusteen selväkielinen kuvaus."}},"required":["koodi","teksti"]}},"required":["lajikoodi","vireilletulopaiva","kestoHaettu"],"example":{"kayttajatunnus":"user1234","diaariryhmaTeksti":"Jatkolupahakemus","viranomaistyyppi":4,"alkupaiva":"2026-03-16","viranomaisnumero":123,"diaariryhmaKoodi":120,"asiaId":987654,"kestoHaettu":"MAARAAIKAINEN","diaariVuosi":2026,"henkilotunnus":"020292-904T","jarjestysnumero":36700,"vireilletulopaiva":"2026-03-12","lajikoodi":112,"hakuperuste":{"koodi":"ERITYISASIANTUNTIJA","teksti":{"swe":"Specialsakkunnig","fin":"Erityisasiantuntija","eng":"Senior Specialist"}}}}}}},"responses":{"200":{"description":"Oleskelutiedot rekisteröity onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Oleskelu"]}},"/oleskelu/karkotus":{"post":{"summary":"Karkotuspäätös","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"diaariVuosi":{"description":"Diaarin vuosi","maximum":2099,"type":"number","minimum":1900},"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"jarjestysnumero":{"description":"Asian diaarin järjestysnumero","maximum":999999,"type":"number","minimum":1},"loppupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Tiedon loppupäivä. Voidaan jättää pois jos tieto on toistaiseksi voimassa."},"diaariryhmaTeksti":{"minLength":1,"description":"Diaariryhmä selväkielisenä","type":"string","maxLength":80},"viranomaistyyppi":{"description":"Tiedot ilmoittavan viranomaisen tyyppi (4).","type":"string","enum":["4"]},"alkupaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Tiedon alkupäivä."},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1},"diaariryhmaKoodi":{"description":"Diaariryhmä koodina:\n  * 110: Ensimmäistä oleskelulupaa koskeva hakemus\n  * 120: Jatkolupahakemus\n  * 130: Pysyvää oleskelulupaa koskeva hakemus\n  * 140: EU-oleskeluoikeus\n  * 141: Oleskeluasema\n  * 150: Voimassa olevaa lupaa koskevat asiat\n  * 210: Turvapaikkahakemus\n  * 230: Kiintiöpakolaisvalinta, UNHCR:n esitys, Humanitaarinen maahanmuutto, VN:n päätös\n  * 250: Tilapäinen suojelu\n  * 450: Maasta karkottaminen\n","type":"number","enum":[110,120,130,140,141,150,210,230,250,450]},"asiaId":{"description":"Asian tekninen avain","type":"number"}},"required":["henkilotunnus","asiaId","jarjestysnumero","diaariryhmaKoodi","diaariryhmaTeksti","diaariVuosi","alkupaiva","kayttajatunnus","viranomaisnumero","viranomaistyyppi"]}],"type":"object","properties":{"peruutusTaytantoonpanopaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Henkilön karkotuksen täytantöönpanopäivämäärä"},"peruutusLainvoimaisuuspaiva":{"allOf":[{"format":"date","description":"Päivämäärä.","type":"string"}],"description":"Henkilön karkotuksen lainvoimaisuuspäivämäärä."},"lajikoodi":{"description":"Tapahtumatyyppi. Karkotuksella aina 300.","type":"number","enum":[300]}},"required":["lajikoodi"],"example":{"peruutusTaytantoonpanopaiva":"2026-03-24","diaariVuosi":2026,"peruutusLainvoimaisuuspaiva":"2026-03-17","henkilotunnus":"020292-904T","jarjestysnumero":36700,"diaariryhmaTeksti":"Maasta karkottaminen","lajikoodi":300,"viranomaistyyppi":4,"alkupaiva":"2026-03-17","viranomaisnumero":123,"diaariryhmaKoodi":450,"asiaId":987654}}}}},"responses":{"200":{"description":"Oleskelutiedot rekisteröity onnistuneesti","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Oleskelu"]}},"/edunvalvonta/valtuutus":{"patch":{"summary":"Edunvalvonnan valtuutuksen päivittäminen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["paahenkilo","viranomaistyyppi","kayttajatunnus"],"properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"paahenkilo":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"lisattavatEdunvalvontavaltuutetut":{"type":"array","items":{"description":"Edunvalvontavaltuutettu","additionalProperties":false,"type":"object","required":["edunvalvontavaltuutettu","alkupaiva"],"properties":{"edunvalvontavaltuutettu":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi"],"properties":{"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}}]},"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"}}}},"viranomaistyyppi":{"description":"1 = Rekisteriviranomainen","type":"string","enum":["1"]},"edunvalvontavaltuutuksenPaivitys":{"description":"Edunvalvonnan valtuutuksen lisätiedot","additionalProperties":false,"type":"object","required":["alkupaiva","jako"],"properties":{"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"jako":{"type":"boolean"}}},"viranomaisnumero":{"description":"777 (DVV) tai 718 (Ahvenanmaa)","type":"number","enum":[777,718]},"paivitettavatEdunvalvontavaltuutetut":{"type":"array","items":{"description":"Edunvalvontavaltuutettu","additionalProperties":false,"type":"object","required":["edunvalvontavaltuutettu","loppupaiva"],"properties":{"edunvalvontavaltuutettu":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi"],"properties":{"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}}]},"loppupaiva":{"nullable":true,"format":"date","description":"Päivämäärä.","type":"string"}}}}}}}}},"responses":{"200":{"description":"Edunvalvonnan valtuutus päivitetty onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Edunvalvonta"]},"post":{"summary":"Edunvalvonnan valtuutuksen luominen","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["paahenkilo","viranomaisnumero","viranomaistyyppi","kayttajatunnus","edunvalvontavaltuutetut","alkupaiva"],"properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"paahenkilo":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11},"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"viranomaistyyppi":{"description":"1 = Rekisteriviranomainen","type":"string","enum":["1"]},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"edunvalvontavaltuutetut":{"type":"array","items":{"description":"Edunvalvontavaltuutettu","additionalProperties":false,"type":"object","required":["edunvalvontavaltuutettu","alkupaiva"],"properties":{"edunvalvontavaltuutettu":{"oneOf":[{"description":"Hetullinen","additionalProperties":false,"type":"object","required":["henkilotunnus"],"properties":{"henkilotunnus":{"minLength":11,"description":"Henkilötunnus","type":"string","maxLength":11}}},{"description":"Ulkohenkilö","additionalProperties":false,"type":"object","required":["syntymaaika","etunimet","sukunimi"],"properties":{"syntymaaika":{"format":"date","description":"Päivämäärä.","type":"string"},"sukunimi":{"type":"string"},"etunimet":{"type":"string"}}}]},"loppupaiva":{"format":"date","description":"Päivämäärä.","type":"string"},"alkupaiva":{"format":"date","description":"Päivämäärä.","type":"string"}}}},"jako":{"type":"boolean"},"viranomaisnumero":{"description":"777 (DVV) tai 718 (Ahvenanmaa)","type":"number","enum":[777,718]}}}}}},"responses":{"200":{"description":"Edunvalvonnan valtuutus luotu onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"tila","type":"string"}},"example":{"status":"OK"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Edunvalvonta"]}},"/kuolema/ilmoitus":{"post":{"summary":"Henkilön kuolinilmoituksen rekisteröinti","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kayttajatunnus":{"minLength":7,"description":"Organisaation/viranomaisen loppukäyttäjän tekninen käyttäjätunnus. Tunnuksella pitää voida tarvittaessa yksilöidä tapahtuman lisännyt henkilö tai järjestelmä.","type":"string","maxLength":16},"henkilotunnus":{"minLength":11,"description":"Vainajan henkilötunnus.","type":"string","maxLength":11},"laakarinYksilointitunnus":{"pattern":"([0-9]{1,6})","description":"Kuolinilmoituksen tehneen lääkärin Valviran myöntämä yksilöintitunnus (entinen SV-numero).","type":"string"},"sukunimi":{"minLength":1,"description":"Vainajan sukunimi.","type":"string","maxLength":100},"aidinHenkilotunnus":{"minLength":11,"description":"Vainajan äidin henkilötunnus. Pakollinen tieto jos vainajan suku- ja etunimiä ei ole annettu.","type":"string","maxLength":11},"kuolinpaiva":{"format":"date","description":"Vainajan kuolinpäivä.","type":"string"},"etunimet":{"minLength":1,"description":"Vainajan etunimet.","type":"string","maxLength":100},"viranomaisnumero":{"description":"DVV:n asiakasorganisaatiolle antama viranomaisnumero.","maximum":999999,"type":"integer","minimum":1}},"required":["henkilotunnus","kuolinpaiva","kayttajatunnus","viranomaisnumero","laakarinYksilointitunnus"],"example":{"kayttajatunnus":"abc1234","henkilotunnus":"010101-999X","laakarinYksilointitunnus":"352091","sukunimi":"Testinen","kuolinpaiva":"2024-04-12","etunimet":"Tes Esti","viranomaisnumero":123}}}}},"responses":{"200":{"description":"Henkilön kuolinilmoitus rekisteröity onnistuneesti.","content":{"application/json":{"schema":{"type":"object","properties":{"henkilotunnus":{"minLength":11,"description":"Kuolleeksi ilmoitetun henkilön henkilötunnus","type":"string","maxLength":11}},"example":{"henkilotunnus":"010101-999X"}}}}},"400":{"description":"Pyynnön validointi epäonnistui","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["code","errors"],"properties":{"code":{"type":"string"},"errors":{"description":"Virheet voivat olla joko *validointivirheitä* tai *tarkastusvirheitä*. Validointivirhe annetaan, kun pyyntö ei noudata tätä rajapintakuvausta.\nTarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\n\nEsimerkki validointivirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"location\": \"body\",\n        \"parameter\": \"kayttajatunnus\",\n        \"errorCode\": \"INVALID_VALUE\",\n        \"message\": \"must have required property 'kayttajatunnus'\"\n      }\n    ]\n  }\n```\n\nEsimerkki tarkastusvirheestä:\n```json\n  {\n    \"code\": \"VALIDATION_FAILED\",\n    \"errors\": [\n      {\n        \"errorCode\": \"CH134\",\n        \"message\": \"Rekisterissä eri sukunimi. 010665-919W\",\n        \"localizedMessage\": {\n          \"fin\": \"Rekisterissä eri sukunimi. 010665-919W\",\n          \"swe\": \"Annat släktnamn i registret. 010665-919W\",\n          \"eng\": \"\"\n        }\n      }\n    ]\n  }\n```\n","type":"array","items":{"additionalProperties":false,"type":"object","required":["errorCode","message"],"properties":{"localizedMessage":{"description":"Virheviestin lokalisointitekstit.\n\nKenttä ei välttämättä ole mukana vastauksessa, jos pyyntö on\nmuodoltaan epävalidi. Kenttä lisätään virheisiin, jotka liittyvät dataan itseensä, esimerkiksi virheellinen hetu.\n","type":"object","required":["fin","swe","eng"],"properties":{"swe":{"type":"string"},"fin":{"type":"string"},"eng":{"type":"string"}}},"parameter":{"description":"Tieto parametrista, jota virhe koskee, jos kyseessä on validointivirhe.","type":"string"},"errorCode":{"description":"Virhekoodi. Validointivirheissä `INVALID_VALUE`, tarkastusvirheissä jokin DVV:n määrittelemistä virhekoodeista.","type":"string"},"location":{"description":"Tieto virheen sijainnista (esim. `body` tai `headers`) jos kyseessä on validointivirhe.","type":"string"},"message":{"description":"Virheen kuvausteksti. Virheestä saattaa olla tarjolla myös `localizedMessage`-kenttä.\n","type":"string"}}}}}}}}},"401":{"description":"Tunnistautuminen vaaditaan","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"500":{"description":"Palvelinvirhe","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"403":{"description":"Ei käyttöoikeutta palveluun","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"503":{"description":"Palvelu ei käytössä","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"429":{"description":"Asiakkaan pyyntömäärää on rajoitettu","content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"Asiakkaan tunnus ja salasana. Autentikointitapa on [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme),\nts. credentials = Base64-enkoodattu käyttäjätunnus + ':' + salasana\n","required":true,"example":"Basic <credentials>"},{"schema":{"format":"uuid","type":"string"},"in":"header","name":"Trace-ID","description":"Vapaaehtoinen pyynnön yksilöivä tunniste, jota voidaan ongelmatilanteissa käyttää pyynnön tunnistamiseen sekä ylläpidon että asiakkaan omilta lokeilta. Tunniste on UUID-muotoinen (sekä isot että pienet kirjaimet on sallittu).","required":false,"example":"c0279c8c-5980-472a-9b1b-da3add5c5ab1"}],"tags":["Kuolema"]}}},"info":{"description":"\n[Suomi] [[Svenska](/doc/sv)] [[English](/doc/en)]\n\n## Mikä on Elämäntapahtumat-rajapinta?\n\nVäestötietojärjestelmä on perusrekisteri, josta löytyvät ajantasaiset henkilötiedot Suomen kansalaisista ja Suomessa vakinaisesti tai tilapäisesti asuvista ulkomaalaisista henkilöistä.\nLisäksi järjestelmässä on tiedot rakennuksista, rakennushankkeista, huoneistoista sekä kiinteistöistä, joilla rakennukset sijaitsevat.\n\nVäestötietojärjestelmän tietojen ylläpidosta vastaavat Digi- ja väestötietovirasto ja Ahvenanmaan valtionvirasto.\nTietojen rekisteröinti perustuu kuntien, kansalaisten, uskonnollisten yhdyskuntien ja valtion viranomaisten lakisääteisiin ilmoituksiin.\nOrganisaatiot voivat ilmoittaa tietoja väestötietojärjestelmään Elämäntapahtumat-rajapinnan kautta.\n\n## Mitä henkilötietoja rajapinnan kautta voi toimittaa?\n\nElämäntapahtumat-rajapinnan kautta voi tällä hetkellä toimittaa väestötietojärjestelmään seuraavia tietoja:\n\n* Lapsen syntymä\n* Kuoleman rekisteröinti\n* Kuolleeksijulistus\n* Lapsen huoltotietojen ilmoittaminen\n* Vihkiminen avioliittoon\n* Lapsen tiedot\n* Edunvalvonta\n* Avioero\n* Uskontokunnan rekisteröinti\n* Sähköisen asiointitunnuksen (Satu) aktivointi\n* Oleskelutiedot\n* Nimenmuutos\n\n## Miten organisaationi saa luvan testikäyttöön ja tietojen ilmoittamiseen väestötietojärjestelmään?\n\nPyydä tietolupaa testaukseen ja väestötietojärjestelmän ylläpitämiseen Digi- ja väestötietoviraston sähköisestä asiointipalvelusta: https://asiointi.dvv.fi/\n\n## Mistä saan lisätietoa väestötietojärjestelmän ylläpidosta?\n\nLue väestötietojärjestelmän ylläpidosta tarkemmin dvv.fistä: https://dvv.fi/vaestotietojarjestelman-yllapito. Pyydä lisätietoja tarvittaessa osoitteesta ilmoitusliikenne@dvv.fi\n\n## Rajapintojen kutsumisen tekniset vaatimukset\n\nRajapinnan käyttö vaatii käyttäjätunnuksen ja salasanan. Nämä tiedot annetaan kutsun `Authorization`-headerissa (HTTP Basic Authentication).\n\nHyötykuorman tyyppi (`Content-Type`) on `application/json`. Kutsusanoman merkistö on aina UTF-8. Tämän voi myös haluttaessa ilmaista eksplisiittisesti: `Content-Type: application/json;charset=utf-8`.\n\nRajapintaa käytetään pääasiassa [Suomi.fi-palveluväylän](https://dvv.fi/palveluvayla) kautta. Kutsuttava alijärjestelmä on [VTJEltap](https://liityntakatalogi.suomi.fi/fi/dataset/vtjeltap). Kutsuttava osoite on tällöin:\n* tuotannossa: `https://<lähettävä-liityntäpalvelin>/r1/FI/GOV/0245437-2/VTJEltap/Eltap/[endpoint]`\n* testiympäristössä: `https://<lähettävä-liityntäpalvelin>/r1/FI-TEST/GOV/0245437-2/VTJEltap/Eltap/[endpoint]`\n\nmissä `[endpoint]` on jokin tässä dokumentissa kuvatuista rajapinnoista, esimerkiksi:\n* `ping`\n* `syntyma`\n* `kuolema/ilmoitus`\n* `kuolema/julistus`\n* `huolto/ilmoitus`\n* `huolto/paivitys`\n* `vihkiminen`\n* `lapsen-tiedot`\n* `edunvalvonta`\n* `uskontokunta`\n* `satu/aktivointi`\n* `nimenmuutos`\n\nMyös ilmoittavan järjestelmän ja VTJ:n välinen suora integraatio on mahdollinen tapa käyttää rajapintaa. Tähän tulee kuitenkin toistaiseksi hakea poikkeuslupaa osoitteesta ilmoitusliikenne@dvv.fi.\nSuora integraatio vaatii asiakasvarmenteen käyttöä (mTLS) sekä yhteyksien sallimista asiakkaan verkosta Elämäntapahtumat-rajapintaan.\n\nPalveluväyläkutsuissa on asetettava myös `x-road-client`-otsake. Esimerkiksi: `x-road-client: FI/<GOV/MUN/COM/EDU>/y-tunnus/<luvitettu alijärjestelmä>`.\n\n### Käyttökatko 23:00-01:00\n\nElämäntapahtumat-rajapinnassa on käyttökatko joka yö klo 23:00-01:00 (Europe/Helsinki). Tänä aikana rajapintakutsut palauttavat HTTP-statuskoodia `503`.\n\n## Rajapintojen testaus\n\nPalvelun asiakastestausympäristössä voi käyttää [testiaineistopalvelusta](https://testiaineisto.fi/) löytyviä henkilötunnuksia. Testiaineistopalvelun käyttöön tarvitset tunnuksen ja salasanan.\nNe voit pyytää Digi- ja väestötietovirastolta osoitteesta organisaatiopalvelut@dvv.fi. [Lue lisää testiaineistopalvelusta](https://kehittajille.suomi.fi/palvelut/testiaineistopalvelu).\n\nTestauksen helpottamiseksi alla on lueteltu eräitä testiaineistopalvelusta löytyviä henkilötunnuksia, joilla voi testata erilaisia tapauksia.\nHuomioi, että testikutsut muuttavat testihenkilöiden tietoja; esimerkiksi saman henkilön voi ilmoittaa kuolleeksi vain kerran. Asiakastestausympäristön tietokanta palautetetaan alkutilaansa arkiaamuisin.\n\n## SOAP/XML-rajapinta\n\nPian käytöstä poistuvan [VTJyllapito-rajapinnasta](https://liityntakatalogi.suomi.fi/fi/dataset/vtjyllapito) siirtymisen helpottamiseksi Elämäntapahtumat-rajapinnasta on toistaiseksi saatavilla myös SOAP/XML-rajapinta,\njoka vastaa toiminnallisuudeltaan VTJyllapito-rajapintaa. Huoltoja ei ole mahdollista ilmoittaa SOAP-rajapinnan kautta. Vanhasta rajapinnasta siirtyvien asiakkaiden on toistaiseksi mahdollista käyttää myös suoraa järjestelmien välistä integraatiota,\njoka ei käytä Palveluväylää. Integraatio vaatii asiakasvarmenteen käyttöä (mTLS) sekä yhteyksien sallimista asiakkaan verkosta. Asiakkaan tulee toimittaa käyttämänsä varmenteen nimi (CN, common name)\nja IP-osoitteet yhteysavauksien tekemistä varten osoitteeseen ilmoitusliikenne@dvv.fi. Asiakastestausympäristön käyttöä varten ei tarvita tietoliikenneavauksia,\nmutta asiakasvarmenne on pakollinen myös asiakastestausympäristössä.\n\nRajapinnasta on saatavilla WSDL-kuvaukset sekä [suoraan integraatioon](/public/vtj_yllaptiedot.wsdl) että [Palveluväylän kautta tapahtuvaan käyttöön](/public/YPsosoAdapterService.wsdl).\nKaikki ilmoitusrajapinnat käyttävät samaa WSDL:ää, mutta kutsu- ja vastaussanomien hyötykuorman muoto vaihtelee palvelun mukaan:\n  * [Syntymäilmoitussanoman hyötykuorman XML-skeema](/public/SWSXSSC_schema.xsd)\n  * [Kuoleman rekisteröintisanoman hyötykuorman XML-skeema](/public/SWSXSKC_schema.xsd)\n\nSanomien tietotyypit on kuvattu [omassa XML-skeemassaan](/public/VTJ_YllapKatalogi.xsd).\n\nEsimerkkisanomia:\n* [Kuoleman rekisteröintipyyntö](/public/kuolema_request_example.xml) ja [-vastaus](/public/kuolema_response_example.xml) suorakäyttörajapinnassa\n* [Kuoleman rekisteröintipyyntö](/public/kuolema_request_palveluvayla_example.xml) ja [-vastaus](/public/kuolema_response_palveluvayla_example.xml) Palveluväylässä\n* [Syntymäilmoituspyyntö](/public/syntyma_request_example.xml) ja [-vastaus](/public/syntyma_response_example.xml) suorakäyttörajapinnassa\n* [Syntymäilmoituspyyntö](/public/syntyma_request_palveluvayla_example.xml) ja [-vastaus](/public/syntyma_response_palveluvayla_example.xml) Palveluväylässä\n* Esimerkki tarkastusvirheestä [suorakäyttörajapinnassa](/public/tarkastus_error_example.xml) ja [Palveluväylässä](/public/tarkastus_error_palveluvayla_example.xml)\n* [Esimerkki validointivirheestä](/public/validation_error_example.xml) (SOAP Fault)\n\n\n## Rajapintojen virhekoodit\n\nKunkin rajapinnan tarkastusvirheiden virhekoodit on lueteltu alla. Tarkastusvirheet liittyvät käsiteltävän henkilön/henkilöiden tietoihin. Näitä voivat olla esimerkiksi henkilötunnuksen tai nimien olemassaolo tai voimassaolo.\nSuurin osa tarkastusvirheistä on mahdollista korjata asiakaspäässä antamalla oikeat tiedot, mutta joissain harvinaisissa tapauksissa pyyntöä ei voida käsitellä\nVTJ:ssä olevan virheellisen tiedon takia. Näissä tapauksissa tulee olla yhteydessä DVV:hen tietojen tallentamiseksi ja korjaamiseksi.\nHistoriallisista syistä SOAP-rajapinnan virhekoodien muoto eroaa hieman REST-rajapinnan virhekoodeista.\n\n### SOAP-rajapinnan omat virhekoodit\n\nSOAP-rajapinnassa on tarkastusvirhekoodien lisäksi käytössä myös omat virhekoodit tietyille virhetilanteille, joiden ilmaisemiseen REST-rajapinnassa on käytetty HTTP-statuskoodeja. Nämä ovat yhteisiä kaikille SOAP-rajapinnoille.\nHuomaa, että tilanteissa joissa pyyntösanomaa ei ole mahdollista tulkita WSDL:n tai hyötykuormien skeeman mukaisesti, virheilmoituksen muoto vastaussanomassa on [SOAP Fault](https://www.ibm.com/docs/en/integration-bus/10.0?topic=message-soap-fault).\nKs. [esimerkki validointivirheestä](/public/validation_error_example.xml).\n\n| Virhekoodi | Kuvaus  |\n| ---------- | ------- |\n| 0003       | Sanoman validointivirhe. Sanoma ei noudata annettua skeemaa. |\n| 0004       | Ei oikeutta palveluun. |\n| 0005       | Tuntematon järjestelmävirhe. |\n| 0006       | Tunnistusvirhe: käyttäjätunnus/salasana väärin tai asiakasvarmenne ei ole sallittu. |\n| 0009       | Palvelu ei ole käytettävissä huoltokatkon tai pyyntörajojen ylittymisen takia. |\n| 0052       | Tapahtumatunnus ei sallittu. |\n","title":"Elämäntapahtumat-rajapinta","version":"v1"},"tags":[{"name":"Kuolema","description":"\n## Kuoleman rajapintojen virhekoodit\n\n| Virhekoodi REST-rajapinnassa  | Virhekoodi SOAP-rajapinnassa | Kuvaus                  |\n| -------                       | ------------                 | ------------            |\n| AH004                         | A004                         | Pyynnössä annettu vainajan henkilötunnus tai äidin henkilötunnus ei ole oikean muotoinen. |\n| AH033                         | A033                         | Pyynnössä annettu sukunimi sisältää virheellisiä merkkejä. |\n| AT001                         | A001                         | Pyynnössä annettu kuolinpäivä tai kuolleeksijulistamispäivä on tulevaisuudessa. |\n| AT002                         | A002                         | Pyynnössä annettu kuolinpäivä on ennen henkilön syntymäpäivää. |\n| BH069                         | -                            | Pyynnössä annettu kuolleeksijulistamispäivä on ennen kuolinpäivää. (Vain kuolleeksijulistuksissa) |\n| BH137                         | B137                         | Pyynnössä on annettava vainajan nimi (sekä suku- että etunimet) tai äidin henkilötunnus. |\n| CH041                         | C041                         | Henkilöllä on VTJ:ssä Suomen kansalaisuus, mutta myös voimassaolevia oleskelutietoja. Ole yhteydessä DVV:hen kuoleman rekisteröimiseksi. |\n| CH127                         | C127                         | Pyynnössä annetulla vainajan henkilötunnuksella tai äidin henkilötunnuksella ei löydy henkilöä VTJ:stä. |\n| CH128                         | C128                         | Pyynnössä annettu vainajan henkilötunnus tai äidin henkilötunnus on passivoitu. Tarkistus tehdään myös henkilön puolisosta. Ole yhteydessä DVV:hen kuoleman rekisteröimiseksi. |\n| CH129                         | C129                         | Henkilö jonka kuolintietoa ollaan tallentamassa, on jo merkitty kuolleeksi VTJ:ssä. |\n| CH134                         | C134                         | Pyynnössä annettu sukunimitieto ei täsmää VTJ:ssä olevaan sukunimeen. |\n| CH136                         | C136                         | Pyynnön vainajalta puuttuu VTJ:stä sukunimi tai etunimi. Tarkistus tehdään myös vainajan äidille, jos äidin hetu on annettu pyynnössä. |\n| CH207                         | C207                         | Pyynnössä annetut etunimet eivät täsmää VTJ:ssä oleviin etunimiin. |\n| CH208                         | C208                         | Pyynnössä annettu äidin henkilötunnus ei täsmää VTJ:ssä olevaan äidin henkilötunnukseen. |\n| CT901                         | C901                         | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931                         | C931                         | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n\n## Kuoleman testitapauksia\n\n### Kuoleman rekisteröintiin johtavia testitapauksia\n\n| vainajan hetu | sukunimi                                     | etunimet                                          | huomioitavaa                           |\n| ------------- | --------                                     | --------                                          | ------------                           |\n| 290644-9994   | Testikara                                    | Teemu                                             |                                        |\n| 301000F989A   | Välimerkki                                   | Rolf Mzguc                                        |                                        |\n| 301095U920L   | Välimerkki                                   | Suvi Wouqd                                        |                                        |\n| 111106B926C   | Välimerkki                                   | Tanja Lgcoa                                       |                                        |\n| 111106A994K   | Välimerkki                                   | Terttu Xchgz                                      |                                        |\n| 231162-999X   | ÀÁÂÃÆÇÐÈÉÊËÌÍÏÑÒÓÔÕØßÞÙÚÛÜÝ                  | àáâãæçðèéêëìíîïñòóôõøþùúûüýÿ                      |                                        |\n| 010491-901D   | Ááþà' Üÿ Àß Ø-Ñþ ISO kasikasiviisysiviivayks | Êå Õñøõý Ýüôð ïÆ' Wîä ISO kasikasiviisysiviivayks |                                        |\n| 111123B912A   | Välimerkki                                   | Sofia Uudhq                                       |                                        |\n| 101246-9986   | Testikuusi                                   | Teija                                             |                                        |\n| 301095U922N   | Välimerkki                                   | Pia Vjvuv                                         |                                        |\n| 301095X928V   | Välimerkki                                   | Ada Qcfux                                         |                                        |\n| 010322A900S   |                                              |                                                   | Kuolleella ei nimeä, äiti: 290292-9003 |\n| 210524A900T   |                                              |                                                   | Kuolleella ei nimeä, äiti: 010400A9085 |\n\n#### Virheilmoituksen palauttavia testitapauksia\n\n| vainajan hetu | sukunimi                    | etunimet                     | virheilmoitus                                         |\n| ------------- | --------                    | --------                     | ------------                                          |\n| 251199-999S   | Testaajainen                | Eric Andrew                  | Henkilö on jo kuollut (CH129)                         |\n| 170477-9977   | Nimiväärin                  | Jussi                        | Sukunimi ei täsmää VTJ:ssä olevaan sukunimeen (CH134) |\n"},{"name":"Syntymä","description":"\n## Syntymän rajapinnan virhekoodit\n\n| Virhekoodi REST-rajapinnassa  | Virhekoodi SOAP-rajapinnassa | Kuvaus                  |\n| -------                       | ------------                 | ------------            |\n| AA070                         | A070                         | Synnyttäjältä lapselle periytyvä kotikunta ei ole Suomessa. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| AA071                         | A071                         | Synnyttäjältä lapselle periytyvä kotikunta on tuntematon. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| AA072                         | A072                         | Synnyttäjältä lapselle periytyvä kotikunta on ulkomaat. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| AH004                         | A004                         | Pyynnössä annettu synnyttäjän henkilötunnus ei ole oikean muotoinen. |\n| AT001                         | A001                         | Pyynnössä annettu lapsen syntymäpäivä on tulevaisuudessa. |\n| CA007                         | C007                         | Synnyttäjältä lapselle periytyvä kotikunta ei ole voimassa annettuna lapsen syntymäpäivänä. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| CA008                         | C008                         | Synnyttäjältä lapselle periytyvää kotikunta ei löydy VTJ:stä. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| CH114                         | C114                         | Pyynnössä annettu lapsen järjestyskirjain ei ole sääntöjen mukainen: järjestyskirjain ei ole sallittu, aakkosjärjestyksessä seuraava vapaa järjestyskirjain tai järjestyskirjaimissa on aukkoja. |\n| CH127                         | C127                         | Pyynnössä annetulla synnyttäjän henkilötunnuksella ei löydy henkilöä VTJ:stä. |\n| CH128                         | C128                         | Pyynnössä annettu synnyttäjän henkilötunnus on passivoitu. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| CH129                         | C129                         | Synnyttäjä on kuollut ennen pyynnössä annettua lapsen syntymäpäivää. |\n| CH706                         | C706                         | Pyynnössä annettu synnyttäjä on ulkomaalainen, joka on poistettu väestörekisteristä. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| CT901                         | C901                         | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931                         | C931                         | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n| US001                         | U001                         | Synnyttäjällä on useita voimassaolevia avioliittoja. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n| US003                         | U003                         | Synnyttäjällä ei ole voimassaolevaa osoitetta Suomessa. Ole yhteydessä DVV:hen syntymän rekisteröimiseksi. |\n\n## Syntymän testitapauksia\n\n### Syntymän rekisteröintiin johtavia testitapauksia\n\n| synnyttäjän hetu | lapsen syntymäpäivä | järjestyskirjain | huomioitavaa                                                                        |\n| ---------------- | ------------------- | ---------------- | ------------                                                                        |\n| 131199-9980      | 2025-03-02          | A                |                                                                                     |\n| 131199-9980      | 2025-03-02          | B                | Kaksosen syntymän rekisteröinti. Toimii vain jos ylläoleva syntymä on rekisteröity. |\n| 111199-996M      | 2025-02-28          | A                |                                                                                     |\n| 030998-998N      | 2025-03-06          | A                |                                                                                     |\n| 010100A910T      | 2025-02-14          | A                |                                                                                     |\n| 301095Y9685      | 2025-02-18          | A                |                                                                                     |\n| 111106E9527      | 2025-02-24          | A                |                                                                                     |\n\n\n### Virheilmoituksen palauttavia testitapauksia\n\n| synnyttäjän hetu | lapsen syntymäpäivä | järjestyskirjain | virheilmoitus                      |\n| ---------------- | ------------------- | ---------------- | ------------                       |\n| 221182-998D      | 2025-03-06          | A                | Henkilötunnus on passiivi (CH128)  |\n| 290272-900X      | 2025-03-06          | A                | Henkilö kuollut (CH129)            |\n| 131199-9980      | 2025-03-06          | A                | Järjestyskirjainristiriita (CH114) |\n"},{"name":"Huolto","description":"\n## Huoltorajapintojen virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| AH033      | Pyynnössä annetun henkilötunnuksettoman huoltajan etu- tai sukunimessä on kiellettyjä merkkejä. |\n| AT001      | Alkupäivätieto on tulevaisuudessa. Koskee kaikkia huollon rajapinnoissa ilmoitettavia alkupäivätietoja. |\n| BH007      | Huollettava on vanhempi kuin huoltaja, ts. huoltaja ja huollettava ovat pyynnössä todennäköisesti väärin päin. |\n| CH127      | Pyynnössä annetulla huollettavan tai huoltajan henkilötunnuksella ei löydy henkilöä VTJ:stä. |\n| CH128      | Pyynnössä annettu huollettavan tai huoltajan henkilötunnus on passivoitu. |\n| CH129      | Huoltaja tai huollettava on kuollut. Ole yhteydessä DVV:hen huoltotietojen tallentamiseksi. |\n| CH416      | Huollettava ja huoltaja eivät saa olla sama henkilö. |\n| CH721      | Annettu oikeus on jo voimassa. |\n| CH725      | Tiedonsaantioikeuksia saa antaa vain tiedonsaantioikeutetulle. |\n| CH728      | Sisältötekstiä ei voi ottaa käyttöön ellei sisältöä ole annettu. |\n| CH729      | Annettu sisältö on jo käytössä huoltajalla. |\n| CH726      | Päätösoikeuksia saa antaa vain määräyksenvaraiselle huoltajalle. |\n| CH731      | Annettu huoltajan rooli ja laji ovat jo voimassa. |\n| CH733      | Huoltajan rooli tai asumisen tyyppi ei vastaa vanhemmuusnimikettä. |\n| CH735      | Päätettävää tai päivitettävää huoltosuhdetta ei ole olemassa tai se ei ole voimassa. |\n| CH736      | Asumisen alkupäivä ennen huollon alkupäivää. |\n| CH737      | Oikeuden alkupäivä ennen huollon alkupäivää. |\n| CH740      | Huollon sisältötekstissä on henkilötunnuksia tai kiellettyjä merkkejä/merkkiyhdistelmiä. |\n| CH742      | Huollolla ei saa olla sekä oikeuksia että sisältöä. |\n| CH751      | Huollon sisällön alkupäivä ennen huollon alkupäivää. |\n| CH757      | Annettu asuminen on jo voimassa. |\n| CH759      | Päätettävää tai päivitettävää asumista ei ole olemassa tai se ei ole voimassa. |\n| CH760      | Päätettävää oikeutta ei ole olemassa tai se ei ole voimassa. |\n| CH762      | Huollon alkupäivä on ennen lapsen syntymäpäivää. |\n| CH764      | Sama oikeus annettu huollolle enemmän kuin kerran. |\n| CH770      | Virallinen asuinpaikka voi olla vain yhden huoltajan luona. |\n| CH775      | Huoltaja esiintyy pyynnössä enemmän kuin kerran. |\n| CH783      | Annettu huollon roolin, asumisen tai oikeuden voimassaoloaika on ristiriidassa VTJ:ssä jo olevan tiedon kanssa. |\n| CH786      | Virallinen asuinpaikka -tieto vaatii vuoroasumisen. |\n| CT901      | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n| UH002      | Vuoroasuminen vaatii että virallinen asuinpaikka -tieto annettu. |\n| UH003      | Huollon kaikkien asumisten oltava samaa tyyppiä. |\n| UH004      | Vanhempien luona asuminen pitää asettaa kahdelle huoltajalle. |\n| UH005      | Äidin tai isän luona asuminen saa olla asetettuna vain yhdelle huoltajalle. |\n| UH006      | Vuoroasumisen on oltava yhden vanhemman ja vähintään yhden oheishuoltajan luona. |\n| UH007      | Vuoroasumisen on oltava kahden vanhemman ja vähintään yhden oheishuoltajan luona. |\n| UH008      | Lapsella on voimassaolevia huoltoja, joihin ei ole otettu kantaa sanomalla. Kaikki huollot pitää joko korvata tai päättää. (Käytössä vain huoltoilmoitusrajapinnassa). |\n| UH009      | Jos sisältöteksti on annettu, se on liitettävä vähintään yhteen huoltajaan. |\n| UH010      | Tiedonsaantioikeuteutulle on annettava vähintään yksi tiedonsaantioikeus. |\n| UH011      | Päätettävää huollon sisältöä ei löydy. |\n| UH016      | Huollon päivitys ei saa jättää voimaan lakisääteisiä huoltoja. |\n| UH017      | Voimassaoleva huolto on päätettävä samalla päivämäärällä kuin lisättävän huollon alkupäivä. |\n| UH018      | Lapsella ei ole voimassaolevia huoltajia päivityksen jälkeen. |\n| UH019      | Yhdellekään huoltajalle ei saa jäädä voimaan vanhaa sisältöä uuden sisällön lisäämisen tai vanhan sisällön päättämisen jälkeen. |\n| UH020      | Lakisääteiselle huollolle ei voi lisätä asumista. |\n| UH023      | Voimassaoleva asuminen on päätettävä samalla päivämäärällä kuin lisättävän asumisen alkupäivä. |\n| UH024      | Virallinen asuinpaikka on päätettävä huoltajalta samalla päivämäärällä kuin se lisätään toiselle huoltajalle. |\n| UH025      | Annettu virallisen asuinpaikan muutos on jo voimassa. |\n| UH026      | Lakisääteiselle huollolle ei voi lisätä oikeuksia. |\n| UH029      | Asuminen ei saa olla tiedonsaantioikeutetun luona, jos tiedonsaantioikeutettu ei ole vanhempi. |\n\n## Huoltojen testitapauksia\n\n### Testilista 1 (henkilöiden kotikunta Oulu, ellei toisin mainita)\n\n| huollettava | huoltaja 1         | huoltaja 2             | alkutilanne | esimerkki testitapauksesta         |\n| ------------| ------------------ | -----------------      | -------     | ------------                       |\n| 020224A9004 | 010100A914X (äiti) |  030303A9016 (isä) | Vanhemmilla lakisääteinen huolto. | Ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 050421A901X | 060900A9005 (äiti) | 030999-901T (isä) | Vanhemmilla määräyksenvarainen huolto 2.5.2025 alkaen. Lapsi asuu äidin luona. | Muutetaan asuminen vuoroasumiseksi vanhempien luona (*huoltopäivitysrajapinta*).|\n| 201020A9005 | 300495-9004 (äiti) | isä: Kooopppoooo, Angelo Aononono 30.3.1995 (sukunimi, etunimet, syntymäaika)  | Vanhemmilla lakisääteinen huolto. **Henkilöiden kotikunta Vaasa.** | Henkilötunnuksettoman huoltajan testaaminen; ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 300123A9004 | 060296-9009 (äiti) | 301195-900S (vahvistettu äiti) | Vanhemmilla lakisääteinen huolto. Vanhemmat samaa sukupuolta. | Samaa sukupuolta olevien huoltajien testaaminen; ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 020125A901L | 060903A900X (äiti) | - | Äidillä lakisääteinen yksinhuolto. Lapsella isä **020702A901H**, jonka vanhemmuus on vahvistettu syntymän jälkeen. | Ilmoitetaan vanhempien yhteishuollosta (*huoltoilmoitusrajapinta*). |\n| 110321A900Y | 200898-900N (äiti) | - | Äidillä määräyksenvarainen yksinhuolto 7.6.2025 alkaen. Lapsi asuu äidin luona. Lapsen isä **191295-901H** ei enää ole lapsen huoltaja. | Lisätään lapsen äidin äiti **280264-9007** lapsen muuksi huoltajaksi (*huoltopäivitysrajapinta*). |\n| 220720A9012<br/>130923A901M | 070594-900U (äiti) | 080593-9018 (isä) | Vanhemmilla lakisääteinen huolto. | Ilmoitetaan päätös, jossa vanhempien yhteishuolto päättyy ja äidille jää yksinhuolto. Isälle annetaan tiedonsaantioikeus esim. lapsen kaikkiin asioihin (*huoltoilmoitusrajapinta*). |\n| 030522A901P | 170299-9005 (äiti) | 090502A901D (isä) | Äidillä määräyksenvarainen yksinhuolto 4.3.2025 alkaen. Lapsen isä on tiedonsaantioikeutettu 4.3.2025 alkaen. | Tiedonsaantioikeutettu isä muuttuu määräyksenvaraiseksi huoltajaksi (*huoltopäivitysrajapinta*). |\n| 290925A900E | 080993-900E (äiti) | 030992-9010 (isä) | Vanhemmilla lakisääteinen huolto. Lapsen toinen vanhempi on korjannut sukupuolensa mieheksi ennen lapsen syntymää. Lapsen synnyttänyt äiti on nainen. | Ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 220719A900S | 020292-906V (äiti) | 171289-901N (isä) | Vanhemmat eronneet 13.3.2024. Vanhemmilla määräyksenvarainen yhteishuolto 14.3.2024 alkaen. **Äiti on kuollut 1.10.2025**. | Minkä tahansa huoltotiedon ilmoittaminen äidille epäonnistuu virheeseen CH129 (henkilö kuollut). |\n\n### Testilista 2 (henkilöiden kotikunta Kuopio, ellei toisin mainita)\n\n| huollettava | huoltaja 1          | huoltaja 2             | alkutilanne | esimerkki testitapauksesta         |\n| ------------| ------------------- | -----------------      | -------     | ------------                       |\n| 030325A900U | 020292-904T (äiti) |  010190-927K (isä) | Vanhemmilla lakisääteinen huolto.  **Henkilöiden kotikunta Vaasa.** | Ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 200424A900B | 010104A900H (äiti) | 070303A901S (isä) | Vanhemmilla määräyksenvarainen huolto 1.2.2025 alkaen. Lapsi asuu äidin luona. | Muutetaan asuminen vuoroasumiseksi vanhempien luona (*huoltopäivitysrajapinta*).|\n| 190122A901T | 250698-9009 (äiti) | isä: Capsicum Tes, Horatio Occidentalis 23.5.1993 (sukunimi, etunimet, syntymäaika)  | Vanhemmilla lakisääteinen huolto. | Henkilötunnuksettoman huoltajan testaaminen; ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 060624A901Y | 040404A902X (äiti) | 050505A900K (vahvistettu äiti) | Vanhemmilla lakisääteinen huolto. Vanhemmat samaa sukupuolta. | Samaa sukupuolta olevien huoltajien testaaminen; ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 030425A901N | 050505A902M (äiti) | - | Äidillä lakisääteinen yksinhuolto. Lapsella isä **070702A901R**, jonka vanhemmuus on vahvistettu syntymän jälkeen. | Ilmoitetaan vanhempien yhteishuollosta (*huoltoilmoitusrajapinta*). |\n| 280223A901N | 200898-902R (äiti) | 030798-901X (isä) | Vanhemmilla lakisääteinen huolto. | Ilmoitetaan päätös, jossa vanhempien yhteishuolto päättyy ja äidille jää yksinhuolto. Isälle annetaan tiedonsaantioikeus esim. lapsen kaikkiin asioihin (*huoltoilmoitusrajapinta*). |\n| 010223A9018 | 050296-900M (äiti) | 130296-901U (isä) | Äidillä määräyksenvarainen yksinhuolto 16.4.2025 alkaen. Lapsen isä on tiedonsaantioikeutettu 4.3.2025 alkaen. | Tiedonsaantioikeutettu isä muuttuu määräyksenvaraiseksi huoltajaksi (*huoltopäivitysrajapinta*). |\n| 290925A901F | 051295-900E (äiti) | 060289-901H (isä) | Vanhemmilla lakisääteinen huolto. Lapsen toinen vanhempi on korjannut sukupuolensa mieheksi ennen lapsen syntymää. Lapsen synnyttänyt äiti on nainen. | Ilmoitetaan mikä tahansa uusi huoltopäätös (*huoltoilmoitusrajapinta*). |\n| 011021A9016 | 090995-900L (äiti) | 130995-9017 (isä) | Vanhemmat eronneet 29.2.2024. Vanhemmilla määräyksenvarainen yhteishuolto 1.3.2024 alkaen. **Äiti on kuollut 1.10.2025**. | Minkä tahansa huoltotiedon ilmoittaminen äidille epäonnistuu virheeseen CH129 (henkilö kuollut). |\n\n### Oheishuoltajia\n\nNäitä henkilöitä voi yhdistellä edellä oleviin testitapauksiin oheishuoltajiksi, Esimerkiksi huoltopäätös, jossa yksinhuoltaja-vanhemman ohella lapselle lisätään muu huoltaja:\n\n* 070777-9002\n* 280264-9007\n"},{"name":"Vihkiminen","description":"\n## Vihkimisen rajapinnan virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| AH033      | Uudessa sukunimessä on kiellettyjä merkkejä. |\n| AT001      | Vihkipäivä tulevaisuudessa. |\n| AT208      | Uudessa sukunimessä on pelkkiä isoja kirjaimia tai peräkkäisiä isoja kirjaimia. |\n| BH110      | Molempien puolisoiden on oltava yli 15-vuotiaita. |\n| BH888      | Samaa sukupuolta olevien vihkipäivä voi olla aikaisintaan 1.3.2017. |\n| CH127      | Vihittävä henkilö puuttuu VTJ:stä. |\n| CH128      | Vihittävä henkilön henkilötunnus on passivoitu. |\n| CH129      | Vihittävä henkilö on kuollut. |\n| CH329      | Vihittävä henkilö on jo avioliitossa tai rekisteröidyssä parisuhteessa. |\n| CT901      | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n| UA243      | Uusi sukunimi ei saa alkaa välilyönnillä tai sisältää kahta peräkkäistä välilyöntiä. |\n| UA244      | Uusi sukunimi ei saa koostua pelkästään erikoismerkeistä. |\n| UV002      | Vihkipäivä tai ei saa olla ennen 1.1.1800 |\n\n\n## Vihkimisen testitapauksia\n\n| puoliso 1   | puoliso 2                  | huomioitavaa |\n| ------      | ----                       | -------      |\n| 301195-901T | 251198-900A                | |\n| 031001A901A | 220705A9005                | |\n| 120100A900K | 090203A9007                | Puolisot samaa sukupuolta. |\n| 311299-905D | Henkilötunnukseton henkilö | Esimerkki henkilötunnuksettomasta henkilöstä: Bojanus, Ludovicus Henricus, synt. 16.7.2000, naimaton. |\n| 251278-9010 | 170580-900N                | Puoliso 1 on kuollut 26.9.2025. Rajapinta palauttaa virheen CH129, jos vihkipäivä on kuolinpäivän jälkeen. |\n"},{"name":"Lapsen tiedot","description":"\n## Lapsen tietojen ilmoittamisen virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| AH004      | Tarkista henkilötunnus. |\n| AH033      | Nimessä on kiellettyjä merkkejä. |\n| AT001      | Uskontokunnan alkupäivä tulevaisuudessa. |\n| CH127      | Henkilö puuttuu VTJ:stä. |\n| CH128      | Henkilön henkilötunnus on passivoitu. |\n| CH136      | Henkilön vanhemman nimi puuttuu VTJ:stä. Ole yhteydessä DVV:hen lapsen tietojen rekisteröimiseksi. |\n| UC003      | Kielikoodia ei löydy VTJ-koodistosta. |\n| AT019      | Kielen selväkielinen nimi puuttuu tai on virheellinen |\n| CT901      | Pyynnössä annettua viranomaista tai seurakuntaa ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen tai seurakunta ei ole voimassaoleva. |\n| LT001      | Lapselle on jo ilmoitettu etunimi. |\n| LT002      | Lapselle on jo ilmoitettu sukunimi. |\n| LT003      | Lapselle on jo ilmoitettu äidinkieli. |\n| LT008      | Lapselle rekisteröitävän uskontokunnan on oltava vanhemman voimassaoleva uskontokunta. |\n| LT010      | Uskontokunnan alkupäivä on ennen lapsen syntymäpäivää. |\n| LT011      | Uskontokunnan alkupäivä on lapsen kuolinpäivän jälkeen. |\n| LT012      | Lapselle on jo ilmoitettu uskontokunta. |\n| LT013      | Lapsella on harvinainen etunimi. Ole yhteydessä DVV:hen lapsen tietojen rekisteröimiseksi. |\n| LT014      | Lapselle on jo ilmoitettu kutsumanimi. |\n| LT015      | Lapsen kutsumanimen on oltava yksi etunimistä. |\n| LT016      | Lapsella on enemmän kuin neljä etunimeä. |\n| LT017      | Lapsen ensimmäinen etunimi on -poika, -sson, -tytär tai -dotter-päätteinen patronyymi tai matronyymi. Ole yhteydessä DVV:hen lapsen tietojen rekisteröimiseksi. |\n| LT018      | Lapsen ensimmäinen etunimi on sama kuin elossa olevalla sisaruksella. Ole yhteydessä DVV:hen lapsen tietojen rekisteröimiseksi. |\n| LT019      | Lapsen sukunimi on sukunimilain vastainen tai vaatii manuaalista käsittelyä. Ole yhteydessä DVV:hen lapsen tietojen rekisteröimiseksi. |\n| UTF8       | Nimi ei saa sisältää merkkejä, joita ei voi translitteroida AH033-muotoon. |\n| UA243      | Nimi ei saa alkaa välilyönnillä, päättyä välilyöntiin tai sisältää peräkkäisiä välilyöntejä. |\n| UA244      | Nimi ei saa koostua pelkistä väli- tai erikoismerkeistä. |\n| AT208      | Nimessä peräkkäisiä isoja kirjaimia. |\n\n## Lapsen tietojen ilmoittamisen testitapauksia\n\n| lapsi       | äidin sukunimi   | äidin uskontokunta                    | isän sukunimi | isän uskontokunta                    |\n| -----       | --------------   | ------------------                    | ------------- | -----------------                    |\n| 200126A900E | Virtanentes      | 621 Malmin seurakunta                 | -             | -                                    |\n| 200126A901F | Korhonentes      | 651 Helsingin ortodoksinen seurakunta | -             | -                                    |\n| 210126A9003 | Lainetes         | 621 Malmin seurakunta                 | Mäkelätes     | -                                    |\n| 210126A9014 | Hämäläinentes    | 651 Helsingin ortodoksinen seurakunta | Virtanentes   | -                                    |\n| 220126A901S | Miettinentes     | 621 Malmin seurakunta                 | Miettinentes  | -                                    |\n| 220126A900R | Virtanentes      | 651 Helsingin ortodoksinen seurakunta | Virtanentes   | -                                    |\n| 230126A900C | Mäkinentes       | -                                     | Mäkinentes    | 621 Malmin seurakunta                |\n| 230126A901D | Korhonentes      | -                                     | Korhonentes   | 651 Helsingin ortodoksinen seurakunta|\n| 240126A9034 | Miettinentes     | 621 Malmin seurakunta                 | Miettinentes  | -                                    |\n| 250126A900N | Miettinentes     | 651 Helsingin ortodoksinen seurakunta | Miettinentes  | -                                    |\n| 250126A901P | Nikkinentes      | 621 Malmin seurakunta                 | Mikkinentes   | -                                    |\n| 240126A9056 | Uotilates        | 651 Helsingin ortodoksinen seurakunta | Uotilates     | -                                    |\n| 020226A900M | Ulkomaalainentes | -                                     | Salmelates    | 621 Malmin seurakunta                |\n| 020226A901N | Moilanentes      | 651 Helsingin ortodoksinen seurakunta | Italiates     | -                                    |\n"},{"name":"Edunvalvonta","description":"\n## Edunvalvonnan rajapintojen virhekoodit\n\n| Virhekoodi REST-rajapinnassa  | Kuvaus |\n| ----------------------------  | ------ |\n| AH033                         | Pyynnössä annetussa ulkohenkilön etu- tai sukunimessä on kiellettyjä merkkejä. |\n| AT001                         | Alkupäivä on tulevaisuudessa. |\n| AT010                         | Loppupäivän tulee olla alkupäivän jälkeen. |\n| AT208                         | Nimessä on pelkkiä isoja kirjaimia tai peräkkäisiä isoja kirjaimia. |\n| BH002                         | Ulkohenkilö on alle 14-vuotias. |\n| BH148                         | Edunvalvoja on annettu useampaan kertaan. |\n| CH027                         | Päähenkilöltä ei löydy voimassaolevaa edunvalvontaa / valtuutusta. |\n| CH127                         | Pyynnössä annetulla henkilötunnuksella ei löydy henkilöä VTJ:stä. |\n| CH128                         | Pyynnössä annettu henkilötunnus on passivoitu. |\n| CH129                         | Pyynnössä annettu henkilö on kuollut annetulla alkupäivällä. |\n| CH435                         | Lisättävä valvoja / valtuutettu löytyy jo päähenkilöltä. |\n| CH487                         | Päivitettävää valvojaa / valtuutettua ei löydy. |\n| CH638                         | Sama edunvalvoja / valtuutettu löytyy jo kerran joko valtuutettuna tai edunvalvojana. |\n| CT901                         | Pyynnössä annettua viranomaista (oikeusaputoimisto) ei löydy VTJ:stä. |\n| CT931                         | Pyynnössä annettu viranomainen (oikeusaputoimisto) ei ole voimassaoleva. |\n| CH492                         | Henkilöllä on jo olemassa edunvalvonta / valtuutus, joka on päällekkäinen pyynnössä annetun aikavälin kanssa. |\n| EV003                         | Edunvalvojan/valtuutetun alkupäivä ei saa olla alkaisemmin kuin edunvalvonnan/valtuutuksen alkupäivä. |\n| EV004                         | Pyynnössä annettua y-tunnusta ei löydy VTJ:stä tai se ei ole voimassa pyynnössä annettuna alkupäivänä. |\n| EV005                         | Edunvalvojan/valtuutetun loppupäivä ei saa olla myöhemmin kuin edunvalvonnan/valtuutuksen loppupäivä. |\n| EV006                         | Alle 18-vuotiaan edunvalvonta / valtuutus pitää loppua viimeistään 18-vuotis syntymäpäivänä. |\n| EV007                         | Päähenkilöltä löytyy useampi kuin yksi voimassaoleva edunvalvonta / valtuutus. |\n| EV008                         | Alkupäivämäärä eroaa VTJ:n tiedoista. |\n| EV009                         | Edunvalvoja / valtuutettu ei saa olla valvottava. |\n| EV010                         | Päivitettävä tieto on sama kuin olemassa oleva tieto VTJ:ssä. |\n"},{"name":"Erot","description":"\n## Eron rajapintojen virhekoodit\n\n| Virhekoodi REST-rajapinnassa | Kuvaus                                                       |\n| ---------------------------- | ------------------------------------------------------------ |\n| AT001                        | Päivämäärä tulevaisuudessa                                   |\n| CH001                        | Avioliittotiedot ristiriidassa                               |\n| CH002                        | Avioliiton purkupäivän on oltava vihkipäivää myöhäisempi     |\n| CH127                        | Henkilö puuttuu VTJ:stä                                      |\n| CH128                        | Henkilötunnus on passiivi                                    |\n| CH335                        | Siviilisäädyn on oltava avioliitossa                         |\n| CH474                        | Henkilö ei ole rekisteröidyssä parisuhteessa rekisterissä    |\n| CH476                        | Siviilisäädyn on oltava rekisteröidyssä parisuhteessa        |\n| CH477                        | Rekisteröintipäivä/purkautumispäiväristiriita                |\n| UE001                        | Henkilöllä useampi ulkohenkilöpuoliso identtisillä tiedoilla |\n| UR002                        | Ulkohenkilöä ei löydy annetuilla tiedoilla                   |\n\n\n## Avioerojen testitapauksia\n\n| Puoliso A   | Puoliso B                                       |\n| -------     | -------                                         |\n| 180889-9013 | 121290-900N                                     |\n| 191090-901L | 130300A900U                                     |\n| 201192-901K | 040596-900D                                     |\n| 111193-9011 | 020292-901P                                     |\n| 020111A9032 | 120111A900D                                     |\n| 121290-901P | 120398-900F                                     |\n| 090999-901N | 060696-900H                                     |\n| 060987-901M | 200197-900S                                     |\n| 300390-9012 | 060786-900R                                     |\n| 050679-901H | Edwardsson, Inna Tes (nainen, synt. 10.10.1979) |\n| 170790-900V | Jörn, Anderson Test (mies, synt. 10.10.1990)    |\n\n## Rekpa-erojen testitapauksia\n\n| Puoliso A   | Puoliso B   |\n| -------     | -------     |\n| 040265-9985 | 040779-998T |\n"},{"name":"Uskontokunta","description":"\n## Uskontokunnan rekisteröinnin virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| AH004      | Tarkista henkilötunnus. |\n| AT001      | Alkamispäivä ei saa olla tulevaisuudessa. |\n| CA033      | Seurakunta ei ole sallittu henkilön nykyisessä asuinpaikassa. |\n| CH127      | Henkilö puuttuu VTJ:stä. |\n| CH128      | Henkilön henkilötunnus on passivoitu. |\n| CH129      | Henkilö on kuollut. |\n| CH299      | Henkilö poistettu rekisteristä. |\n| CH372      | Henkilöllä ei saa olla voimassaoleva jäsenyys samassa uskontokunnassa, johon hän liittyy. |\n| CH456      | Henkilö on jo annetun uskontokunnan jäsen ja päättymispäivä on annetun alkamispäivän jälkeen. |\n| CH624      | Jos henkilölle lisätään uusi jäsenyys, on edellisen voimassaolevan seurakunnan alkupäivän oltava aikaisempi kuin uuden alkamispäivä.  |\n| CT901      | Pyynnössä annettua viranomaista tai seurakuntaa ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen tai seurakunta ei ole voimassaoleva. |\n\n## Uskontokunnan reskisteröinnin testitapauksia\n\n| Henkilötunnus | Nykyinen uskontokunta ja sen alkupäivä             | Mahdolliset uudet uskontokunnat |\n| -------       | -------                                            | -------                         |\n| 060696-901J   | Vaasan suomalainen seurakunta (474), 10.10.2010    | Vasa svenska församling (556), Vaasan ortodoksinen seurakunta (673) |\n| 140459-901J   | Töölön seurakunta (632), 15.6.1999                 | Helsingin ortodoksinen seurakunta (651), Lukas församling (590), Paavalin seurakunta (626) |\n| 010100A9204   | Borgå svenska domkyrkoförsamling (485), 12.10.2024 | Porvoon suomalainen seurakunta (25), Helsingin ortodoksinen seurakunta (651) |\n| 180601A901S   | Borgå svenska domkyrkoförsamling (485), 1.12.2004  | Porvoon suomalainen seurakunta (25), Helsingin ortodoksinen seurakunta (651), Suomen saksalainen evankelis-luterilainen seurakunta (562) |\n| 050570-901C   | Helsingin ortodoksinen seurakunta (651), 5.5.1970  | Lukas församling (590), Paavalin seurakunta (626) |\n| 090273-901A   | Helsingin ortodoksinen seurakunta (651), 1.1.2000  | Helsingin ev.lut seurakunnat koodeilla 611-636 |\n| 171289-901N   | Oulun ortodoksinen seurakunta (667), 17.12.1989    | Tuiran seurakunta (600), Karjasillan seurakunta (601), Oulun tuomiokirkkoseurakunta (602), Oulujoen seurakunta (603) |\n| 050595-900T   | Varkauden ortodoksinen seurakunta (674), 5.5.1995  | Varkauden seurakunta (410) |\n| 011073-998R   | Suomen Helluntaikirkko (857), 1.1.1990             | Varkauden seurakunta (410) |\n| 010190-931P   | Redeem Christian Church of God (915), 1.1.2015     | Varkauden seurakunta (410), Varkauden ortodoksinen seurakunta (674) |\n| 120298-901P   | -                                                  | Helsingin ortodoksinen seurakunta (651), Lukas församling (590), Paavalin seurakunta (626) |\n| 100970-901U   | -                                                  | Helsingin ortodoksinen seurakunta (651), Lukas församling (590), Paavalin seurakunta (626) |\n| 120298-901P   | -                                                  | Helsingin ortodoksinen seurakunta (651), Lukas församling (590), Paavalin seurakunta (626) |\n| 010100A915Y   | -                                                  | Helsingin ortodoksinen seurakunta (651), Lukas församling (590), Paavalin seurakunta (626) |\n| 050560-901T   | Anglikaaninen kirkko (801), 1.1.1980               | Vaasan suomalainen seurakunta (474), Vasa svenska församling (556), Vaasan ortodoksinen seurakunta (673) |\n"},{"name":"Satu","description":"\n## Satun aktivoinnin virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| CH127      | Henkilö puuttuu VTJ:stä. |\n| CH128      | Henkilön henkilötunnus on passivoitu. |\n| CH129      | Henkilö on kuollut. |\n| CT901      | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n| ST001      | Henkilötunnuksella ei löydy asiointitunnusta. |\n| CH482      | Henkilötunnuksen asiointitunnus on jo aktivoitu. |\n\n## Satun aktivoinnin testitapauksia\n\n| Henkilötunnus | Huomioita                      |\n| -------       | -------                        |\n| 140459-901J   |                                |\n| 180601A901S   |                                |\n| 050570-901C   |                                |\n| 171289-901N   |                                |\n| 090273-901A   |                                |\n| 060696-901J   |                                |\n| 010190-931P   |                                |\n| 120298-901P   |                                |\n| 010138-9009   | Henkilö kuollut                |\n| 050734-998U   | Asiointitunnus on jo aktivoitu |\n| 070180-9033   | Asiointitunnus on jo aktivoitu |\n| 050595-900T   | Asiointitunnus on jo aktivoitu |\n| 010118-9989   | Asiointitunnus on jo aktivoitu |\n| 010170-960F   | Asiointitunnus on jo aktivoitu |\n| 020365-998N   | Asiointitunnus on jo aktivoitu |\n"},{"name":"Oleskelu","description":"\n## Oleskelurajapintojen virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| CH127      | Henkilö puuttuu VTJ:stä. |\n| CH128      | Henkilön henkilötunnus on passivoitu. |\n| CH129      | Henkilön on kuollut. |\n| CT901      | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n\n## Oleskelun testitapauksia\n\nTulossa\n"},{"name":"Nimenmuutos","description":"\n## Nimenmuutoksenrajapintojen virhekoodit\n\n| Virhekoodi | Kuvaus                  |\n| -------    | ------                  |\n| CH127      | Henkilö puuttuu VTJ:stä. |\n| CH128      | Henkilön henkilötunnus on passivoitu. |\n| CH129      | Henkilön on kuollut. |\n| CH136      | Henkilöltä puuttuu VTJ:stä sukunimi tai etunimi. |\n| CH138      | Muutettava nimi on sama kuin nykyinen nimi. |\n| AH033       | Nimi sisältää kiellettyjä merkkejä. |\n| UA243      | Nimi ei saa alkaa välilyönnillä, päättyä välilyöntiin tai sisältää peräkkäisiä välilyöntejä. |\n| UA244      | Nimi ei saa koostua pelkistä väli- tai erikoismerkeistä. |\n| AT208      | Nimessä peräkkäisiä isoja kirjaimia. |\n| CT901      | Pyynnössä annettua viranomaista ei löydy VTJ:stä. |\n| CT931      | Pyynnössä annettu viranomainen ei ole voimassaoleva. |\n\n## Nimenmuutoksen testitapauksia\n\nTulossa\n"}]}