NAV
Curl

Transparent Data API

Niniejsza dokumentacja techniczna została wystawiona przez firmę Transparent Data dla jej Klientów i opisuje metody oraz sposoby korzystania z API, zwracającego dane z polskich rejestrów handlowych i baz własnych. Dane z KRS, CEIDG, Białej Listy, sprawozdań finansowych, raportów i wielu innych źródeł zostały szczegółowo opisane w sekcji Dostępne źródła danych.

API udostępnia dwa główne endpointy, które sprawiają, że cała usługa działa w sposób asynchroniczny, tak aby istniała możliwość integrowania wielu źródeł niezależnie - jeden służy do składania zleceń integrowania danych, drugi natomiast do sprawdzania statusu i pobierania wyników działania API.

Poza tym, API udostępnia również endpointy, pozwalające na zarządzanie monitoringiem firm oraz ksiąg wieczystych.

W przypadku pytań prosimy o kontakt pod adresem: support@transparentdata.pl

TD - CEIDG JSON

Źródło umożliwia pobranie wszystkich danych o podmiocie z rejestru CEIDG w formacie JSON.

Request

Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 source nazwa źródła danych string ceidg wymagane
2 method nazwa metody źródła danych dla odpisu krs json string data wymagane
3 params parametry zapytania węzeł wymagane
4 nip numer nip firmy int 10 cyfrowy numer NIP wymagane
5 timeout czas oczekiwania na odpowiedź ze źródła. Domyślnie ustawiony na 200 sekund. Jeżeli źródło nie odpowiada w określonym timeout, to zwracamy ostatni najbardziej aktualny wynik. Wartość domyślna jest wartością optymalną. int maksymalnie 600 niewymagane
6 version oznaczenie wersji zamówienia string 1.0.0 wymagane

Przykładowe zapytanie

{
   "source":"ceidg",
   "method":"data",
   "params":{
      "nip":"123123123",
      "timeout": 300
   },
  "version" : "1.0.0"
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "63eb039d-9039-4e6c-a1a2-924e348c18c1"
}

W celu pobrania danych, należy wykorzystać zwrócony identyfikator.

curl --user:pass  https://api.transparentdata.pl/key/result?ident=63eb039d-9039-4e6c-a1a2-924e348c18c1

