MGBI dostarcza kompleksowe API do pobierania danych z rejestrów i ewidencji publicznych, w tym z Centralnego Rejestru Beneficjentów Rzeczywistych (CRBR).
Listę źródeł danych dostępnych w tej usłudze znajdziesz na stronie:
👉 Rejestry Publiczne API
Ten poradnik dotyczy API dla wyszukiwarki podmiotów CRBR, który udostępniamy w ramach produktu:
👉 Centralny Rejestr Beneficjentów Rzeczywistych API (CRBR API) - Wyszukiwarka Podmiotów
Poniżej opisaliśmy, w jaki sposób możesz pobrać przez API listę beneficjentów rzeczywistych podmiotu z CRBR na podstawie jego numeru NIP.
Krok 1: Uzyskaj klucz autoryzacji w API
Aby zdobyć klucz autoryzacji wymagany przy wywoływaniu endpointów dostępnych w MGBI API, skontaktuj się z nami przy użyciu formularza kontaktowego na stronie produktu:
👉 Centralny Rejestr Beneficjentów Rzeczywistych API (CRBR API) - Wyszukiwarka Podmiotów
Krok 2: Wywołaj endpoint Create Refresh
Dane dostępne w Wyszukiwarce Podmiotów CRBR udostępniamy w MGBI API w modelu danych o identyfikatorze pl-crbr-wp-record.
Model ten jest synchronizowany na żądanie, co oznacza, że nie dysponujemy dla niego w naszych zbiorach pełną kopią danych dostępnych w rejestrze źródłowym.
Aby uzyskać z modelu aktualne dane dotyczące wskazanego dłużnika, musisz najpierw utworzyć zlecenie ich pobrania z CRBR przy użyciu endpointu Create Refresh.
Przykład wywołania endpointu Create Refresh z numerem NIP:
POST /v1/refresh HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
{
"query: {
"model": "pl-crbr-wp-record",
"identifiers.pl_nip": [numer NIP]
}
}
Prawidłowe wywołanie endpointu Create Refresh zwraca w odpowiedzi słownik zawierający identyfikator zlecenia w polu id.
Krok 3: Wywołaj endpoint Get Refresh
Zlecenia pobrania danych z rejestru źródłowego zwykle trwają od kilku do kilkunastu sekund od momentu ich utworzenia endpointem Create Refresh.
Aby sprawdzić aktualny status zlecenia, wywołaj endpoint Get Refresh podając w adresie URL jego identyfikator uzyskany w poprzednim kroku.
Przykład wywołania endpointu Get Refresh z identyfikatorem zlecenia:
GET /v1/refresh/[identyfikator zlecenia] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
Jeśli w zwróconym słowniku pole status przyjmuje wartość pending, zlecenie jest jeszcze w trakcie wykonywania i należy ponownie wywołać endpoint Get Refresh za kilka sekund.
Jeśli pole status przyjmuje wartość success, to oznacza, że zlecenie zostało wykonane i dane dotyczące wskazanego dłużnika zostały już pobrane z rejestru źródłowego.
Krok 4: Wywołaj endpoint Get Records
API dla modelu pl-crbr-wp-record udostępnia endpoint Get Records, który zwraca rekordy z pełną treścią odpowiedzi z Wyszukiwarki Podmiotów CRBR dla wskazanego dłużnika.
👉 Dokumentacja endpointu Get Records dla modelu pl-crbr-wp-record
Aby otrzymać dane pobrane z rejestru źródłowego w utworzonym wcześniej zleceniu, wywołaj endpoint Get Records przekazując identyfikator zlecenia w parametrze refresh_id.
Przykład wywołania endpointu Get Records z identyfikatorem zlecenia:
GET /v1/models/pl-crbr-wp-record/records?refresh_id=[identyfikator zlecenia] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
Krok 5: Odczytaj z odpowiedzi listę beneficjentów rzeczywistych
Prawidłowe wywołanie endpointu Get Records zwraca w odpowiedzi listę rekordów spełniających podane kryteria.
W powyższym przykładzie endpoint powinien zwrócić listę wyników zawierającą jeden rekord:
{
"count": 1,
"pages": 1,
"results": [
{
"id": [identyfikator rekordu],
"identifiers": [identyfikatory podmiotu],
"version": [informacje o wersji rekordu],
"content": [treść odpowiedzi z wyszukiwarki],
"meta": [metadane rekordu]
}
]
}
Lista beneficjentów rzeczywistych podmiotu dostępna jest w polu content.raw_result.listaBeneficjentow.
Każdy element listy zawiera dane pojedynczego beneficjenta, takie jak imię i nazwisko, kraje obywatelstwa czy informacje o udziale lub innych uprawnieniach.
Przykładowa zawartość elementu:
{
"pesel": [numer PESEL],
"dataUrodzenia": [data urodzenia],
"imiePierwsze": [pierwsze imię],
"imieDrugieINastepne": [drugie imię],
"nazwisko": [nazwisko],
"obywatelstwo": [kraje obywatelstwa],
"panstwoZamieszkania": [państwo zamieszkania],
"nazwaBeneficjentaGrupowego": [nazwa beneficjenta grupowego],
"informacjeOUprawnieniachTrust": [informacje o uprawnieniach w truście],
"informacjeOUdzialeLubUprawnieniach": [informacje o udziale lub innych uprawnieniach],
"idTech": [wewnętrzny identyfikator beneficjenta]
}
Uzyskaj więcej informacji:
👉 Struktura danych w modelu pl-crbr-wp-record
👉 Dokumentacja endpointów dla modelu pl-crbr-wp-record
