Contents
| Table of Contents | ||
|---|---|---|
|
...
The following sequence diagram shows an example of this flow. Note that the usage of webhooks is not mandatory, and a different approach using a polling method is also possible.
| Macro diagram | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
@startuml
actor client
boundary "Person session API" as session
== Part 1: Initialize the session ==
client -> session: **POST** Create session
activate session
session --> client: //201 Created//
note right: return sessionId
client -> session: **GET** Get session
session --> client: //200 OK//
note right: Example response:\njsonData: IN_PROGRESS\naml-report: NOT_STARTED
...wait...
== Part 2: Receive webhook notifications ==
session -> client: <font color=blue>**POST** jsonData is ready
client --> session: //200 OK//
session -> client: <font color=blue>**POST** report is ready
client --> session: //200 OK//
session -> client: <font color=blue>**POST** All done
client --> session: //200 OK//
|||
== Part 3: Retrieve result content ==
client -> session: **GET** Retrieve JSON content
session --> client: //200 OK// - Result entity
client -> session: **GET** Retrieve report
session --> client: //200 OK// - PDF-report
deactivate session
@enduml |
Preparations
Have a look at the API documentation
...
A range of different webhooks is available to be sent with notifications about events. Which webhooks you want to receive is a choice in the session request.
| Webhook status | Meaning |
|---|---|
| JsonDataReady | The JSON content is ready for download |
| ReportReady | A PDF report is ready for download |
| AllDone | The session is finished, and all contents are ready for download |
| Failed | Something went wrong, and the session has been canceled. |
...
| Information | JSON path | Details | Source |
|---|---|---|---|
| Key information | keyInformation | Personal data about the individual under assessment. | National Registry of Norway |
| Citizenship | keyInformation.citizenship | Citizenship of the individual | National Registry of Norway |
| BankID 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 | National Registry of Norway or Sweden |
| Historic Address | address.historic | List of historic addresses | National Registry of Norway |
| 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 |
| Roles | roles | A list of official roles the person has in different organizations. | Brønnøysundregisteret |
...