People Monitoring REST
People Register Monitor
With People Register Monitor service you are able to keep your customer register up to date.
Monitoring service consists of two PRC packages: Basic and Extended, depending on the range of information needed to update. The contents of the two packages are described in section PRC DATA AVAILABLE FOR MONITORING.
Monitoring service also contains data elements, and those are described in sections CONSUMERS REMARKS and CONSUMERS PREDICTIONS.
PRC data available for monitoring
| Element | Description | |
|---|---|---|
| FirstNames | First names. Type: string. Source: PRC/VRK | B,E |
| LastName | Surname. Type: string. Source: PRC/VRK | B,E |
| PermanentAddr_AddressType | Type of permanent address. Type: Enum. Options: Domestic, Foreign, null. Source: PRC/VRK | B,E |
| PermanentAddr_StartDate | Last moving day of permanent address. Type: DateTime (ISO 8601). Source: PRC/VRK | B,E |
| PermanentAddr_StreetAddress | Permanent address. Type: string. Source: PRC/VRK | B,E |
| PermanentAddr_PostCode | Post code of permanent address. Type: string, localized. Source: PRC/VRK | B,E |
| PermanentAddr_PostOffice | Post office of permanent address. Type: string. Source: PRC/VRK | B,E |
| PermanentAddr_MunicipalityCode | Municipality code of permanent address. Type: string, localized. Source: PRC/VRK | B,E |
| PermanentAddr_MunicipalityName | Municipality name of permanent address. Type: string. Source: PRC/VRK | B,E |
| PermanentAddr_CountryCode_ISO3165_Numeric | Country code of permanent address. Type: string, localized. Source: PRC/VRK | B,E |
| PermanentAddr_CountryName | Country name of permanent address. Type: string. Source: PRC/VRK | B,E |
| DateOfDeath | Date of death. Type: DateTime. Source: PRC/VRK | B,E |
| LanguageGroup | Language code. Type: integer. Options: 1=Finnish, 2=Nordic, 3=Other, null=N/A. Source: PRC/VRK |
B,E |
IsUnderAged |
Underage information. Type: bool. Source: PRC/VRK | B,E |
| Gender | Gender. Note: Requires special permission from PRC. Type: Enum. Options: 1=Male, 2=Female. Source: PRC/VRK |
B,E |
| SocialSecurityNumber | Finnish social security number. Note: Requires special permission from PRC. Type: string. Source: PRC/VRK |
B,E |
| PermanentAddr_HouseholdId | HouseholdID of permanent address. Type: string. Source: PRC/VRK | E |
| TemporaryAddr_AddressType | Address type of temporary address. Type: string. Source: PRC/VRK | E |
| TemporaryAddr_StartDate | Start date of temporary address. Type: DateTime. Source: PRC/VRK | E |
| TemporaryAddr_EndDate | End date of temporary address. Type: DateTime. Source: PRC/VRK | E |
| TemporaryAddr_StreedAddress | Temporary address. Type: string, localized. Source: PRC/VRK | E |
| TemporaryAddr_PostCode | Post code of temporary address. Type: string. Source: PRC/VRK | E |
| TemporaryAddr_PostOffices | Post office of temporary address. Type: string, localized. Source: PRC/VRK | E |
| TemporaryAddr_MunicipalityCode | Municipality code of temporary address. Type: string. Source: PRC/VRK | E |
| TemporaryAddr_MunicipalityName | Municipality name of temporary address. Type: string, localized. Source: PRC/VRK | E |
| TemporaryAddr_CountryCode_ISO3165_Numeric | Country code of temporary address. Type: numeric string. Source: PRC/VRK | E |
| TemporaryAddr_CountryName | Country name of temporary address. Type: string. Source: PRC/VRK | E |
| TemporaryAddr_HouseholdId | HouseholdID of temporary address. Type: string. Source: PRC/VRK | E |
| PostAddr_AddressType | Address type of preferred postal address. Type: string. Source: PRC/VRK | E |
| PostAddr_StartDate | Start date of preferred postal address. Type: DateTime. Source: PRC/VRK | E |
| PostAddr_EndDate | End date of preferred postal address. Type: DateTime. Source: PRC/VRK | E |
| PostAddr_StreetAddress | Postal address. Type: string, localized. Source: PRC/VRK | E |
| PostAddr_PostCode | Post code of preferred postal address. Type: string. Source: PRC/VRK | E |
| PostAddr_PostOffice | Post office of preferred postal address. Type: string, localized. Source: PRC/VRK | E |
| PostAddr_CountryCode_ISO3165_Numeric | Country code of preferred postal address. ISO 3165 3 digit zero padded number. Type: numeric string. Source: PRC/VRK | E |
| PostAddr_CountryName | Country name of preferred postal address in English. Type: string. Source: PRC/VRK | E |
| B = Basic package, E = Extended package. NOTE: All data is provided in lowercase. | ||
Consumers remarks
| Data element | Description |
|---|---|
| Remark ID | Remark ID. e.g. 14601863 |
| Amount | Amount of euros (€). e.g. 100 |
| Case ID | Case ID. e.g. 2014/123456 |
| Additional info | Other info. e.g. null |
| Creditor | Creditor. e.g. Länsi-Suomen veronkanto- ja perintäyksikkö |
| Remark source | Source of the remark. e.g. Ulosottovirasto |
| Remark code | Remark code. e.g. UMV |
| Case type code | Case type code. e.g. MUU |
| Remark type | Type of the remark. e.g. PaymentRemark |
| Remark date | Date of the remark. e.g. 2014-07-15T00:00:00Z |
| Remark paid date | Remard paid date. e.g. null |
| Remark valid to date | Date of the remark valid to date. e.g. 2018-07-15T00:00:00Z |
| Remark expires date | Date of the remark expires date. e.g. 2018-07-15T00:00:00Z |
| Incident Id | Incident ID. e.g. null |
Consumers predictions
| Element | Description |
|---|---|
| personincome | Estimated ordinary income (personal) is shown in classes 1-10. Class 1: less than 15 287 €/year. Class 10: over 42 263 €/year. |
| householdincome | Estimated ordinary income (household) is shown in classes 1-10. Class 1: less than 18 061 €/year. Class 10: over 78 286 €/year. |
| personincomefromcapital | Estimated capital gains (personal) are shown in classes 1-10. Class 1: less than 144 €/year. Class 10: over 3 095 €/year. |
| householdincomefromcapital | Estimated capital gains (household) are shown in classes 1-10. Class 1: less than 271 €/year. Class 10: over 4 296 €/year. |
| persondebt | Estimated debts (personal) are shown in classes 1-10. Class 1: less than 3 332 €. Class 10: over 54 729 €. |
| householddebt | Estimated debts (household) are shown in classes 1-10. Class 1: less than 4 025 €. Class 10: over 93 169 €. |
| familywithchildren | Under 18-year-old minors live in this household are shown in classes 1-10. Class 1: no. Class 10: yes. |
| familywithchildrenunder10 | Under 10 years old minors live in this household are shown in classes 1-10. Class 1: no. Class 10: yes. |
| familywithchildren10to17 | Over 10 years old minors live in this household are shown in classes 1-10. Class 1: no. Class 10: yes. |
| carownership | Estimation if the person owns a car. Estimation is shown in classes 1-10. Class 1: does not own a car, Class 10: does own a car. |
Phonenumbers
| Element | Description |
|---|---|
| phonenumber | Phonenumber of consumer. |
| isdefault | Consumers default number, boolean. |
Guardianship
| Element | Description |
|---|---|
| person_subject_to_guardianship_startdate | |
| person_subject_to_guardianship_enddate | |
| person_subject_to_guardianship_div | |
| person_subject_to_guardianship_restriction | |
| guardian_legalid | |
| guardian_company | |
| guardian_localcouncil | |
| guardian_startdate | |
| guardian_enddate |