Organization resource

Contents

Step 1: Have a look at the API documentation

See Organization API documentation for detailed documentation.

See also the Organization API expands overview.

Step 2: Gain access to the service

OIDC Clients must be provisioned to gain access to the AML service.

Anyone will get access to the test environment after submitting a request in the service desk.

Step 3: Get access token

The organization resource uses the default Access Token format of the OIDC Provider from BankID, adapted to the client credential flow.

Eligible OIDC Clients can request Access Tokens for the AML Service by invoking the Token endpoint using Client Credential Grant and supplying appropriate scope values. The Access Token must be added as an OAuth2 Bearer Token to subsequent requests to endpoints for the AML API.

AML organization resource scopes

The following scopes with corresponding API access are supported.

Step 4: Query the resource

Specify the organization

Use either the organizationNumber parameter or the dunsNumber parameter.

Using the "expand" parameter

By default, only a basic dataset with key information elements is returned. To select more data, the expand parameter must be provided in the request. Se Organization API expand parameter documentation.

Example

/organization/?expands=address,officialRoles,links.reports.aml

Step 5: Investigate the response elements

Interpreting the "authorities" response

The "authorities" node delivers both

• a human readable description of the company's signature rights and power of procuration
• and, for a wide range of cases, a machine readable specification of the same information

"authorities": {
    "signatureRights": {
      "status": "CONCLUSIVE",
      "description": "Daglig leder alene. Styrets leder alene.",
      "options": [
        {
          "required": [
            {
              "name": "Lars Leder",
              "dateOfBirth": "1962-02-13",
              "role": "CEO"
            }
          ]
        },
        {
          "required": [
            {
              "name": "Siri Hansen",
              "dateOfBirth": "1973-04-01",
              "role": "CHAIRMAN_OF_THE_BOARD"
            }
          ]
        }
      ]
    },
    "powerOfProcuration": {
      "status": "NOT_SET"
    }
}

"authorities": {
    "signatureRights": {
      "status": "IN_CONCLUSIVE",
      "description": "To styremedlemmer i fellesskap. Daglig leder alene. Styrets leder alene."
    },
    "powerOfProcuration": {
      "status": "NOT_SET"
    }
}

The "description" element in the response contains the full natural language description of the signature rights, unchanged and on the same format as written in the "Brønnøysundregisteret" data source. 

In many cases, the BankID AML service manages to express the same information on a machine readable format.

The "status" element specifies this categorization:

1. CONCLUSIVE - The signature rights description is a clear and specific list of alternative sets of people. A machine readable specification is offered.
2. IN_CONCLUSIVE - The signature rights description is complex, and a machine readable specification has not yet been implemented.
3. NOT_SET - The signature rights or power of procuration has not been specified for the company.

The "options" elements is only included in the response when status is CONCLUSIVE. The content is a list of signature rights alternatives, where each alternative contains a list of the specific required people. In a future release, this functionality may be extended to express more complex variants.