Response

Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 status status wykonania zadania string done (wykonane), quened (dodane do kolejki), in_progress( w trakcie wykonywania), error (błąd podczas próby generowania) wymagane
2 ident unikalny numer identyfikacyjny nadany przy zapytaniu string wymagane
3 added data zapytania string data(format Y-m-d H:i:s) wymagane
4 finished data wykonania string data(format Y-m-d H:i:s) wymagane
5 user_account nazwa konta użytkownika string/nullable ciąg tekstowy/null wymagane
6 progress procentowa ilość wykonania zadania int 0-100 wymagane
7 data tablica z danymi tablica(array) wymagane
8 task_id indywidualny numer id nadany podczas tworzenia zadania int wymagane
9 source nazwa źródła danych string krs wymagane
10 method nazwa metody źródła danych dla odpisu krs json string data wymagane
11 params parametry zapytania węzeł wymagane
12 nip numer nip firmy int 10 cyfrowy numer NIP wymagane
13 meta metatagi nullable null wymagane
14 result rezultat zapytania węzeł wymagane
15 first_name imię string/nullable ciąg tekstowy/null wymagane
16 last_name nazwisko string/nullable ciąg tekstowy/null wymagane
17 nip numer nip int/nullable liczba/null wymagane
18 regon numer regon string/nullable liczba/null wymagane
19 company_name nazwa firmy string/nullable ciąg tekstowy/null wymagane
20 company_status status firmy string/nullable Aktywny, Wykreślony, Zawieszony, Działalność jest prowadzona wyłącznie w formie spółki/spółek cywilnych, Oczekuje na rozpoczęcie działalności/null wymagane
21 beginning_date data rozpoczęcia działalności string/nullable data(format Y-m-d)/null wymagane
22 suspended_from_date data zawieszenia działalności string/nullable data(format Y-m-d)/null wymagane
23 suspended_to_date data wznowienia wykonywania działalności string/nullable data(format Y-m-d)/null wymagane
24 resumption_date data zaprzestania wykonywania działalności string/nullable data(format Y-m-d)/null wymagane
25 ending_date data wykreślenia wpisu z rejestru string/nullable data(format Y-m-d)/null wymagane
26 deletion_legal_basis podstawa_prawna_wykreslenia string/nullable ciąg tekstowy/null wymagane
27 legal_basis_details podstawa_prawna_informacja string/nullable ciąg tekstowy/null wymagane
28 cancellation anulowanie string/nullable ciąg tekstowy/null wymagane
29 has_community_of_goods wspolnota majatkowa int/nullable liczba (1/0)/null wymagane
30 main_pkd główny kod pkd string/nullable ciąg tekstowy/null wymagane
31 nationality narodowość string/nullable ciąg tekstowy/null wymagane
32 phone telefon string/nullable ciąg tekstowy/null wymagane
33 fax fax string/nullable ciąg tekstowy/null wymagane
34 www strona wwww string/nullable ciąg tekstowy/null wymagane
35 email adres email string/nullable ciąg tekstowy/null wymagane
36 main_address główny adres węzeł wymagane
37 street ulica string/nullable ciąg tekstowy/null wymagane
38 number numer budynku string/nullable ciąg tekstowy/null wymagane
39 local numer lokalu string/nullable ciąg tekstowy/null wymagane
40 commune gmina string/nullable ciąg tekstowy/null wymagane
41 country powiat string/nullable ciąg tekstowy/null wymagane
42 region województwo string/nullable ciąg tekstowy/null wymagane
43 post poczta string/nullable ciąg tekstowy/null wymagane
44 postcode kod pocztowy string/nullable ciąg tekstowy/null wymagane
45 city miasto string/nullable ciąg tekstowy/null wymagane
46 postal_address adres do wysyłki węzeł wymagane
47 street ulica string/nullable ciąg tekstowy/null wymagane
48 number numer budynku string/nullable ciąg tekstowy/null wymagane
49 local numer lokalu string/nullable ciąg tekstowy/null wymagane
50 commune gmina string/nullable ciąg tekstowy/null wymagane
51 country powiat string/nullable ciąg tekstowy/null wymagane
52 region województwo string/nullable ciąg tekstowy/null wymagane
53 post poczta string/nullable ciąg tekstowy/null wymagane
54 postcode kod pocztowy string/nullable ciąg tekstowy/null wymagane
55 city miasto string/nullable ciąg tekstowy/null wymagane
56 in_civil_partnership czy jest członkiem spółki cywilnej? int/nullable liczba(1/0)/null wymagane
57 civil_partnership_details informacje na temat spółki cywilnej tablica(array) wymagane
58 nip numer nip int/nullable numer/null wymagane
59 regon numer regon int/nullable numer/null wymagane
60 activity_suspended data zawarcia string/nullable data(format Y-m-d)/null wymagane
61 partners_nip_numbers tablica numer nip partnerow tablica(array) numery nip wymagane
62 permissions koncesja tablica(array) wykaz koncesji lub pusta tablica wymagane
63 restrictions ograniczenia tablica(array) wymagane
64 description opis restrykcji string/nullable ciąg tekstowy/null wymagane
65 period długość string/nullable ciąg tekstowy/null wymagane
66 institution nazwa instytucji wydającej string/nullable ciąg tekstowy/null wymagane
67 file_number numer akt string/nullable ciąg tekstowy/null wymagane
68 type typ zakazu string/nullable ciąg tekstowy/null wymagane
69 ruling_date data orzeczenia string/nullable data(format Y-m-d)/null wymagane
70 effective_date data wejścia w życie string/nullable data(format Y-m-d)/null wymagane
71 agents przedstawiciel dane tablica(array) wymagane
72 name imię i nazwisko string/nullable ciąg tekstowy/null wymagane
73 nip numer nip int/nullable numer/null wymagane
74 permissions uprawnienia string/nullable ciąg tekstowy/null wymagane
75 extra_addresses dodatkowe miejsca wykonywania działalności string/nullable ciąg tekstowy/null wymagane
76 street ulica string/nullable ciąg tekstowy/null wymagane
77 number numer budynku string/nullable ciąg tekstowy/null wymagane
78 local numer lokalu string/nullable ciąg tekstowy/null wymagane
79 country powiat string/nullable ciąg tekstowy/null wymagane
80 region województwo string/nullable ciąg tekstowy/null wymagane
81 post poczta string/nullable ciąg tekstowy/null wymagane
82 postcode kod pocztowy string/nullable ciąg tekstowy/null wymagane
83 city miasto string/nullable ciąg tekstowy/null wymagane

