ZignSec

LookupPerson -se -dk

LookupPerson service looks up the address data for residents existing in the national population register by countrycode and a national identitynumber. 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 blank is for active residents, but can in Sweden also be set to:

  • Deceased – a deceased person will show this status for a “limited period”.
  • Protected – a person with protected identy
  • Emigrated – a emigrated person will show this status for a “limited period”.
  • DeRegistered – internal deletion code
  • Unknown 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 these cases all other address fields are blanked out.

Note: Since Oct 26th, eID Logins can be setup to automatically fetch address data. (currently Swedish BankID and BankingAPI) РSetting LookupPersonAddress to true in an eID will automatically do a address lookup in the population register using the verified personalnumber that internally uses the LookupPerson API.

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 TestSeLookupPerson.

Parameters

CountryCode Mandatory parameter. Sets the country to query in.
IdentityNumber Optional parameter. The national identity number of the person searched for, in the correct format.
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 identity 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",
   "IdentityNumber":"197001102222"
}
        

Response fields

See Common data structures

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"
  }
}