API endpoints
- https://api.bisnode.fi/people/info/v2/person-BasicWithGuardianship - production environment
- https://api-test.bisnode.fi/people/info/v2/person-BasicWithGuardianship - test environment
API response
Data element | Description |
---|---|
socialSecurityNumber | Social Security Number. e.g. "160264-999N". |
bisnodeId | Return BisnodeId if exist. e.g. "FI2101005066333" or "null". |
dateOfBirth | Person's date of birth e.g."1964-02-16T00:00:00Z". |
allAddresses | List of all person's addresses. Includes the following elements:addressPriorityType.e.g. "Permanent",addressFormatType.e.g. "Domestic",streetAddress.e.g. "Sepänkatu 11 A 4",postCode.e.g."70100",postOffice.e.g."KUOPIO", countryCode.e.g.246,countryNumber.e.g."FI",countryName.e.g."null",addressMunicipalityCode.e.g."null",addressMunicipalityName.e.g."null", additionalAddressRow.e.g."null",dateOfAddress.e.g."1966-06-25T00:00:00Z",startDate.e.g."1966-06-25T00:00:00Z",endDate.e.g."null". |
lastName | Person's last name. e.g. "Lepistö". |
firstName | Person's last name. e.g. "Tobias Kullervo". |
gender | Person's gender e.g. "F" or "M". |
languageCode | Person's language. e.g. "fi". |
yearOfBirth | Person's birth year. e.g. 1964. |
isDead | Returns "true" if person is dead, otherwise "false". |
homeMunicipality | Includes the following elements: startedAt. e.g. "1966-06-25T00:00:00Z", homeMunicipalityType. e.g. "Domestic", code. e.g. 297, name. e.g. "Kuopio". |
hasGuardianship | Has guardianship. e.g. if has guardianship then "true" otherwise "false". |
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-BasicWithGuardianship?id=160264-999N&=' -H 'ticket: 1234567890ABC'
Successful request and the API return results in JSON form
{ "data": { "bisnodeId": "FI2101005066333", "socialSecurityNumber": "160264-999N", "dateOfBirth": "1964-02-16T00:00:00Z", "allAddresses": [ { "addressPriorityType": "Permanent", "addressFormatType": "Domestic", "streetAddress": "Sepänkatu 11 A 4", "postCode": "70100", "postOffice": "KUOPIO", "countryCode": "FI", "countryNumber": 246, "countryName": null, "addressMunicipalityCode": null, "addressMunicipalityName": null, "additionalAddressRow": null, "dateOfAddress": "1966-06-25T00:00:00Z", "startDate": "1966-06-25T00:00:00Z", "endDate": null } ], "lastName": "Lepistö", "firstName": "Tobias Kullervo", "gender": "M", "languageCode": "fi", "yearOfBirth": 1964, "dateOfDeath": null, "dateOfDeclarationOfDeath": null, "isDead": false, "movedToFinland": null, "homeMunicipality": { "startedAt": "1966-06-25T00:00:00Z", "homeMunicipalityType": "Domestic", "code": 297, "name": "Kuopio" }, "placeOfBirth": null, "nameHistory": null, "usaConnections": null, "hasGuardianship": false, "guardianshipDetails": null, "maritalStatus": null, "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", "HomeMunicipality.Code", "HomeMunicipality.HomeMunicipalityType", "HomeMunicipality.Name", "HomeMunicipality.StartedAt", "IsDead", "IsRequestedSocialSecurityNumberPassivated", "LanguageCode", "LastName", "SocialSecurityNumber", "YearOfBirth" ] }, { "datasourceType": "Bisnode", "fields": [ "AllAddresses.CountryCode", "BisnodeId", "HasGuardianship" ] } ], "isDataFound": true }