LookupPerson service looks up the address data for residents existing in the national population register by countryCode and a national PersonalNumber. A lookup by PhoneNumber is also available. The response can be either exactly one address hit, or empty if no match was found. For found persons the return field PersonStatus indicates the status, where empty status is the default and normal value, see below table.
January 2020: Lookup from Finland’s population registry available in test environment, with these test persons.
PersonStatus:
- PersonStatus missing, “” or
Activerepresents an active person and is the normal value.) Protected– a person with protected identityEmigrated– a emigrated person will show this status for a “limited period”.Deceased– a deceased person will show this status for a “limited period”.DeRegistered– internal deletion codeUnknown status– the earlier status was most likely Deceased or Emigrated but the indication is automatically lost after the above “limited period” has elapsed, and Unknown status is shown instead.
In case of a set PersonStatus the name and address fields are blanked out.
Note: eID authentications are able to automatically include address data. (currently Swedish BankID and BankingAPI): Set parameter LookupPersonAddress to true to do an address lookup towards the population register with the authenticated PersonalNumber.
API
POST to https://env.zignsec.com/v2/ekyc/lookupperson where env is API or test.
Test Data
For the test environment these are the test persons returned: Link to Danish test persons. Link to Swedish test persons. At the moment there is no test data to lookup persons by PhoneNumber, this can only by done in production environment (API). Observe that every customer can add their test users for Swedish or Danish LookupPerson with the settings TestSeLookupPerson and TestDkLookupPerson.
Parameters
| CountryCode | Mandatory parameter. Sets the country to query in. |
| PersonalNumber | Optional parameter. The national personal number of the person searched for, in the correct format. (you can use alias IdentityNumber) |
| PhoneNumber | Optional parameter. A land line or mobile phone number. Observe that this alternative only works for Sweden. |
| Environment | Optional parameter. See Environment at the Common Data documentation. |
Request example 1: Lookup by national personal number
POST https://test.zignsec.com/v2/ekyc/lookupperson HTTP/1.1
Content-Type: application/json; charset=UTF-8
Authorization: your_key_here
{
"CountryCode":"SE",
"PersonalNumber":"197001102222"
}Response fields
Response example:
{
"id": "d352e761-45a4-465b-b290-e4d2bd65683f",
"errors": [],
"WasFound": true,
"Person":
{
"PersonStatus": "",
"MainFirstName": "Linda",
"FirstName": "Linda Marie",
"LastName": "Hassan Ahmed",
"DateOfBirth": "19700110",
"BirthYear": 1970,
"BirthMonth": 1,
"BirthDayOfMonth": 10,
"Age": 48,
"PersonalNumber": "197001102222",
"Address": "Kumlagatan 3 lgh 1205",
"Address2": null,
"PostalCode": "53392",
"Location": null,
"City": "Lundsbrunn",
"Province": null,
"CountryCode": "se",
"Phone": null,
"Email": null,
"PhoneNumbers": ["070-7001127", "070-7001130"],
"_DataSource": null,
"FullName": "Linda Marie Hassan Ahmed"
}
}Request example 2: Lookup by phone number
POST https://api.zignsec.com/v2/ekyc/lookupperson HTTP/1.1
Content-Type: application/json; charset=UTF-8
Authorization: yourkey-here.
{
"CountryCode":"se",
"phonenumber": "0859057121"
}
Response example:
{
"id": "47098ac4-a0a4-42fc-aa97-c9bc528e5f2c",
"errors": [ ],
"WasFound": true,
"Person": {
"MainFirstName": "",
"FirstName": "Per Henrik",
"LastName": "Colen",
"DateOfBirth": "19770906",
"BirthYear": 1977,
"BirthMonth": 9,
"BirthDayOfMonth": 6,
"Age": 40,
"PersonalNumber": "197709060073",
"Address": "Tunav\u00e4gen 45",
"Address2": null,
"PostalCode": "19455",
"Location": null,
"City": "Upplands V\u00e4sby",
"Province": "Upplands V\u00e4sby",
"CountryCode": "se",
"Phone": "0859057121",
"Email": null,
"PhoneNumbers": null,
"_DataSource": null,
"FullName": "Per Henrik Colen"
}
}