How do I retrieve information from SUDOP via the API regarding public aid received by an entity?

MGBI provides a comprehensive API for retrieving data from public registers and records, including the Public Assistance Data Sharing System (SUDOP). You can find a list of data sources available through this service at:
👉Public Registers API

This guide covers the API for the Public Assistance Data Sharing System (SUDOP), which we provide as part of the following product:
👉Public Assistance Data Sharing System API (SUDOP API)

Below, we describe how you can use the API to retrieve records containing information about individual instances of assistance received by a beneficiary, based on registration numbers and other parameters.

Step 1: Obtain an API authorization key

To obtain the authorization key required to call endpoints available in the MGBI API, please contact us using the contact form on the product page:
👉Public Assistance Data Sharing System API (SUDOP API)

Step 2: Call the Get Records endpoint

We make the data available in SUDOP accessible via the MGBI API in the data model with the identifierpl-sudop-wpopb-record.

The API provides aGet Records endpoint for this model, which returns records containing information about individual public assistance cases from SUDOP that meet the specified criteria.
👉Documentation for the Get Records endpoint for the pl-sudop-wpopb-record model

To retrieve records listing the types of assistance a given entity has received, you must provide its registration number—KRS, NIP, or REGON—in theGet Recordsendpoint.

Example of calling the Get Records endpoint with a tax ID number:

GET /v1/models/pl-sudop-wpopb-record/records?identifiers.pl_nip=[NIP number] HTTP/1.1
Host: api.mgbi.pl
Authorization: [authorization key]

Step 3: Read the response to find out what assistance the beneficiary received

A successful call to theGet Recordsendpoint returns a response containing complete information about the public assistance received by a given entity.

{
    "count": 1,
    "pages": 1,
    "results": [
        {
            "id": "[identyfikator rekordu]",
            "identifiers": "[identyfikatory podmiotu i powiązanych osób]",
            "content": "[informacja o pomocy udzielonej beneficjentowi]",
            "meta": "[metadane rekordu]"
        }
    ]
}

You can find all the data regarding a specific instance of public aid disclosed in SUDOP for the specified entity in thecontent.raw_result dictionary.

Sample contents of the content.raw_result dictionary:

{
    "dni-udzielenia-pomocy": "[dni udzielenia pomocy]",
    "forma-pomocy-kod": "[kod formy pomocy]",
    "forma-pomocy-nazwa": "[nazwa formy pomocy]",
    "gmina-siedziby-kod": "[kod siedziby gminy]",
    "gmina-siedziby-nazwa": "[nazwa siedziby gminy]",
    "nazwa-beneficjenta": "[nazwa beneficjenta pomocy]",
    "nazwa-udzielajacego-pomocy": "[nazwa podmiotu udzielającego pomocy]",
    "nip-beneficjenta": "[NIP beneficjenta pomocy]",
    "nip-udzielajacego-pomocy": "[NIP podmiotu udzielającego pomocy]",
    "podstawa-prawna-2a-kod": "[kod podstawy prawnej 2a]",
    "podstawa-prawna-2a-nazwa": "[nazwa podstawy prawnej 2a]",
    "podstawa-prawna-2b": "[podstawa prawna 2b]",
    "podstawa-prawna-2c": "[podstawa prawna 2c]",
    "podstawa-prawna-3a": "[podstawa prawna 3a]",
    "podstawa-prawna-3b": "[podstawa prawna 3b]",
    "przeznaczenie-pomocy-kod": "[kod przeznaczenia pomocy]",
    "przeznaczenie-pomocy-nazwa": "[nazwa przeznaczenia pomocy]",
    "sektor-dzialalnosci-kod": "[kod sektora działalności]",
    "sektor-dzialalnosci-nazwa": "[nazwa sektora działalności]",
    "sektor-dzialalnosci-wersja": "[wersja klasyfikacji sektora działalności]",
    "srodek-pomocowy-nazwa": "[nazwa środka pomocowego]",
    "symbol-aktu-ogolnego": "[symbol aktu ogólnego]",
    "wartosc-brutto-eur": "[wartość brutto pomocy w EUR]",
    "wartosc-brutto-pln": "[wartość brutto pomocy w PLN]",
    "wartosc-nominalna-pln": "[wartość nominalna pomocy w PLN]",
    "wielkosc-beneficjenta-kod": "[kod wielkości beneficjenta]",
    "wielkosc-beneficjenta-nazwa": "[nazwa wielkości beneficjenta]"
}

Learn more:
👉Data structure in the pl-sudop-wpopb-record model
👉Endpoint documentation for the pl-sudop-wpopb-record model

How can I retrieve information from SUDOP via the API regarding public aid received by an entity?

Step 1: Obtain an API authorization key

Step 2: Call the Get Records endpoint

Step 3: Read the response to find out what assistance the beneficiary received

A demo is worth more than a thousand words