Przykładowy zestaw danych wywołując metode /result

{
   "status":"done",
   "ident":"63eb039d-9039-4e6c-a1a2-924e348c18c1",
   "added":"2018-12-07 09:59:39",
   "finished":"2018-12-07 09:59:40",
   "user_account":null,
   "progress":100,
   "data":[
      {
         "task_id":198,
         "source":"ceidg",
         "method":"data",
         "params":{
            "nip":"123123123"
         },
         "meta":null,
         "result":{
            "first_name":"ANNA MARIA",
            "last_name":"KRZECZKOWSKA",
            "nip":"123123123",
            "regon":"123123123",
            "company_name":"Wypożyczalnia samochodów AM KRZECZKOWSKA",
            "company_status":"Aktywny",
            "beginning_date":"2018-01-10",
            "suspended_from_date":null,
            "suspended_to_date":null,
            "resumption_date":null,
            "ending_date":null,
            "deletion_legal_basis":null,
            "legal_basis_details":null,
            "cancellation":null,
            "has_community_of_goods":"0",
            "main_pkd":"9609Z",
            "nationality":null,
            "phone":"+48 100 001 001",
            "fax":null,
            "www":null,
            "email":"am.krzeczkowska.wypozyczalnia@wp.pl",
            "main_address":{
               "street":"ul. Nowy Świat",
               "number":"443",
               "local":"42",
               "commune":"Lutowiska",
               "county":"ustrzycki",
               "region":"PODKARPACKIE",
               "post":"Lutowiska",
               "postcode":"10-001",
               "city":"Lutowiska"
            },
            "postal_address":{
               "street":"ul. Nowy Świat",
               "number":"443",
               "local":"42",
               "commune":"Lutowiska",
               "county":"ustrzycki",
               "region":"PODKARPACKIE",
               "post":"Lutowiska",
               "postcode":"10-001",
               "city":null
            },
            "in_civil_partnership":"1",
            "civil_partnership_details":[
               {
                  "nip":"121212121",
                  "regon":"121212121",
                  "activity_suspended":null,
                  "partners_nip_numbers":[
                     "121212121",
                     "121212121"
                  ]
               },
               {
                  "nip":"121212121",
                  "regon":null,
                  "activity_suspended":null,
                  "partners_nip_numbers":[
                     "121212121"
                  ]
               }
            ],
            "permissions":[

            ],
            "restrictions":[
               {
                  "description":"Tak",
                  "period":"5 lat",
                  "institution":"Sąd Rejonowy w Lesku ",
                  "file_number":"VI Lsk 1/1",
                  "type":"Zakaz prowadzenia działalności gospodarczej",
                  "ruling_date":"2015-01-11",
                  "effective_date":"2015-02-02"
               }
            ],
            "agents":[
               {
                  "name":"Erazm Kowalski",
                  "nip":null,
                  "permissions":"zmiana wpisu,wpis informacji o zawieszeniu wykonywania działalności gospodarczej,wpis informacji o wznowieniu wykonywania działalności gospodarczej,wniosek o wykreślenie wpisu w CEIDG,prowadzenie spraw za pośrednictwem punktu kontaktowego"
               }
            ],
            "extra_addresses":[
               {
                  "street":"ul. Bolesława Krzywoustego",
                  "number":"26",
                  "local":"8",
                  "county":"Szczecin",
                  "region":"ZACHODNIOPOMORSKIE",
                  "post":"Szczecin",
                  "postcode":"70-316",
                  "city":"Szczecin"
               }
            ]
         }
      }
   ]
}

