Population Register Centre Rest API
Health Custody package
Package contains person's health custody information like child's guardians and theirs right to act on behalf of child 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.
API endpoints
- https://api.bisnode.fi/people/info/v2/person-HealthCustody - production environment
- https://api-test.bisnode.fi/people/info/v2/person-HealthCustody - test environment
API response
| Data element | Description |
|---|---|
| socialSecurityNumber | Social Security Number. e.g. "020501A999T". |
| bisnodeId | Return BisnodeId if exist. e.g. "FI2101005066333" or "null". |
| childsHealthGuardians | Includes list of child's 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", rightCode. e.g. "RightToActOnBehalf" |
| 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
| Parameter | Description | |
|---|---|---|
| id | Social security number or Bisnode Id |
M |
| reference | ||
| M = Mandatory | ||
API request and response example:
curl -X GET ’https://api-test.bisnode.fi/people/info/v2/person-HealthCustody?id=021019A950W&=' -H ‘x-api-key: 1234567890ABC’
Successful request and the API return results in JSON form
{
"data": {
"bisnodeId": "FI2101011720450",
"socialSecurityNumber": "021019A950W",
"isRequestedSocialSecurityNumberPassivated": false,
"dateOfBirth": "2019-10-02T00:00:00Z",
"allAddresses": [],
"lastName": null,
"firstName": null,
"gender": "F",
"languageCode": null,
"yearOfBirth": 2019,
"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,
"childsHealthGuardians": [
{
"socialSecurityNumber": "220488-999B",
"dateOfBirth": "1988-04-22T00:00:00Z",
"familyName": "Haapakoski",
"firstName": "Cristian Aleksanteri",
"rightCode": "RightToActOnBehalf"
},
{
"socialSecurityNumber": "170288-998F",
"dateOfBirth": "1988-02-17T00:00:00Z",
"familyName": "Korpinen",
"firstName": "Meiju Kukka-Maaria",
"rightCode": "RightToActOnBehalf"
}
]
},
"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
}