Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space PDOIDC and version master

Contents

Table of Contents
excludeContents

Introduction

The Asynchronous Session API is an alternative to the older synchronous API, and this will be the preferred integration choice in the time going forward.

New features such as international organization search again different countries like Sweden, Finland, and Denmark are only available in this API.

Technical advantages

The new asynchronous API has several advantages compared with the synchronous alternative.

  • Robustness during periods of high traffic load.
  • Improved handling of scenarios with an unusually long response time. In general, the asynchronous service will deliver a response just as fast as before. But an advantage is that the asynchronous service will be able to deliver a successful response even for the more time-consuming requests. Cases previously disrupted by short-term downtime can now be handled successfully with a delayed response.
  • Webhook notifications, making polling unnecessary
  • Batch support (coming later)
  • Future extensions to this API may lead to more advanced behavior regarding disrupted requests
Note

The Asynchronous Session API is an alternative to the older synchronous API.

  • We will encourage all existing integration partners to migrate to the new asynchronous alternative
  • New integration partners must only use the asynchronous API

Summary of message flow

A typical message flow can be divided into three main parts:

...

Scope

Access

aml_organization/basic

API access to the Organization resource

aml_organization/OFACAPI access to The Office of Foreign Assets Control (OFAC) sanction list.

Implementation

...

The session is initialized by creating a query and posting a request to one of the session endpoint.endpoints.

Choose the right endpoint associated with the organization of interest:

POST /organization/session/no
POST /organization/session/se
POST /organization/session/fi

Use the identifier parameter to specify the organization with 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

Use the reports parameter to select what PDF reports to receive as a result.

See the POST Session API documentation for further details about this request.

...

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 statusMeaning
JsonDataReadyThe JSON content is ready for download
ReportReadyA PDF report is ready for download
AllDoneThe session is finished, and all contents are ready for download
FailedSomething went wrong, and the session has been canceled.

...