TD - Wyciąg CEIDG PDF

Źródło umożliwia pobranie pełnych wyciągów z CEIDG w formie plików PDF.

Przykładowe zapytanie

{
   "source":"ceidg",
   "method":"pdf",
   "params":{
      "nip":"123123123"
   }
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "63eb039d-9039-4e6c-a1a2-924e348c18c1"
}

W celu pobrania danych, należy wykorzystać zwrócony identyfikator.

curl --user:pass  https://api.transparentdata.pl/key/result?ident=63eb039d-9039-4e6c-a1a2-924e348c18c1

W ramach odpowiedzi, użytkownik otrzyma zakodowany w Base64 plik z wyciągiem.

Przykładowy zestaw danych wywołując metode /result

{
   "status":"done",
   "ident":"63eb039d-9039-4e6c-a1a2-924e348c18c1",
   "added":"2018-12-07 09:59:39",
   "finished":"2018-12-07 09:59:40",
   "user_account":null,
   "progress":100,
   "data":[
      {
         "task_id":171,
         "source":"ceidg",
         "method":"pdf",
         "params":{
            "nip":"123123123"
         },
         "meta":null,
         "result":{
            "file":"JVBERJGLCB....T0YK",
            "added":"2018-11-09 14:56:19"
         }
      }
   ]
}

TD - AML JSON

Źródło umożliwia pobranie danych o beneficjentach rzeczywistych i ich obecności na listach osób eksponowanych politycznie (PEP) i listach sankcyjnych. Dane źródłowe pochodzą z Centralnego Rejestru Beneficjentów Rzeczywistych (CRBR), rejestrów KRS i CEIDG, 9 bazach PEP, oraz na 38 największych światowych listach sankcji.

Bazy PEP

Listy sankcyjne

Request

Przykładowe zapytanie

{  
   "source":"aml_summary",
   "method":"get",
   "params":{  
      "nip":"123123123",
   },
   "version": "1.0.0"
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "def768c7-3940-42b2-aed7-cc8462d76edc"
}
Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 source nazwa źródła danych string aml_summary wymagane
2 method nazwa metody źródła danych string get wymagane
3 params parametry zapytania tablica (array) wymagane
4 nip numer nip podmiotu int numer NIP wymagane

Przykładowe wywołanie metody /result

curl --user:pass  https://api.transparentdata.pl/key/result?ident=def768c7-3940-42b2-aed7-cc8462d76edc

W celu pobrania danych, należy wykorzystać zwrócony identyfikator.

Response

Przykładowy zestaw danych wywołując metode /result

