### Receive Notifications - Callback Request Example Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This code snippet provides an example of the HTTP request that a service would receive at its callback URL when a notification is sent by the SSBTGO Notifiering API. It includes the Host header. ```http POST /callback HTTP/1.1 Host: ssbt.example.com ``` -------------------------------- ### Firmateckningsalternativ API Source: https://portal.api.bolagsverket.se/devportal/apis/15907b12-586b-4d0c-9e2b-7ff6ffd31494/documents/default Retrieve information about signing authorities for organizations. ```APIDOC ## GET /firmateckningsalternativ ### Description Retrieves information about the signing authorities and alternatives for organizations. ### Method GET ### Endpoint /firmateckningsalternativ ### Parameters #### Path Parameters None #### Query Parameters - **organisationsnummer** (string) - Optional - The organization number to filter by. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **firmateckningsalternativ** (array) - An array of signing authority details. - **organisationsnummer** (string) - The organization number. - **firmatecknare** (array) - List of individuals with signing authority. - **alternativ** (object) - Information about signing alternatives. - ... (other signing authority details) #### Response Example ```json { "firmateckningsalternativ": [ { "organisationsnummer": "556000-1234", "firmatecknare": [ { "namn": "John Doe" } ], "alternativ": { "typ": "Ensam" } } ] } ``` ``` -------------------------------- ### API for valuable datasets Source: https://portal.api.bolagsverket.se/devportal/applications Access valuable datasets through file downloads or direct API integration. This section covers various ways to retrieve company information. ```APIDOC ## API for valuable datasets ### Description Provides access to valuable datasets through file downloads and API integration. This includes company information and event monitoring. ### Method Various (GET, file downloads) ### Endpoint `/api/datasets` (Conceptual) ### Parameters None specified directly, likely depends on the specific dataset or file. ### Request Example None provided. ### Response Data in various formats (XML, files) depending on the chosen method. ``` -------------------------------- ### Configure Service as Subscriber Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents This code snippet demonstrates how to configure a service as a subscriber to the SSBTGO Notifiering API. It involves sending a POST request with the service name, a callback URL for receiving notifications, and an authentication token. The API responds with a 201 Created status and a location header pointing to the newly created subscriber resource. ```http POST /ssbtgo-notifiering/v1/prenumerant HTTP/1.1 { "service": "MY_SERVICE", "callback": "https://ssbt.example.com/callback", "auth": "secret signed by me" } ``` ```http HTTP/1.1 201 Created Location: /ssbtgo-notifiering/v1/prenumerant/MY_SERVICE ``` -------------------------------- ### Configure Service as Subscriber - Request Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This code snippet demonstrates the request to configure a service as a subscriber to the SSBTGO Notifiering API. It includes the service name, a callback URL for receiving notifications, and authentication details. ```json { "service": "MY_SERVICE", "callback": "https://ssbt.example.com/callback", "auth": "secret signed by me" } ``` -------------------------------- ### Värdefulla Datamängder API Overview Source: https://portal.api.bolagsverket.se/devportal/apis/ff8f9a91-1fdd-4705-8836-c1906581162f/documents The Värdefulla Datamängder API allows you to retrieve valuable datasets. It supports OAuth 2.0 for authentication using an Implicit OAuth Flow. ```APIDOC ## Värdefulla Datamängder API ### Description Provides access to valuable datasets related to Swedish companies and organizations. ### Method N/A (Overview) ### Endpoint N/A (Overview) ### Security OAuth 2.0 (Implicit OAuth Flow) - Authorize URL: `https://gw.api.bolagsverket.se/authorize` ### Base URL Live Server: `https://gw.api.bolagsverket.se/vardefulla-datamangder/v1` ``` -------------------------------- ### Configure Service as Subscriber Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents Register your service as a subscriber to receive notifications. This endpoint sets up the service ID and the callback URL where notifications will be sent. ```APIDOC ## POST /ssbtgo-notifiering/v1/prenumerant ### Description Registers a service as a subscriber to receive notifications. ### Method POST ### Endpoint /ssbtgo-notifiering/v1/prenumerant ### Parameters #### Request Body - **service** (string) - Required - The unique identifier for the service. - **callback** (string) - Required - The URL where notifications will be sent. - **auth** (string) - Required - Authentication token for the service. ### Request Example ```json { "service": "MY_SERVICE", "callback": "https://ssbt.example.com/callback", "auth": "secret signed by me" } ``` ### Response #### Success Response (201 Created) - **Location** (string) - The URL to the newly created subscriber resource. #### Response Example ```http HTTP/1.1 201 Created Location: /ssbtgo-notifiering/v1/prenumerant/MY_SERVICE ``` ``` -------------------------------- ### Configure Service as Subscriber Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This endpoint is used to register a service as a subscriber for notifications. It requires the service name, a callback URL, and authentication details. ```APIDOC ## POST /ssbtgo-notifiering/v1/prenumerant ### Description Registers a service as a subscriber for company change notifications. ### Method POST ### Endpoint /ssbtgo-notifiering/v1/prenumerant ### Parameters #### Request Body - **service** (string) - Required - The name of the service subscribing. - **callback** (string) - Required - The URL where notifications will be sent. - **auth** (string) - Required - Authentication details for the callback. ### Request Example ```json { "service": "MY_SERVICE", "callback": "https://ssbt.example.com/callback", "auth": "secret signed by me" } ``` ### Response #### Success Response (201 Created) - **Location** (string) - The URL to the newly created subscriber resource. ### Response Example ``` HTTP/1.1 201 Created Location: /ssbtgo-notifiering/v1/prenumerant/MY_SERVICE ``` ``` -------------------------------- ### Organisationsuppgifter API Source: https://portal.api.bolagsverket.se/devportal/apis/15907b12-586b-4d0c-9e2b-7ff6ffd31494/documents/default Retrieve detailed information about organizations. ```APIDOC ## GET /organisationsuppgifter ### Description Retrieves detailed information about organizations based on provided criteria. ### Method GET ### Endpoint /organisationsuppgifter ### Parameters #### Path Parameters None #### Query Parameters - **organisationsnummer** (string) - Optional - The organization number to filter by. - **namn** (string) - Optional - The name of the organization to filter by. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **organisationsuppgifter** (array) - An array of organization details. - **organisationsnummer** (string) - The organization number. - **namn** (string) - The organization name. - ... (other organization details) #### Response Example ```json { "organisationsuppgifter": [ { "organisationsnummer": "556000-1234", "namn": "Example AB", "adress": "Example Street 1" } ] } ``` ``` -------------------------------- ### Organisationer Endpoint Source: https://portal.api.bolagsverket.se/devportal/apis/ff8f9a91-1fdd-4705-8836-c1906581162f/documents Retrieve a list of organizations. Supports filtering and pagination. ```APIDOC ## GET /organisationer ### Description Retrieves a list of organizations. Allows for filtering based on various criteria and supports pagination. ### Method GET ### Endpoint /organisationer ### Parameters #### Query Parameters - **name** (string) - Optional - Filter by organization name. - **size** (integer) - Optional - Number of results per page. - **page** (integer) - Optional - Page number. ### Request Example ```http GET /organisationer?name=ExampleCorp&size=10&page=1 HTTP/1.1 Host: gw.api.bolagsverket.se Authorization: Bearer YOUR_ACCESS_TOKEN ``` ### Response #### Success Response (200) - **content** (array) - Array of organization objects. - **organisationsnamn** (string) - The name of the organization. - **organisationsform** (string) - The legal form of the organization. - **organisationsnummer** (string) - The organization number. #### Response Example ```json { "content": [ { "organisationsnamn": "Example Corp AB", "organisationsform": "Aktiebolag", "organisationsnummer": "556XXX-XXXX" } ], "pageable": { "pageNumber": 0, "pageSize": 10, "totalPages": 5, "totalElements": 50 }, "last": false, "totalPages": 5, "totalElements": 50, "first": true, "size": 10, "number": 0, "sort": { "empty": true, "sorted": false, "unsorted": true }, "numberOfElements": 10, "empty": false } ``` ``` -------------------------------- ### Företagsinformation API Endpoints Source: https://portal.api.bolagsverket.se/devportal/apis/3e90ead0-d992-49cc-a02d-7984c27c2164/documents/default This API provides endpoints to retrieve various types of company information. All endpoints use the POST method. ```APIDOC ## Företagsinformation API ### Description This API allows users to retrieve detailed company information. It uses POST requests for all endpoints to avoid exposing sensitive identification numbers in the URL. ### Base URL `https://gw.api.bolagsverket.se/foretagsinformation/v4` ### Authentication OAuth 2.0 (Implicit Flow) ### Endpoints All endpoints are accessed via POST requests. **Note:** Specific endpoints for retrieving organisationsinformation, ping, etc., are not detailed here but are part of the API's capabilities. ### Request Body Examples (General) Since all endpoints use POST, request bodies will vary depending on the specific information being requested. The schemas section of the original documentation provides details on available request and response structures (e.g., `OrganisationRequest`, `PersonRequest`). ### Response Examples (General) Success responses will typically return data structured according to the defined schemas (e.g., `OrganisationResponse`, `PersonResponse`). Error responses will follow the `ApiError` schema. ``` -------------------------------- ### Ping Endpoint Source: https://portal.api.bolagsverket.se/devportal/apis/15907b12-586b-4d0c-9e2b-7ff6ffd31494/documents/default Checks the status of the SSBTGO service. ```APIDOC ## GET /ping ### Description This endpoint can be used to check if the SSBTGO service is running. ### Method GET ### Endpoint /ping ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **status** (string) - The status of the service (e.g., "OK"). #### Response Example ```json { "status": "OK" } ``` ``` -------------------------------- ### Ping Endpoint Source: https://portal.api.bolagsverket.se/devportal/apis/ff8f9a91-1fdd-4705-8836-c1906581162f/documents A simple endpoint to check the availability and status of the API. ```APIDOC ## GET /ping ### Description Checks if the API is running and accessible. ### Method GET ### Endpoint /ping ### Parameters None ### Request Example None ### Response #### Success Response (200) - **status** (string) - Indicates the health of the service (e.g., "OK"). #### Response Example ```json { "status": "OK" } ``` ``` -------------------------------- ### API for retrieving organization data (SSBTGO) Source: https://portal.api.bolagsverket.se/devportal/applications An API specifically designed for public actors to retrieve basic data about organizations from Bolagsverket, Skatteverket, and SCB. ```APIDOC ## API for retrieving organization data (SSBTGO) ### Description Allows public sector actors to retrieve basic organizational data from Bolagsverket, Skatteverket, and Statistics Sweden (SCB). ### Method GET ### Endpoint `/api/organizations/basic-data` (Conceptual) ### Parameters None specified, but likely requires parameters to filter or identify organizations. ### Request Example None provided. ### Response Basic organizational data. ``` -------------------------------- ### Organisationsengagemang API Source: https://portal.api.bolagsverket.se/devportal/apis/15907b12-586b-4d0c-9e2b-7ff6ffd31494/documents/default Retrieve information about organizational engagements. ```APIDOC ## GET /organisationsengagemang ### Description Retrieves information about engagements within organizations. ### Method GET ### Endpoint /organisationsengagemang ### Parameters #### Path Parameters None #### Query Parameters - **organisationsnummer** (string) - Optional - The organization number to filter by. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **engagemang** (array) - An array of engagement details. - **organisationsnummer** (string) - The organization number. - **typ** (string) - The type of engagement. - ... (other engagement details) #### Response Example ```json { "engagemang": [ { "organisationsnummer": "556000-1234", "typ": "Holding" } ] } ``` ``` -------------------------------- ### Receive Notifications Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents This section describes how your service will receive notifications. The API sends POST requests to the registered callback URL when a relevant company change occurs. ```APIDOC ## POST /callback ### Description This endpoint is where the Bolagsverket API will send notifications about company changes to your registered callback URL. ### Method POST ### Endpoint /callback (This is the URL registered during service configuration) ### Request Example ```http POST /callback HTTP/1.1 Host: ssbt.example.com [Notification Payload Here] ``` ### Response #### Success Response (204 No Content) Indicates that the notification was received successfully. #### Response Example ```http HTTP/1.1 204 No Content ``` ``` -------------------------------- ### Submit information APIs Source: https://portal.api.bolagsverket.se/devportal/applications APIs for submitting various types of information, including board changes, legal announcements, and annual reports. ```APIDOC ## Submit information APIs ### Description APIs for submitting information to Bolagsverket, such as board changes in housing associations, registration of announcements, and digital submission of annual reports. ### Methods POST, PUT (depending on the specific submission) ### Endpoints - `/api/housing-associations/board-changes` - `/api/legal-announcements/register` - `/api/annual-reports/digital-submission` (Conceptual) ### Parameters Specific parameters will vary based on the type of submission. ### Request Body Will contain the data for the submission (e.g., details of board changes, announcement content, annual report files). ### Request Example None provided. ### Response Confirmation of submission or error messages. ``` -------------------------------- ### Receive Notifications Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This endpoint is the callback URL configured by the subscriber. The API will send POST requests to this URL when changes occur for subscribed organization numbers. ```APIDOC ## POST /callback ### Description Receives notifications about changes in company information. This is a callback endpoint configured by the subscriber. ### Method POST ### Endpoint /callback (This is a placeholder, use the URL provided during subscriber registration) ### Request Example ``` POST /callback HTTP/1.1 Host: ssbt.example.com [Notification Payload] ``` ### Response #### Success Response (204 No Content) Indicates that the notification was successfully received and processed. ``` -------------------------------- ### Subscribe to Organization Numbers - Request Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This code snippet shows the request payload for subscribing to notifications for specific organization numbers. It specifies the action ('SKAPA' for create) and a list of organization numbers. ```json { "atgard": "SKAPA", "orgnr": [ "5566789911", "5566789912" ] } ``` -------------------------------- ### Dokumentlista Endpoint Source: https://portal.api.bolagsverket.se/devportal/apis/ff8f9a91-1fdd-4705-8836-c1906581162f/documents Retrieve a list of documents. Supports filtering by organization and document type. ```APIDOC ## GET /dokumentlista ### Description Retrieves a list of documents. You can filter documents by organization and document type. ### Method GET ### Endpoint /dokumentlista ### Parameters #### Query Parameters - **organisationsnummer** (string) - Optional - Filter by organization number. - **dokumenttyp** (string) - Optional - Filter by document type. ### Request Example ```http GET /dokumentlista?organisationsnummer=556XXX-XXXX&dokumenttyp=A&page=0&size=20 HTTP/1.1 Host: gw.api.bolagsverket.se Authorization: Bearer YOUR_ACCESS_TOKEN ``` ### Response #### Success Response (200) - **content** (array) - Array of document objects. - **id** (string) - Document ID. - **datum** (string) - Date of the document. - **typ** (string) - Type of the document. #### Response Example ```json { "content": [ { "id": "doc-123", "datum": "2023-01-15", "typ": "A" } ], "pageable": { "pageNumber": 0, "pageSize": 20, "totalPages": 1, "totalElements": 5 }, "last": true, "totalPages": 1, "totalElements": 5, "first": true, "size": 20, "number": 0, "sort": { "empty": true, "sorted": false, "unsorted": true }, "numberOfElements": 5, "empty": false } ``` ``` -------------------------------- ### Receive Notifications Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents This code demonstrates the server-side aspect of receiving notifications from the SSBTGO Notifiering API. It shows a basic HTTP POST request to a callback URL, which is where the API will send change notifications. The expected response from the service is a 204 No Content, acknowledging receipt of the notification. ```http POST /callback HTTP/1.1 Host: ssbt.example.com ``` ```http HTTP/1.1 204 No Content ``` -------------------------------- ### Subscribe to Organization Numbers Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents This snippet shows how to subscribe to notifications for specific organization numbers. A POST request is made to the subscriber's endpoint, specifying the desired action ('SKAPA' - CREATE) and a list of organization numbers. The API response indicates which organization numbers were successfully subscribed to and provides reasons for any rejections. ```http POST ssbtgo-notifiering/v1/prenumerant/MY_SERVICE/prenumeration HTTP/1.1 { "atgard": "SKAPA", "orgnr": [ "5566789911", "5566789912" ] } ``` ```http HTTP/1.1 200 OK { "avvisade": [ "orgnr": "5566789912", "orsak": "Avregisterat bolag" ] } ``` -------------------------------- ### Handle Subscription Response - Rejected Organization Numbers Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This code snippet illustrates a possible response when subscribing to organization numbers, indicating which organization numbers were rejected and the reason for rejection. In this case, one organization number was rejected because the company is deregistered. ```json { "avvisade": [ "orgnr": "5566789912", "orsak": "Avregisterat bolag" ] } ``` -------------------------------- ### Organisation Endpoint Source: https://portal.api.bolagsverket.se/devportal/apis/ff8f9a91-1fdd-4705-8836-c1906581162f/documents Retrieve details for a specific organization by its ID. ```APIDOC ## GET /organisationer/{id} ### Description Retrieves detailed information about a specific organization using its unique identifier. ### Method GET ### Endpoint /organisationer/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the organization. ### Request Example ```http GET /organisationer/556XXX-XXXX HTTP/1.1 Host: gw.api.bolagsverket.se Authorization: Bearer YOUR_ACCESS_TOKEN ``` ### Response #### Success Response (200) - **organisationsnamn** (string) - The name of the organization. - **organisationsform** (string) - The legal form of the organization. - **organisationsnummer** (string) - The organization number. - **postadress** (object) - Postal address details. - **gatuadress** (string) - Street address. - **postnummer** (string) - Postal code. - **postort** (string) - Postal town. #### Response Example ```json { "organisationsnamn": "Example Corp AB", "organisationsform": "Aktiebolag", "organisationsnummer": "556XXX-XXXX", "postadress": { "gatuadress": "Example Street 1", "postnummer": "123 45", "postort": "Example City" } } ``` ``` -------------------------------- ### Subscribe to Organization Numbers Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents Subscribe to receive notifications for specific organization numbers. You can specify actions like 'SKAPA' (CREATE) and provide a list of organization numbers. ```APIDOC ## POST /ssbtgo-notifiering/v1/prenumerant/{serviceId}/prenumeration ### Description Subscribes to receive notifications for a list of organization numbers. ### Method POST ### Endpoint /ssbtgo-notifiering/v1/prenumerant/{serviceId}/prenumeration ### Parameters #### Path Parameters - **serviceId** (string) - Required - The ID of the service to subscribe for. #### Request Body - **atgard** (string) - Required - The action to subscribe to (e.g., "SKAPA"). - **orgnr** (array of strings) - Required - A list of organization numbers to subscribe to. ### Request Example ```json { "atgard": "SKAPA", "orgnr": [ "5566789911", "5566789912" ] } ``` ### Response #### Success Response (200 OK) - **avvisade** (array) - A list of organization numbers that were rejected and the reason. - **orgnr** (string) - The rejected organization number. - **orsak** (string) - The reason for rejection. #### Response Example ```json { "avvisade": [ { "orgnr": "5566789912", "orsak": "Avregisterat bolag" } ] } ``` ``` -------------------------------- ### Personrelationsuppgifter API Source: https://portal.api.bolagsverket.se/devportal/apis/15907b12-586b-4d0c-9e2b-7ff6ffd31494/documents/default Retrieve information about personal relationships within organizations. ```APIDOC ## GET /personrelationsuppgifter ### Description Retrieves information about personal relationships associated with organizations. ### Method GET ### Endpoint /personrelationsuppgifter ### Parameters #### Path Parameters None #### Query Parameters - **personnummer** (string) - Optional - The personal identification number to filter by. - **organisationsnummer** (string) - Optional - The organization number to filter by. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **relationer** (array) - An array of personal relationship details. - **personnummer** (string) - The personal identification number. - **organisationsnummer** (string) - The organization number. - **roll** (string) - The role of the person in the organization. - ... (other relationship details) #### Response Example ```json { "relationer": [ { "personnummer": "19900101-1234", "organisationsnummer": "556000-1234", "roll": "VD" } ] } ``` ``` -------------------------------- ### Subscribe to Organization Numbers Source: https://portal.api.bolagsverket.se/devportal/apis/0c4b1dba-3a4a-40bf-83b8-0f749bf04d5b/documents/default This endpoint allows a configured service to subscribe to notifications for specific organization numbers. You can specify whether to create or delete a subscription for given numbers. ```APIDOC ## POST /ssbtgo-notifiering/v1/prenumerant/{serviceId}/prenumeration ### Description Subscribes or unsubscribes a service to notifications for specific organization numbers. ### Method POST ### Endpoint /ssbtgo-notifiering/v1/prenumerant/{serviceId}/prenumeration ### Parameters #### Path Parameters - **serviceId** (string) - Required - The ID of the service subscribing. #### Request Body - **atgard** (string) - Required - The action to perform: "SKAPA" (create) or "RADERA" (delete). - **orgnr** (array of strings) - Required - A list of organization numbers to subscribe or unsubscribe to. ### Request Example ```json { "atgard": "SKAPA", "orgnr": [ "5566789911", "5566789912" ] } ``` ### Response #### Success Response (200 OK) - **avvisade** (array of objects) - A list of organization numbers that were rejected. - **orgnr** (string) - The rejected organization number. - **orsak** (string) - The reason for rejection. ### Response Example ```json { "avvisade": [ { "orgnr": "5566789912", "orsak": "Avregisterat bolag" } ] } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.