Contents
| Table of Contents | ||
|---|---|---|
|
...
The following scopes with corresponding API access are supported.
Scope | Access |
|---|---|
aml_organization/basic | API access to the Organization resource |
aml_organization/OFAC | API access to The Office of Foreign Assets Control (OFAC) sanction list. |
Implementation
Part 1: Initialize the session
...
Use the identifier parameter to specify the organization with an organization an organization number or a DUNS number. Note that the country of interest must be specified with the nationality parameter.
By default, only a basic dataset with key information elements is returned. To select more data, the expands parameter must be provided in the request. Se Organization API expand parameter documentation.
...
Make a request to the GET session information endpoint at at any point of in time to receive a JSON object with status information about the different result entities associated with the session.
...
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. |
Note that the usage of webhooks is not mandatory. If desired, a polling mechanism may be implemented instead to check the status of the session until the results are ready.
...
The result is a set of different entities:
| Result entity | Description | Lifetime | ||||
|---|---|---|---|---|---|---|
| The JSON response | Structured data Note that company information from a series of different countries is supported. The different countries have separate API endpoints and corresponding separate response models. The response models have some differences due to variations between countries, but they are also similar in a large matter. | 2 hours after availability | ||||
A PDF report "AML"
| All the information requested from the service in a human-readable fashion. | 2 hours after availability | ||||
A PDF report "Certificate of registration" | A subset of the information necessary to fulfill the "Firmaattest" purpose. | 2 hours after availability |
Investigate the JSON response elements
| Info |
|---|
The following documentation is a detailed description of the response model for a Norwegian company. For other countries a similar but different response model is offered. |
| 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 |
| Info | ||
|---|---|---|
| ||
| Note that if a particular response element is requested (typically through expand parameter), but no information could be found in the source, an empty JSON node is returned to dictate that a search has been done. |
...