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 "Org 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 | ||
|---|---|---|---|---|
| Key Information | keyInformation | (delivered by default)
| ||
| LEI number | keyInformation.lei | |||
| Addresses | address |
| ||
| Financials: Accounting | financials.accounting | Last tree years | ||
| Financials: Key figures | financials.keyFigures | Share capital, turnover, operating profit, equity, earnings, sources, accounting years | ||
| Financials: Auditor | financials.auditor | Name, org number, sources | ||
Financials: Accountant | financials.accountant | Name, org number | ||
Ownership: Beneficials | ownership.beneficials | Name, address, owner share, date of birth, roles | ||
Ownership: Subsidiaries | ownership.subsidiaries | name, org number, percentage (owned by the company) | ||
| Ownership: Shareholders | ownership.shareholders | name, org number, percentage, type (organization or person) | ||
| Ownership: Indicators | ownership.indicators | A set of numbers describing the organisational structure. | ||
| authorities | Signature rights and power of procuration.
| |||
Roles | roles | Roles delivered: CEO, chairman, deputy chairman, proprietor, board members, deputy board members, contact person, company secretary, representative foreign entity, trustee | ||
Sanction | sanction | Status, message (if no hit), matchIndicator, matchIndicatorDescription, aliasList, address, source (listname), data provider (source) Initial date, LastUpdate, list of Urls (to documents about the result). | ||
PDF Reports:
| links.reports |
...