ZignSec

Common Data Structures

  • Address structure: Address structure format is used in many queries and responses.
  • Identity structure: Our main id data holder found in the responses from all our eIDs products.
  • Environment flag: The paramater lets you switch type of underlying provider between test and prod for a call.

Address

PersonStatus Normally blank, but can be set to ex Protected, Deceased, Emmigrated, De-registered, where the rest of the fields will be blank.
FirstName
LastName
DateOfBirth A string in the format YYYY-MM-DD. Only if delivered from an underlying search provider.
PersonalNumber Only if delivered from an underlying search provider.
Address Most often the street name and number.
Address2 Most often empty. An extra address line to be used for example for c/o addresses.
PostalCode This is the zip code. Most often a numeric string.
Location Most often empty. This is an extra city locality field. Probably used in the United Kingdom.
City Is often paired with the PostalCode.
CountryCode Is always present. The two-letter iso country code. Identifies the country of the address.
_DataSource Meta field. For traceability this field shows the name of the external data service, where the information originated from.
_MatchLevel Meta field. On search results. descriptive string that is set when the address are returned from a SearchPerson call. Sections are delimited with |.
This is a the degree of matching to the search query. Can be either HIGH, MEDIUM or LOW together with a percentage score.
All rating score limits can be changed after specific customer requirements. Followed by subscore description.
_SortIndexAtSource Meta field. Only for Search Results. Most often the search results at the underlying data provider are sorted in order of relevance.
This is a field to keep that information.

Identity

CountryCode Always present. Indicates the country the identification is performed in.
FirstName Always present.
LastName Always present.
DateOfBirth Always present. In the format YYYY-MM-DD
PersonalNumber Availability depends on the underlying identity provdier in the respective country. In Denmark (NemID) and Norway (BankID) it is normally not delivered.
IdProviderName IDP data. ZignSec´s name of the underlying identity provider, for example NemId, BankIDSE, BankIDNO or BankLogin.
IdentificationDate IDP data. A datetime for when the identitifaction took place.
IdProviderRequestId IDP data. A provider specific unique identifier for the transaction, if available. (for traceability)
IdProviderPersonId IDP data. A provider specific unique identifier for the person identified, if available. (for traceability) Here is for example the Danish PID put, a technical CPR substitue that it not as integrity restricted as the CPR number in the NemID service.
CustomerPersonId IDP data. The integrating part can use their own person key. For possible reuse by ZignSec login processes.
IdProviderAuthenticity IDP data. A values showing the authenticity of the Identity details. Returning the values: HIGH, MEDIUM, LOW och NOT_SET. Not always used.

Environment

Note: This parameter is for the moment only implemented with the eKyc APIs.

For changing the type of underlying service provider between test and prod, overriding the standard environment setting.

Environment Optional root parameter available with the eKyc APIs. Allowed values are prod, test and mock