Population Register Centre Rest API

Custody package

Package contains person's custody information like child's guardians information.

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-Custody - production environment
  • https://api-test.bisnode.fi/people/info/v2/person-Custody - test environment

API response

Data elementDescription
socialSecurityNumber Social Security Number. e.g. "020501A999T".
bisnodeId Return BisnodeId if exist. e.g. "FI2101005066333" or "null".
dateOfBirth Person's date of birth. e.g. "2001-05-02T00:00:00Z".
lastName Person's last name. e.g. "Jäppinen".
firstName Person's last name. e.g. "Albert Kristian".
gender Person's gender. e.g. "F" or "M".
childsGuardians Includes list of child all guardians with the following elements: socialSecurityNumber. e.g. "181269-999A", dateOfBirth. e.g. "1969-12-18T00:00:00Z", familyName. e.g."Jäppinen" "Jäppinen", firtsName. e.g."Tobias Kristian", shareCode. e.g. "null"
warnings Includes the following elements: code e.g. "Prc_Disclaimer" or "Unexpected", 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".
datasourceType Contains request parameters that are in request body.
isDataFound Returns boolean value: "true" or "false".

API request parameters

ParameterDescription 
id

Social security number or BisnodeId

M
reference    

 

API request and response example: 

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

Successful request and the API return results in JSON form

{
  "data": {
    "bisnodeId": null,
    "socialSecurityNumber": "020501A999T",
    "dateOfBirth": "2001-05-02T00:00:00Z",
    "allAddresses": [],
    "lastName": "Jäppinen",
    "firstName": "Albert Kristian",
    "gender": "M",
    "languageCode": null,
    "yearOfBirth": 2001,
    "dateOfDeath": null,
    "dateOfDeclarationOfDeath": null,
    "isDead": false,
    "movedToFinland": null,
    "homeMunicipality": null,
    "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": [
      {
        "socialSecurityNumber": "181269-999A",
        "dateOfBirth": "1969-12-18T00:00:00Z",
        "familyName": "Jäppinen",
        "firstName": "Tobias Kristian",
        "shareCode": null
      },
      {
        "socialSecurityNumber": "190572-9982",
        "dateOfBirth": "1972-05-19T00:00:00Z",
        "familyName": "Tolonen",
        "firstName": "Helmi Liina Kukka-Maaria",
        "shareCode": null
      },
      {
        "socialSecurityNumber": "160162-9968",
        "dateOfBirth": "1962-01-16T00:00:00Z",
        "familyName": "Tuulispää",
        "firstName": "Kanerva",
        "shareCode": 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",
        "ChildsGuardians.DateOfBirth",
        "ChildsGuardians.FamilyName",
        "ChildsGuardians.FirstName",
        "ChildsGuardians.ShareCode",
        "ChildsGuardians.SocialSecurityNumber",
        "DateOfBirth",
        "DateOfDeath",
        "DateOfDeclarationOfDeath",
        "FirstName",
        "Gender",
        "HasGuardianship",
        "IsDead",
        "IsRequestedSocialSecurityNumberPassivated",
        "LanguageCode",
        "LastName",
        "SocialSecurityNumber",
        "YearOfBirth"
      ]
    }
  ],
  "isDataFound": true
}