{  
   "status": "done",
   "ident": "def768c7-3940-42b2-aed7-cc8462d76edc",
   "user_account": null,
   "progress": 100,
    "data": [
        {
            "task_id": 3357439,
            "source": "aml_summary",
            "method": "get",
            "params": {
                "nip": "123123123"
            },
            "meta": null,
            "result": [
                {
                    "source": "crbr",
                    "pesel": "57*********",
                    "name": "DANUTA ******",
                    "relation_type": "Beneficjent rzeczywisty",
                    "ownership_rights_type": "Uprawnienia bezpośrednie",
                    "ownership_rights_name": "wspólnik spółki jawnej",
                    "privilege_name": "ponadproporcjonalny udział w zysku w stosunku do proporcji wkładu do spółki",
                    "privilege_description": "15 % UDZIAŁÓW W SPÓŁCE",
                    "shares": 150,
                    "pep_list_name": "PepTDataSource",
                    "pep_list_details": "Poseł RP (kadencja IX)",
                    "sanction_list_name": "Sprawdzono: brak wyników",
                    "sanction_list_details": "Sprawdzono: brak wyników"
                },
                {
                    "source": "crbr",
                    "pesel": "57*********",
                    "name": "ELŻBIETA **********",
                    "relation_type": "Beneficjent rzeczywisty",
                    "ownership_rights_type": "Uprawnienia bezpośrednie",
                    "ownership_rights_name": "wspólnik spółki jawnej",
                    "privilege_name": "ponadproporcjonalny udział w zysku w stosunku do proporcji wkładu do spółki",
                    "privilege_description": "85% UDZIAŁÓW W SPÓŁCE",
                    "shares": 850,
                    "pep_list_name": "Sprawdzono: brak wyników",
                    "pep_list_details": "Sprawdzono: brak wyników",
                    "sanction_list_name": "Sprawdzono: brak wyników",
                    "sanction_list_details": "Sprawdzono: brak wyników"
                }
            ]
        }
    ]
}
Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 status status wykonania zadania string done (wykonane), quened (dodane do kolejki), in_progress (w trakcie wykonywania), error (błąd przetwarzania) wymagane
2 ident unikalny numer identyfikacyjny nadany przy zapytaniu string wymagane
3 user_account nazwa konta użytkownika string nazwa konta/null wymagane
4 progress procentowy stopień ukończenia zadania int 0-100 wymagane
5 data tablica z danymi tablica (array) wymagane
6 task_id indywidualny numer id nadany podczas tworzenia zadania int wymagane
7 source nazwa źródła danych string aml_summary wymagane
8 method nazwa metody źródła danych string get wymagane
9 params parametry zapytania tablica (array) wymagane
10 nip numer nip podmiotu int numer NIP wymagane
11 meta metatagi string/null wymagane
12 result rezultat zapytania tablica (array) wymagane
13 source źródło z którego pochodzą dane o beneficjentach string crbr/krs/ceidg wymagane
14 pesel numer pesel beneficjenta string PESEL/pusty ciąg wymagane
15 name imię i nazwisko beneficjenta string imię i nazwisko wymagane
16 relation_type typ beneficjenta string Beneficjent rzeczywisty/Reprezentant/pusty ciąg wymagane
17 ownership_rights_type typ uprawnień beneficjenta string tekst/pusty ciąg wymagane
18 ownership_rights_name nazwa uprawnień beneficjenta string tekst/pusty ciąg wymagane
19 privilege_name nazwa przywileju beneficjenta string tekst/pusty ciąg wymagane
20 privilege_description opis przywileju beneficjenta string tekst/pusty ciąg wymagane
21 shares liczba udziałów int liczba udziałów/null wymagane
22 pep_list_name nazwa listy pep string tekst/Sprawdzono: brak wyników wymagane
23 pep_list_details opis z listy pep string tekst/Sprawdzono: brak wyników wymagane
24 sanction_list_name nazwa listy sankcyjnej string tekst/Sprawdzono: brak wyników wymagane
25 sanction_list_details opis z listy sankcyjnej string tekst/Sprawdzono: brak wyników wymagane

TD - Listy sankcyjne JSON

Źródło umożliwia pobranie informacji o obecności danej osoby fizycznej na 38 największych światowych listach sankcji w formacie JSON.

Listy sankcyjne

Przykładowe zapytanie

{  
   "source":"aml_sanction",
   "method":"check",
   "params":{  
      "name":"Jan Kowalski"
   },
   "version" : "1.0.0"
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "63eb039d-9039-4e6c-a1a2-924e348c18c1"
}

