Population Register Centre Rest API

Lender package

Use of API requires a permission issued by Population Register Centre.

In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY (it's called a ticket) by using the ticket API (Please, read how to use ticket API).

The API KEY must be sent in the request custom header element (named ticket or x-api-key). If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS.

Request the username and password

SWAGGER - Developer REST API documentation - read more »

Population Register Centre test cases - read more »

API endpoints

https://api.bisnode.fi/people/info/v2/person-Lender - production environment
https://api-test.bisnode.fi/people/info/v2/person-Lender - test environment

API response

Data element	Description
socialSecurityNumber	Social Security Number. e.g. "160162-9968".
bisnodeId	Return BisnodeId if exist. e.g. "FI2101006369103".
dateOfBirth	Person's date of birth e.g. "1962-01-16T00:00:00Z".
allAddresses	List of all person's addresses. Includes the following elements:addressPriorityType,addressFormatType,streetAddress,postCode,postOffice, countryCode,countryNumber,countryName,addressMunicipalityCode,addressMunicipalityName, additionalAddressRow,dateOfAddress,startDate,endDate.
lastName	Person's last name. e.g. "Tuulispää".
firstName	Person's last name. e.g. "Kanerva".
gender	Person's gender. e.g. "F" or "M".
languageCode	Person's language. e.g. "fi".
yearOfBirth	Person's birth year. e.g. 1962.
isDead	If person is dead. e.g. "true" or "false".
homeMunicipality	Includes the following elements: startedAt. e.g. "1993-09-18T00:00:00Z", homeMunicipalityType. e.g. "Domestic", Code. e.g. 905, Name. e.g. "Vaasa".
nameHistory	Returns data for name history. Includes following elements: type. e.g. "LastName", isLastNameBeforeMarriage. e.g. "false" or "true", isCorrection. e.g. "false" or "true", name. e.g. "Kingston".
hasGuardianship	Has guardianship. e.g. if has guardianship then "true" otherwise "false".
guardianshipDetails	Includes the following elements: CompanyAndCorporateGuardians(BusinessId,EndDate,Name,StartDate), ContainsRuleForTaskSharing, EndDate,LegalAidOfficeGuardians(Code,EndDate,Name,StartDate), PersonGuardians(DateOfBirth, EndDate,FirtName,LastName,SocialSecurityNumber,StartDate), RestrictionCode, RestrictionText, RuleForTaskSharing, StartDate.
maritalStatus	Person's marital status. e.g. "Divorced".
warnings	Includes the following elements: code e.g. "Prc_Disclaimer", message e.g. "Package may lack addresses and other data elements because of protected identity, missing information in PRC database, or limitations relating contract or law", context e.g. "null".
dataSources	Contains elements: datasourceType e.g. "Prc" and list of fields: "AllAddresses.AddressFormatType", "AllAddresses.AddressPriorityType", "AllAddresses.CountryName", "AllAddresses.CountryNumber", "AllAddresses.DateOfAddress", "AllAddresses.EndDate", "AllAddresses.PostCode", "AllAddresses.PostOffice", "AllAddresses.StartDate", "AllAddresses.StreetAddress", "DateOfBirth", "DateOfDeath", "DateOfDeclarationOfDeath", "FirstName", "Gender", "HomeMunicipality.Code", "HomeMunicipality.HomeMunicipalityType", "HomeMunicipality.Name", "HomeMunicipality.StartedAt", "IsDead", "LanguageCode", "LastName", "SocialSecurityNumber", "YearOfBirth".
datasourceType	Type of datasource. e.g. "Bisnode", "Prc".
fields	Fields elements contains all Prc and Bisnode data parameters.
isDataFound	If data is found then "true" otherwise "false".

API request parameters

Parameter	Description
id	Social security number or BisnodeId	_M
reference
M = Mandatory

API request and response example: with socialSecurityNumber.

curl -X GET ’https://api-test.bisnode.fi/people/info/v2/person-Lender?id=021081-998E&=' -H ‘x-api-key: 1234567890ABC’

Successful request and the API return results in JSON form

{
"data": {
"bisnodeId": null,
"socialSecurityNumber": "021081-998E",
"dateOfBirth": "1981-10-02T00:00:00Z",
"allAddresses": [
{
"addressPriorityType": "Permanent",
"addressFormatType": "Domestic",
"streetAddress": "Mäkikaivontie 12 C 039",
"postCode": "65100",
"postOffice": "VAASA",
"countryCode": "FI",
"countryNumber": 246,
"countryName": null,
"addressMunicipalityCode": null,
"addressMunicipalityName": null,
"additionalAddressRow": null,
"dateOfAddress": "1981-10-02T00:00:00Z",
"startDate": "1981-10-02T00:00:00Z",
"endDate": null
}
],
"lastName": "Karttunen",
"firstName": "Alli Kukka-Maaria",
"gender": "F",
"languageCode": "fi",
"yearOfBirth": 1981,
"dateOfDeath": null,
"dateOfDeclarationOfDeath": null,
"isDead": false,
"movedToFinland": null,
"homeMunicipality": {
"startedAt": "1981-10-02T00:00:00Z",
"homeMunicipalityType": "Domestic",
"code": 905,
"name": "Vaasa"
},
"placeOfBirth": null,
"nameHistory": [
{
"type": "Unknown",
"isLastNameBeforeMarriage": null,
"isCorrection": null,
"name": ""
}
],
"usaConnections": null,
"hasGuardianship": true,
"guardianshipDetails": {
"containsRuleForTaskSharing": false,
"restrictionCode": "NotRestricted",
"startDate": "2009-02-10T00:00:00Z",
"endDate": null,
"personGuardians": [
{
"socialSecurityNumber": "",
"dateOfBirth": null,
"firstName": "",
"lastName": "",
"startDate": null,
"endDate": null
}
],
"companyAndCorporateGuardians": [
{
"businessId": "",
"name": "",
"startDate": null,
"endDate": null
}
],
"municipalityGuardians": [],
"legalAidOfficeGuardians": [
{
"code": "000374",
"name": "Espoon oikeusaputoimisto",
"startDate": "2009-02-10T00:00:00Z",
"endDate": null
}
]
},
"maritalStatus": "InRegisteredPartnership",
"previousKnownMaritalStatus": null,
"continuingPowerOfAttorney": null,
"ownershipInfo": null,
"nationalities": null,
"dependentCount": null,
"livingConditions": null,
"childsGuardians": null
},
"warnings": [
{
"code": "Prc_Disclaimer",
"message": "Package may lack addresses and other data elements because of protected identity, missing information in PRC database, or limitations relating contract or law",
"context": null
}
],
"dataSources": [
{
"datasourceType": "Prc",
"fields": [
"AllAddresses.AddressFormatType",
"AllAddresses.AddressPriorityType",
"AllAddresses.CountryName",
"AllAddresses.CountryNumber",
"AllAddresses.DateOfAddress",
"AllAddresses.EndDate",
"AllAddresses.PostCode",
"AllAddresses.PostOffice",
"AllAddresses.StartDate",
"AllAddresses.StreetAddress",
"DateOfBirth",
"DateOfDeath",
"DateOfDeclarationOfDeath",
"FirstName",
"Gender",
"GuardianshipDetails.CompanyAndCorporateGuardians.BusinessId",
"GuardianshipDetails.CompanyAndCorporateGuardians.EndDate",
"GuardianshipDetails.CompanyAndCorporateGuardians.Name",
"GuardianshipDetails.CompanyAndCorporateGuardians.StartDate",
"GuardianshipDetails.ContainsRuleForTaskSharing",
"GuardianshipDetails.EndDate",
"GuardianshipDetails.LegalAidOfficeGuardians.Code",
"GuardianshipDetails.LegalAidOfficeGuardians.EndDate",
"GuardianshipDetails.LegalAidOfficeGuardians.Name",
"GuardianshipDetails.LegalAidOfficeGuardians.StartDate",
"GuardianshipDetails.MunicipalityGuardians.Code",
"GuardianshipDetails.MunicipalityGuardians.EndDate",
"GuardianshipDetails.MunicipalityGuardians.Name",
"GuardianshipDetails.MunicipalityGuardians.StartDate",
"GuardianshipDetails.PersonGuardians.DateOfBirth",
"GuardianshipDetails.PersonGuardians.EndDate",
"GuardianshipDetails.PersonGuardians.FirstName",
"GuardianshipDetails.PersonGuardians.LastName",
"GuardianshipDetails.PersonGuardians.SocialSecurityNumber",
"GuardianshipDetails.PersonGuardians.StartDate",
"GuardianshipDetails.RestrictionCode",
"GuardianshipDetails.RestrictionText",
"GuardianshipDetails.RuleForTaskSharing",
"GuardianshipDetails.StartDate",
"HasGuardianship",
"HomeMunicipality.Code",
"HomeMunicipality.HomeMunicipalityType",
"HomeMunicipality.Name",
"HomeMunicipality.StartedAt",
"IsDead",
"IsRequestedSocialSecurityNumberPassivated",
"LanguageCode",
"LastName",
"MaritalStatus",
"MovedToFinland",
"NameHistory.IsCorrection",
"NameHistory.IsLastNameBeforeMarriage",
"NameHistory.Name",
"NameHistory.Type",
"PreviousKnownMaritalStatus",
"SocialSecurityNumber",
"YearOfBirth"
]
},
{
"datasourceType": "Bisnode",
"fields": [
"AllAddresses.CountryCode"
]
}
],
"isDataFound": true
}