PRC REST API

Basic plus pACKAGE

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

Data for testing »

API endpoints

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

API response

Data elementDescription
socialSecurityNumber Social Security Number. e.g. "071259-999M".
bisnodeId Return BisnodeId if exist. e.g. "FI2101006369104" or "null".
dateOfBirth Person's date of birth e.g. "1959-12-07T00:00:00Z".
allAddresses List of all person's addresses. Includes the following elements:addressPriorityType.e.g. "Temporary",addressFormatType.e.g. "Domestic",streetAddress.e.g."Kurteninkatu 13 H 48", postCode.e.g."65100",postOffice.e.g."VAASA", countryCode.e.g."FI",countryNumber.e.g.246,countryName.e.g."null",addressMunicipalityCode.e.g."null",addressMunicipalityName.e.g."null", additionalAddressRow.e.g."null",dateOfAddress.e.g."2007-02-12T00:00:00Z",startDate.e.g."2007-02-12T00:00:00Z",endDate.e.g."2000-03-28T00:00:00Z".
lastName Person's last name. e.g. "Casimirsson".
firstName Person's last name. e.g. "Dmitri Jonatan".
gender Person's gender e.g. "F" or "M".
languageCode Person's language. e.g. "fi".
yearOfBirth Person's birth year. e.g. 1959.
isDead If person is dead. e.g. "true" or "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".

API request parameters

ParameterDescription 
id

Social security number or BisnodeId

M
reference    

 

API request and response example: with socialSecurityNumber.

curl -X GET ’https://api-test.bisnode.fi/people/info/v2/person-BasicPlus?id=071259-999M&=' -H ‘x-api-key: 1234567890ABC’

Successful request and the API return results in JSON form

{
  "data": {
    "bisnodeId": "FI2101006369104",
    "socialSecurityNumber": "071259-999M",
    "dateOfBirth": "1959-12-07T00:00:00Z",
    "allAddresses": [
      {
        "addressPriorityType": "Permanent",
        "addressFormatType": "Domestic",
        "streetAddress": "Sepänkatu 11 A 1",
        "postCode": "70100",
        "postOffice": "KUOPIO",
        "countryCode": "FI",
        "countryNumber": 246,
        "countryName": null,
        "addressMunicipalityCode": null,
        "addressMunicipalityName": null,
        "additionalAddressRow": null,
        "dateOfAddress": "2001-01-01T00:00:00Z",
        "startDate": "2001-01-01T00:00:00Z",
        "endDate": null
      },
      {
        "addressPriorityType": "Temporary",
        "addressFormatType": "Domestic",
        "streetAddress": "Kurteninkatu 13 H 48",
        "postCode": "65100",
        "postOffice": "VAASA",
        "countryCode": "FI",
        "countryNumber": 246,
        "countryName": null,
        "addressMunicipalityCode": null,
        "addressMunicipalityName": null,
        "additionalAddressRow": null,
        "dateOfAddress": "2007-02-12T00:00:00Z",
        "startDate": "2007-02-12T00:00:00Z",
        "endDate": null
      },
      {
        "addressPriorityType": "Temporary",
        "addressFormatType": "Domestic",
        "streetAddress": "Siskontie 4 Usva as 7b",
        "postCode": "66400",
        "postOffice": "LAIHIA",
        "countryCode": "FI",
        "countryNumber": 246,
        "countryName": null,
        "addressMunicipalityCode": null,
        "addressMunicipalityName": null,
        "additionalAddressRow": null,
        "dateOfAddress": "2007-01-01T00:00:00Z",
        "startDate": "2007-01-01T00:00:00Z",
        "endDate": null
      },
      {
        "addressPriorityType": "Temporary",
        "addressFormatType": "Domestic",
        "streetAddress": "Sammatintie 6 M 136",
        "postCode": "00550",
        "postOffice": "HELSINKI",
        "countryCode": "FI",
        "countryNumber": 246,
        "countryName": null,
        "addressMunicipalityCode": null,
        "addressMunicipalityName": null,
        "additionalAddressRow": null,
        "dateOfAddress": "2005-01-01T00:00:00Z",
        "startDate": "2005-01-01T00:00:00Z",
        "endDate": null
      },
      {
        "addressPriorityType": "Temporary",
        "addressFormatType": "Domestic",
        "streetAddress": "Haukankuja 1 G 28",
        "postCode": "78850",
        "postOffice": "VARKAUS",
        "countryCode": "FI",
        "countryNumber": 246,
        "countryName": null,
        "addressMunicipalityCode": null,
        "addressMunicipalityName": null,
        "additionalAddressRow": null,
        "dateOfAddress": "2004-01-01T00:00:00Z",
        "startDate": "2004-01-01T00:00:00Z",
        "endDate": null
      },
      {
        "addressPriorityType": "Primary",
        "addressFormatType": "Domestic",
        "streetAddress": "Poste Restante",
        "postCode": "00530",
        "postOffice": "HELSINKI",
        "countryCode": "FI",
        "countryNumber": 246,
        "countryName": null,
        "addressMunicipalityCode": null,
        "addressMunicipalityName": null,
        "additionalAddressRow": null,
        "dateOfAddress": "2001-08-15T00:00:00Z",
        "startDate": "2001-08-15T00:00:00Z",
        "endDate": null
      }
    ],
    "lastName": "Casimirsson",
    "firstName": "Dmitri Jonatan",
    "gender": "M",
    "languageCode": "fi",
    "yearOfBirth": 1959,
    "dateOfDeath": null,
    "dateOfDeclarationOfDeath": null,
    "isDead": false,
    "movedToFinland": null,
    "homeMunicipality": null,
    "placeOfBirth": null,
    "nameHistory": null,
    "usaConnections": null,
    "hasGuardianship": null,
    "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
    },
    {
      "code": "Prc_DateMappingWarning",
      "message": "A field had datatime value that was not possible format using ISO-8601 full datetime format. See field name and original value from context object array.",
      "context": [
        "DateOfAddress",
        "20010000"
      ]
    },
    {
      "code": "Prc_DateMappingWarning",
      "message": "A field had datatime value that was not possible format using ISO-8601 full datetime format. See field name and original value from context object array.",
      "context": [
        "StartDate",
        "20010000"
      ]
    }
  ],
  "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",
        "IsDead",
        "LanguageCode",
        "LastName",
        "SocialSecurityNumber",
        "YearOfBirth"
      ]
    },
    {
      "datasourceType": "Bisnode",
      "fields": [
        "AllAddresses.CountryCode",
        "BisnodeId"
      ]
    }
  ],
  "isDataFound": true
}