...
...
...
...
...
...
Contents
| Table of Contents |
|---|
Introduction
Three variants of the resource is available, where the first and second requires that the individual is first identified with BankID at the highest level of assurance.
- Identifying the individual via the BankID IDP in the OIDC Provider from BankID
- Identifying the individual via data embedded in a BankID SDO that is the result of an individual signing a document with BankID in the legacy way via BankID Server.
- Assessment of individuals (based on query parameters) without any associated identification with BankID
...
An advantage of using variant 1 and 2, where the end user is identified using BankID, is that the response from the AML service will be enriched with information about that strongly confirmed identity.
...
API
...
API documentation
See the Person API documentation for further details about the API.
See also the Person API expands overview.
| Note |
|---|
Note that the old legacy Person API is still available in a deprecated stage until all existing customers have finished migration to the new API. |
How to query the resource
...
By default, only a basic minor dataset with a few key information elements is returned. To select more data, the expand parameter must be provided in the request. Se Person API expand parameter documentation.
Example
/person?expands=address.postal,aml | request postal address and aml search result |
...
In addition, the scope aml_person/NO_NATIONAL_REGISTRY is required in order to receive information from the Norwegian national registry source, and the scope aml_person/OFAC is required in order to trigger AML search against The Office of Foreign Assets Control (OFAC) sanction list.
See also Scopes and Claims (AML).
...
| Information | JSON path | Details | Source | ||
|---|---|---|---|---|---|
| Key information | keyInformation | Personal data about the individual under assessment. | Norwegian National Registry | ||
| BankID Common name | keyInformation.eIdName | Common name Identity | identity | Name, common name, and ssn of the individuals BankID certificate | BankID |
| Postal Address | address.postal | Address form Postal registry | Posten | ||
| National Address | address.national | Address from national registries | Norwegian National Registry | ||
| Historic Address | address.historic | List of historic addresses | Norwegian National Registry | ||
| Number of residents | address.postal.numberOfResidents address.national.numberOfResidents | Type of housing, and number of residents on the given address. | Property register | ||
| AML | aml | Lists of possible PEP and Sanction results for the individual. | EU commission UN Security council Trapets OFAC | ||
| PDF report | links.reports | Link to a signed PDF report containing the complete result set. |
| Info | ||
|---|---|---|
| ||
Note that if a particular response element is requested (typically through expand parameter), but no information could be found in the source, and empty JSON node is returned to dictate that a search has been done. |
Test data
Example test persons have been prepared in the test environment (Current).