W celu pobrania danych, należy wykorzystać zwrócony identyfikator.

curl --user:pass  https://api.transparentdata.pl/key/result?ident=63eb039d-9039-4e6c-a1a2-924e348c18c1

Przykładowy zestaw danych wywołując metode /result

"Jan Kowalski","Sprawdzono: brak wyników","Sprawdzono: brak wyników"

TD - PEP JSON

Źródło umożliwia pobranie informacji o obecności danej osoby fizycznej w 9 bazach osób eksponowanych politycznie (PEP) w formacie JSON.

Dane zwracane są na podstawie następujących baz PEP:

Przykładowe zapytanie

{
   "source":"pep",
   "method":"check",
   "params":{
      "name":"Andrzej Duda"
   },
   "version" : "1.0.0"
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "fcb5ee35-5172-42d1-916b-c5fa442fabee"
}

W celu pobrania danych, należy wykorzystać zwrócony identyfikator.

curl --user:pass  https://api.transparentdata.pl/key/result?ident=fcb5ee35-5172-42d1-916b-c5fa442fabee

Przykładowy zestaw danych wywołując metode /result

Przykładowa odpowiedź

{
    "status": "done",
    "ident": "fcb5ee35-5172-42d1-916b-c5fa442fabee",
    "user_account": null,
    "progress": 100,
    "data": [
        {
            "task_id": 14199,
            "source": "pep",
            "method": "check",
            "params": {
                "name": "Andrzej Duda"
            },
            "meta": null,
            "result": {
                "list_name": "Znaleziono: PepTDataSource",
                "list_details": "Prezydent RP"
            }
        }
    ]
}

TD - Beneficjent rzeczywisty PL JSON

Źródło umożliwia pobranie danych o beneficjencie rzeczywistym firm z Polski w formacie JSON. Informacje (imię i nazwisko, numer PESEL beneficjenta rzeczywistego wraz ze wskazaniem procentu udziałów) pochodzą z powiązanych rejestrów KRS i CEIDG oraz Centralnego Rejestru Beneficjentów Rzeczywistych.

Request

Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 source nazwa źródła danych string beneficiary wymagane
2 method nazwa metody źródła danych dla odpisu krs json string getPl wymagane
3 params parametry zapytania węzeł wymagane
4 nip numer nip firmy int 10 cyfrowy numer NIP wymagane
5 includeCEIDGData parametr określający czy brane pod uwagę powinny być podmioty z rejestru CEIDG bool niewymagane - domyślna wartość true
6 version oznaczenie wersji zamówienia string 1.0.0 wymagane

Przykładowe zapytanie

{  
   "source": "beneficiary",
   "method": "getPl",
   "params": {  
      "nip": "123123123",
      "includeCEIDGData": true
   },
   "version": "1.0.0"
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "63eb039d-9039-4e6c-a1a2-924e348c18c1"
}

W celu pobrania danych, należy wykorzystać zwrócony identyfikator.

curl --user:pass  https://api.transparentdata.pl/key/result?ident=63eb039d-9039-4e6c-a1a2-924e348c18c1

Response

Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 status status wykonania zadania string done (wykonane), quened (dodane do kolejki), in_progress( w trakcie wykonywania), error (błąd podczas próby generowania) wymagane
2 ident unikalny numer identyfikacyjny nadany przy zapytaniu string wymagane
3 added data zapytania string data(format Y-m-d H:i:s) wymagane
4 finished data wykonania string data(format Y-m-d H:i:s) wymagane
5 user_account nazwa konta użytkownika string/nullable ciąg tekstowy/null wymagane
6 progress procentowa ilość wykonania zadania int 0-100 wymagane
7 data tablica z danymi tablica(array) wymagane
8 task_id indywidualny numer id nadany podczas tworzenia zadania int wymagane
9 source nazwa źródła danych string KRS/CRBR wymagane
10 method nazwa metody źródła danych dla odpisu KRS/CRBR json string data wymagane
11 params parametry zapytania węzeł wymagane
12 nip numer nip firmy int 10 cyfrowy numer NIP wymagane
13 meta metatagi string null wymagane
14 result rezultat zapytania węzeł wymagane
15 beneficiaries tablica z wykazem listy beneficjentów tablica(array) wymagane
16 pesel numer pesel beneficjenta int/empty liczba/pusty ciąg wymagane
17 percentage procentowa wartość float/nullable liczba/null wymagane
18 name imię i nazwisko string/nullable ciąg tekstowy/null wymagane

Przykładowy zestaw danych wywołując metode /result

{  
   "status":"done",
   "ident":"63eb039d-9039-4e6c-a1a2-924e348c18c1",
   "added":"2018-12-07 09:59:39",
   "finished":"2018-12-07 09:59:40",
   "user_account":null,
   "progress":100,
    "data": [
        {
            "task_id": 198,
            "source": "beneficiary",
            "method": "getPl",
            "params": {
                "nip": "123123123"
            },
            "meta": null,
            "result": {
                "beneficiaries": [
                    {
                        "pesel": "xxxxxxxxxxxxx",
                        "percentage": 66.67,
                        "name": "BOGDAN TRZMIEL"
                    },
                    {
                        "pesel": "xxxxxxxxxxxxx",
                        "percentage": 33.33,
                        "name": "KALINA NOWAK"
                    }
                ]
            }
        }
    ]
}

TD - Status płatnika VAT

Źródło danych umożliwiające sprawdzenie czy podmiot jest czynnym płatnikiem VAT.

Request

Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości Wymagalność
1 source nazwa źródła danych string vat_status wymagane
2 method nazwa metody string get wymagane
3 params parametry zapytania węzeł wymagane
4 nip numer nip int numer NIP wymagane
5 date data, dla której status ma zostać sprawdzony date data w formacie RRRR-MM-DD niewymagane

Przykładowe zapytanie

{  
   "source":"vat_status",
   "method":"data",
   "params":{
      "nip":"1234567890",
      "date":"2021-10-02"
   },
   "version": "1.0.0"
}

Przykładowa odpowiedź

{
    "status": "quened",
    "ident": "d0615f2e-4555-49b4-9d76-4837fd7a3aee"
}

Korzystając ze zwróconego identyfikatora można pobrać przygotowany zestaw danych.

curl --user:pass  https://api.transparentdata.pl/key/result?ident=d0615f2e-4555-49b4-9d76-4837fd7a3aee

W odpowiedzi otrzymamy dane w formacie json zawierające informacje o statusie VAT sprawdzanego podmiotu.

Nr Nazwa Pola Opis Pola Format zmiennej Dopuszczalne kategorie wartości
1 status status wykonania zadania string done (wykonane), quened (dodane do kolejki), in_progress (w trakcie wykonywania), error (błąd podczas próby generowania)
2 ident unikalny numer identyfikacyjny nadany przy zapytaniu string
3 status status płatnika VAT string Czynny/Zwolniony/Niezarejestrowany/Nie figuruje w rejestrze VAT/Brak danych
4 date data, dla której status został sprawdzony string data w formacie RRRR-MM-DD
5 up_to_date informacja czy dane są aktualne czy zostały pobrane z bazy TD bool
6 last_check_date Data ostatniej aktualizacji danych w bazie TD string

Przykładowy zestaw danych wywołując metode /result

{
  "status": "done",
  "ident": "d0615f2e-4555-49b4-9d76-4837fd7a3aee",
  "user_account": null,
  "progress": 100,
  "data": [
    {
      "task_id": 489,
      "source": "vat_status",
      "method": "data",
      "params": {
        "nip": "1234567890"
      },
      "meta": null,
      "result": {
        "status": "Czynny",
        "date": "2021-10-02",
        "up_to_date": true,
        "last_check_date": "2023-10-20 14:47:31"
      }
    }
  ]
}
Curl