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 - 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 - 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 | 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 v1.0.0
Ź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
- Baza własna PEP Polska Transparent Data,
- CIA Factbook World Leaders
- Every Politician
- Members of EU Parliament
- Members of the European Committee of the Regions
- Peppercat Legislators
- Peppercat World Leaders
- Rulers
- RuPEP Public Database of PEPs in Russia and Belarus
Listy sankcyjne
- AR: Argentine RePET
- AUS: Australian Sanctions Consolidated List
- AZ: Azerbaijan Domestic List
- BE: Belgian Financial Sanctions
- BE: Consolidated List of the National Belgian List and of the List of European Sanctions
- BG: Bulgarian Persons of Interest
- CAN: Canadian Listed Terrorist Entities
- CAN: Canadian Special Economic Measures Act Sanctions
- CAN: Consolidated Canadian Autonomous Sanctions List
- CH: Swiss SECO Sanctions/Embargoes
- EU: Common Foreign and Security Policy (CFSP) of the European Union (Sanctions EU)
- EU: EU Consolidated Travel Bans
- EU: EU Financial Sanctions Files (FSF)
- EU: EU Sanctions Map European Union
- FR: National Freeze Registry (Liste Unique de Gels de la Direction générale du Trésor)
- IL: Israel Terrorists Organizations and Unauthorized Associations lists
- IN: Indian Ministry of Home Affairs Banned Organizations
- JP: Japan Economic sanctions and list of eligible people
- KG: Kyrgyz National List
- KZ: Kazakh Terror Financing list
- NL: Dutch National Sanctionlist Terrorism
- NZ: New Zealand Russia Sanctions
- ONZ: United Nations Security Council Consolidated List
- PL: Polish list of persons and entities subject to sanctions (MSWiA)
- QA: Qatar Unified Record of Persons and Entities on Sanction List
- RU: Rosfinmonitoring WMD-related entities
- SIN: Singapore Targeted Financial Sanctions
- UA: Ukraine NABC Sanctions Tracker
- UA: Ukraine National Security Sanctions
- UA: Ukraine SFMS Blacklist
- UAE: United Arab Emirates Local Terrorist List
- UK: Insolvency Disqualified Directors
- UK: UK OFSI Consolidated List of Targets
- UN: UN Security Council Consolidated Sanctions
- USA: US BIS Denied Persons List
- USA: US OFAC Consolidated (non-SDN) List
- USA: US OFAC Foreign Sanctions Evaders (FSE) List (U.S. Treasury)
- USA: US OFAC Specially Designated Nationals (SDN) List
- USA: US State Department Cuba Sanctions
- USA: US Trade Consolidated Screening List
- ZA: South African Targeted Financial Sanctions
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 - AML JSON v2.0.0
Źródło umożliwia pobranie danych o beneficjentach rzeczywistych i ich obecności na listach sankcyjnych, po kontakcie z działem sprzedaży możliwe pobranie informacji o obecności danej osoby fizycznej w bazach osób eksponowanych politycznie (PEP). Dane źródłowe pochodzą z Centralnego Rejestru Beneficjentów Rzeczywistych (CRBR), rejestrów KRS i CEIDG, największych światowych listach sankcji, oraz opcjonalnie z baz PEP (edited)
Change Log
Data | Numer wersji | Opis zmian |
---|---|---|
08.06.2022 | 2.0.0 | rozszerzenie informacji w zwracanych danych |
- | 1.0.0 | dodanie zamówienia do DataIntegratora |
Stare wersje API
Numer wersji | Link |
---|---|
1.0.0 | Dokumentacja |
Request
Przykładowe zapytanie
{
"source":"aml_summary",
"method":"get",
"params": {
"number":"123123123"
},
"version": "2.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 | number | numer nip, krs, lub regon podmiotu | int | numer NIP, KRS lub REGON | wymagane |
5 | version | numer wersji API | string | 2.0.0 (domyślna wartość) | opcjonalne |
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 metodę /result
{
"status": "done",
"ident": "def768c7-3940-42b2-aed7-cc8462d76edc",
"user_account": null,
"progress": 100,
"data": [
{
"task_id": 3357439,
"source": "aml_summary",
"method": "get",
"params": {
"number": "123123123"
},
"version": "2.0.0",
"meta": null,
"result": [
{
"source": "crbr",
"krs": "00000*****",
"nip": "66317*****",
"regon": null,
"company_name": "PRZEDSIĘBIORSTWO TELEINFORMATYCZNE **********",
"company_address": "LEGIONÓW **********",
"pesel": "71*********",
"country_of_citizenship": "PL",
"name": "WOJCIECH ********",
"relation_type": "Beneficjent rzeczywisty",
"ownership_rights_type": "Inne uprawnienia",
"ownership_rights_name": "PREZES ZARZĄDU SPÓŁKI POLSKI HOLDING OBRONNY SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"privilege_name": null,
"privilege_description": null,
"shares": null,
"relations": null,
"validated": 1,
"pep_list": [
{
"name": "WOJCIECH ********",
"date": "1971-**-**",
"searched_by": "name and date",
"full_name": "WOJCIECH ********",
"last_name": "******",
"first_name": "WOJCIECH",
"middle_name": "*****",
"year_of_birth": "1971",
"month_of_birth": "**",
"day_of_birth": "**",
"list": "PepPlStateTreasuryCompaniesSource",
"details": "członek Rady Nadzorczej spółki Skarbu Państwa",
"subject_type": "individual",
"date_from": "",
"date_till": "",
"checked": "2022-06-08"
}
],
"sanction_list": [
{
"name": "WOJCIECH *****",
"date": "1971-**-**",
"searched_by": "name",
"full_name": "",
"last_name": "",
"first_name": "",
"middle_name": "",
"year_of_birth": "",
"month_of_birth": "",
"day_of_birth": "",
"list": "Sprawdzono: brak wyników",
"details": "Sprawdzono: brak wyników",
"subject_type": "",
"checked": "2022-06-08"
}
]
}
]
}
]
}
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 | number | 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 pochodzenia danych | string | crbr/krs/ceidg | wymagane |
14 | krs | numer krs sprawdzanego podmiotu | string/nullable | wymagane | |
15 | nip | numer nip sprawdzanego podmiotu | string/nullable | wymagane | |
16 | regon | numer regon sprawdzanego podmiotu | string/nullable | wymagane | |
17 | company_name | nazwa sprawdzanego podmiotu | string | wymagane | |
18 | company_address | adres sprawdzanego podmiotu | string | wymagane | |
19 | pesel | numer pesel beneficjenta | string/null | wymagane | |
20 | country_of_citizenship | obywatelstwo beneficjenta | string | wymagane | |
21 | name | imię/imiona i nazwisko beneficjenta | string | wymagane | |
22 | relation_type | Rodzaj relacji/funkcja | string | wymagane | |
23 | ownership_rights_type | Rodzaj uprawnień/organ uprawniony do reprezentacji | string | wymagane | |
24 | ownership_rights_name | Opis uprawnień/sposób reprezentacji podmiotu | string | wymagane | |
25 | privilege_name | Raodzaj uprzywilejowania | string | wymagane | |
26 | privilege_description | Opis uprzywilejowania | string | wymagane | |
27 | shares | wartość udziałów | string | wymagane | |
28 | relations | Relacje przez podmiot powiązany | string | wymagane | |
29 | validated | wynik walidacji (0 oznacza, że nie ma niezgodności między rejestrem krs i crbr, 1 - że jest niezgodność między rejestrami) | int | 0/1 | wymagane |
30 | pep_list | resultat z wpisami z list osób eksponowanych politycznie | tablica (array) | wymagane | |
31 | pep_list[name] | wyszukiwana fraza | string | wymagane | |
32 | pep_list[date] | wyszukiwana data | date | wymagane | |
33 | pep_list[searched_by] | sposób szukania (po frazie: name, lub po frazie i dacie: name and date) | string | name/name and date | wymagane |
34 | pep_list[full_name] | pełna nazwa znalezionej osoby/podmiotu | string | wymagane | |
35 | pep_list[last_name] | nazwisko szukanej osoby | string | wymagane | |
36 | pep_list[first_name] | imię szukanej osoby | string | wymagane | |
37 | pep_list[middle_name] | drugie imię szukanej osobie | string | opcjonalne | |
38 | pep_list[year_of_birth] | rok urodzenia szukanej osoby | string | opcjonalne | |
39 | pep_list[month_of_birth] | miesiąć urodzenia szukanej osoby | string | opcjonalne | |
40 | pep_list[day_of_birth] | dzień urodzenia szukanej osoby | string | opcjonalne | |
41 | pep_list[list] | lista na których dany wpis został znaleziony | string | wymagane | |
42 | pep_list[details] | szczegółowy tekst wpisu | string | wymagane | |
43 | pep_list[subject_type] | typ podmiotu (osoba, podmiot, statek) | string | individual/entity/vessel | wymagane |
44 | pep_list[date_from] | data od której dana osoba została wpisana na listę | date | opcjonalne | |
45 | pep_list[date_till] | data od której dana osoba została wykreślona z listy | date | opcjonalne | |
46 | pep_list[checked] | data sprawdzenia | date | wymagane | |
47 | sanction_list | resultat z wpisami z list osób na listach sankcyjnych | tablica (array) | wymagane | |
48 | sanction_list[name] | wyszukiwana fraza | string | wymagane | |
49 | sanction_list[date] | wyszukiwana data | date | wymagane | |
50 | sanction_list[searched_by] | sposób szukania (po frazie: name, lub po frazie i dacie: name and date) | string | name/name and date | wymagane |
51 | sanction_list[full_name] | pełna nazwa znalezionej osoby/podmiotu | string | wymagane | |
52 | sanction_list[last_name] | nazwisko szukanej osoby | string | wymagane | |
53 | sanction_list[first_name] | imię szukanej osoby | string | wymagane | |
54 | sanction_list[middle_name] | drugie imię szukanej osobie | string | opcjonalne | |
55 | sanction_list[year_of_birth] | rok urodzenia szukanej osoby | string | opcjonalne | |
56 | sanction_list[month_of_birth] | miesiąć urodzenia szukanej osoby | string | opcjonalne | |
57 | sanction_list[day_of_birth] | dzień urodzenia szukanej osoby | string | opcjonalne | |
58 | sanction_list[list] | lista na których dany wpis został znaleziony | string | wymagane | |
59 | sanction_list[details] | szczegółowy tekst wpisu | string | wymagane | |
60 | sanction_list[subject_type] | typ podmiotu (osoba, podmiot, statek) | string | individual/entity/vessel | wymagane |
61 | sanction_list[checked] | data sprawdzenia | date | wymagane |
TD - KRS CEIDG REGON JSON
Źródło umożliwia pobranie wszystkich danych o podmiocie z rejestru KRS, CEIDG oraz REGON w formacie JSON.
Parametr przyjmowany na wejściu nip
. Jest to numer NIP.
W celu pobrania danych, należy wykorzystać zwrócony identyfikator.
Przykładowe zapytanie
{
"source":"krs_ceidg_regon",
"method":"data",
"params":{
"nip":"123123123"
},
"version":"1.0.0"
}
Przykładowa odpowiedź
{
"status": "quened",
"ident": "9903039d-63eb-4e6c-a3a6-48c18c1924e3"
}
curl --user:pass https://api.transparentdata.pl/key/result?ident=9903039d-63eb-4e6c-a3a6-48c18c1924e3
Przykładowy zestaw danych wywołując metode /result
{
"status": "done",
"ident": "8e8e269d-cf52-488a-a7c7-9564aac5a2b2",
"user_account": null,
"progress": 100,
"data": [
{
"task_id": 1179897,
"source": "krs_ceidg_regon",
"method": "data",
"params": {
"nip": "1231231231"
},
"version":"1.0.0",
"meta": null,
"result": {
"krs": {
"data_acquisition_date": "2021-03-21 12:51:19",
"name": "JAN NOWAK SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"legal_form": "SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"krs": "3213213213",
"nip": "1231231231",
"regon": "2123123123",
"company_status": "Aktywny",
"address": {
"street": "ul. Przykładowa",
"number": "1",
"local": "5",
"postcode": "60-100",
"post": "POZNAŃ",
"city": "POZNAŃ",
"county": "POZNAŃ",
"region": "WIELKOPOLSKIE",
"country": "POLSKA"
},
"equity": "5000.00",
"stock": {
"quantity": null,
"value": null
},
"incorporation": "2017-06-22",
"created_at": "2017-06-20",
"last_registry_update": "2020-09-22",
"removed_at": null,
"opp": false,
"opp_start": null,
"pkd": "6312Z",
"representation": "DO SKŁADANIA OŚWIADCZEŃ W IMIENIU SPÓŁKI WYMAGANE JEST WSPÓŁDZIAŁANIE DWÓCH\nCZŁONKÓW ZARZĄDU LUB CZŁONKA ZARZĄDU Z PROKURENTEM.",
"representation_body": "ZARZĄD",
"supervisory_authority": null,
"in_bankruptcy": false,
"liquidation_start": null,
"liquidation_end": null,
"liquidation_representation": null,
"court": {
"name": "SĄD REJONOWY POZNAŃ - NOWE MIASTO I WILDA W POZNANIU, VIII WYDZIAŁ GOSPODARCZY KRAJOWEGO REJESTRU SĄDOWEGO",
"ident": "PO.VIII NS-REJ.KRS/12312/12/123"
},
"www": null,
"email": null,
"relation": [
{
"name": "JAN NOWAK",
"first_name": "JAN",
"last_name": "NOWAK",
"relation": "shareholder",
"relation_extra_info": "120 UDZIAŁÓW O ŁĄCZNEJ WARTOŚCI 3.000,00 ZŁ",
"shares": {
"quantity": "120.00",
"value": "3000.00"
},
"ident": {
"name": "pesel",
"value": "12312312312"
}
},
{
"name": "ADAM KOWALSKI",
"first_name": "ADAM",
"last_name": "KOWALSKI",
"relation": "shareholder",
"relation_extra_info": "15 UDZIAŁÓW O ŁĄCZNEJ WARTOŚCI 700,00 ZŁ",
"shares": {
"quantity": "15.00",
"value": "700.00"
},
"ident": {
"name": "pesel",
"value": "32132132132"
}
}
],
"debts": []
},
"ceidg": {
"first_name": "JAN",
"last_name": "NOWAK",
"nip": "1231231231",
"regon": "2123123123",
"company_name": "JAN NOWAK",
"company_status": "Aktywny",
"beginning_date": "2007-10-01",
"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": "5812Z,6201Z,6202Z,6391Z,6399Z,8299Z",
"nationality": "Polska",
"phone": null,
"fax": null,
"www": null,
"email": null,
"main_address": {
"street": "ul. Przykładowa",
"number": "1",
"local": 5,
"commune": "POZNAŃ",
"county": "POZNAŃ",
"region": "WIELKOPOLSKIE",
"post": "POZNAŃ",
"postcode": "60-100",
"city": "POZNAŃ"
},
"postal_address": {
"street": "ul. Przykładowa",
"number": "1",
"local": 5,
"commune": "POZNAŃ",
"county": "POZNAŃ",
"region": "WIELKOPOLSKIE",
"post": "POZNAŃ",
"postcode": "60-100",
"city": "POZNAŃ"
},
"in_civil_partnership": "0",
"civil_partnership_details": [],
"permissions": [],
"restrictions": [],
"agents": [],
"extra_addresses": []
},
"regon": {
"last_update": "2021-03-29 11:45:37",
"regon": "2123123123",
"nip": "1231231231",
"podstawowa_forma_prawna": "1",
"szczegolna_forma_prawna": "117",
"forma_wlasnosci": null,
"nazwa": "JAN NOWAK SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"imie": null,
"nazwisko": null,
"company_status": "aktywna",
"data_wpisu": "2017-06-23",
"data_wpisu_do_rejestru_ewidencji": "2017-06-22",
"data_skreslenia_z_rejestru_ewidencji": null,
"data_zakoczenia_postepowania_upadlosciowego": null,
"data_powstania": "2017-06-22",
"data_rozpoczecia_dzialanosci": "2017-06-22",
"data_zawieszenia": null,
"data_wznowienia": null,
"data_zakonczenia": null,
"data_wykreslenia": null,
"data_orzeczenia_upadlosci": null,
"kraj": "PL",
"wojewodztwo_kod": "30",
"powiat_kod": "64",
"gmina_kod": "039",
"kod_pocztowy": "60-100",
"teryt_poczta": "0969586",
"teryt_miejscowosc": "0969586",
"teryt_ulica": "12740",
"ulica": "ul. Przykładowa",
"nr_budynku": "1",
"nr_lokalu": "5",
"miejscowosc": "Poznań",
"nietypowe_miejsce_lokalizacji": null,
"poczta": "Poznań",
"gmina": "Poznań-Jeżyce",
"powiat": "Poznań",
"wojewodztwo": "WIELKOPOLSKIE",
"nazwa_kraju": "POLSKA",
"organ_rejestrowy": "SĄD REJONOWY POZNAŃ - NOWE MIASTO I WILDA W POZNANIU, VIII WYDZIAŁ GOSPODARCZY KRAJOWEGO REJESTRU SĄDOWEGO",
"rodzaj_rejestru": "REJESTR PRZEDSIĘBIORCÓW",
"numer_rejestrowy": "0000123123",
"jednostek_lokalowych": "0",
"dzialanosci": "0",
"wspolnicy": "0",
"pkd_glowne": "6312Z",
"pkd_pozostale": "5812Z,6201Z,6202Z,6391Z,6399Z,8299Z",
"telefon": null,
"telefon_wew": null,
"fax": null,
"email": null,
"www": null,
"typ_wpisu": "p",
"silos": "6",
"nip_status": null,
"podstawowa_forma_prawna_nazwa": "OSOBA PRAWNA",
"szczegolna_forma_prawna_nazwa": "SPÓŁKI Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"forma_wlasnosci_nazwa": null,
"forma_finansowania_nazwa": "JEDNOSTKA SAMOFINANSUJĄCA NIE BĘDĄCA JEDNOSTKĄ BUDŻETOWĄ LUB SAMORZĄDOWYM ZAKŁADEM BUDŻETOWYM",
"nazwa_skrocona": null,
"data_zaistnienia_zmiany": "2020-09-22",
"organ_zalozycielski": null,
"organ_zalozycielski_kod": null,
"organ_rejestrowy_kod": "012312312",
"regony_jednostek_lokalnych": null,
"regony_wspolnikow_spolki_cywilnej": null,
"nie_podjeto_dzialalnosci": null,
"rodzaj_rejestru_kod": "138",
"jednostki_lokalne": [
{
"regon": "01231231231230",
"nazwa": "JAN NOWAK",
"silos": "1",
"kraj": "PL",
"wojewodztwo_kod": "02",
"powiat_kod": "64",
"gmina_kod": "059",
"kod_pocztowy": "50-080",
"teryt_poczta": "0986946",
"teryt_miejscowosc": "0986946",
"teryt_ulica": "18023",
"nr_budynku": "527",
"nr_lokalu": "6",
"nietypowe_miejsce_lokalizacji": null,
"wojewodztwo": "DOLNOŚLĄSKIE",
"powiat": "m. Wrocław",
"gmina": "Wrocław-Stare Miasto",
"miejscowosc": "Wrocław",
"poczta": "Wrocław",
"ulica": "ul.Długa",
"data_powstania": "2012-06-22",
"data_rozpoczecia_dzialanosci": "2012-06-22",
"data_wpisu": "2012-06-25",
"data_zawieszenia": null,
"data_wznowienia": null,
"data_zakonczenia": "2016-02-04",
"data_wykreslenia": "2016-02-09"
},
{
"regon": "01231231231231",
"nazwa": "JAN NOWAK",
"silos": "1",
"kraj": "PL",
"wojewodztwo_kod": "02",
"powiat_kod": "64",
"gmina_kod": "069",
"kod_pocztowy": "50-234",
"teryt_poczta": "0986952",
"teryt_miejscowosc": "0986952",
"teryt_ulica": "20294",
"nr_budynku": "477",
"nr_lokalu": null,
"nietypowe_miejsce_lokalizacji": null,
"wojewodztwo": "DOLNOŚLĄSKIE",
"powiat": "m. Wrocław",
"gmina": "Wrocław-Śródmieście",
"miejscowosc": "Wrocław",
"poczta": "Wrocław",
"ulica": "ul. Krótka",
"data_powstania": "2012-06-22",
"data_rozpoczecia_dzialanosci": "2012-06-22",
"data_wpisu": "2012-06-25",
"data_zawieszenia": null,
"data_wznowienia": null,
"data_zakonczenia": "2015-01-22",
"data_wykreslenia": "2015-01-23"
}
]
}
}
}
]
}
TD - Listy sankcyjne JSON v1.0.0
Ź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
- AR: Argentine RePET
- AUS: Australian Sanctions Consolidated List
- AZ: Azerbaijan Domestic List
- BE: Belgian Financial Sanctions
- BE: Consolidated List of the National Belgian List and of the List of European Sanctions
- BG: Bulgarian Persons of Interest
- CAN: Canadian Listed Terrorist Entities
- CAN: Canadian Special Economic Measures Act Sanctions
- CAN: Consolidated Canadian Autonomous Sanctions List
- CH: Swiss SECO Sanctions/Embargoes
- EU: Common Foreign and Security Policy (CFSP) of the European Union (Sanctions EU)
- EU: EU Consolidated Travel Bans
- EU: EU Financial Sanctions Files (FSF)
- EU: EU Sanctions Map European Union
- FR: National Freeze Registry (Liste Unique de Gels de la Direction générale du Trésor)
- IL: Israel Terrorists Organizations and Unauthorized Associations lists
- IN: Indian Ministry of Home Affairs Banned Organizations
- JP: Japan Economic sanctions and list of eligible people
- KG: Kyrgyz National List
- KZ: Kazakh Terror Financing list
- NL: Dutch National Sanctionlist Terrorism
- NZ: New Zealand Russia Sanctions
- ONZ: United Nations Security Council Consolidated List
- PL: Polish list of persons and entities subject to sanctions (MSWiA)
- QA: Qatar Unified Record of Persons and Entities on Sanction List
- RU: Rosfinmonitoring WMD-related entities
- SIN: Singapore Targeted Financial Sanctions
- UA: Ukraine NABC Sanctions Tracker
- UA: Ukraine National Security Sanctions
- UA: Ukraine SFMS Blacklist
- UAE: United Arab Emirates Local Terrorist List
- UK: Insolvency Disqualified Directors
- UK: UK OFSI Consolidated List of Targets
- UN: UN Security Council Consolidated Sanctions
- USA: US BIS Denied Persons List
- USA: US OFAC Consolidated (non-SDN) List
- USA: US OFAC Foreign Sanctions Evaders (FSE) List (U.S. Treasury)
- USA: US OFAC Specially Designated Nationals (SDN) List
- USA: US State Department Cuba Sanctions
- USA: US Trade Consolidated Screening List
- ZA: South African Targeted Financial Sanctions
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 - Listy sankcyjne JSON v2.0.0
Źródło umożliwia pobranie informacji o obecności danej osoby fizycznej na największych światowych listach sankcji w formacie JSON.
Kraj/Organizacja | Nazwa |
---|---|
AR | Argentine RePET |
AUS | Australian Sanctions Consolidated List |
AZ | Azerbaijan Domestic List |
BE | Belgian Financial Sanctions |
BE | Consolidated List of the National Belgian List and of the List of European Sanctions |
BG | Bulgarian Persons of Interest |
CAN | Canadian Listed Terrorist Entities |
CAN | Canadian Special Economic Measures Act Sanctions |
CAN | Consolidated Canadian Autonomous Sanctions List |
CH | Swiss SECO Sanctions/Embargoes |
EU | Common Foreign and Security Policy (CFSP) of the European Union (Sanctions EU) |
EU | EU Consolidated Travel Bans |
EU | EU Financial Sanctions Files (FSF) |
EU | EU Sanctions Map European Union |
FR | National Freeze Registry (Liste Unique de Gels de la Direction générale du Trésor) |
IL | Israel Terrorists Organizations and Unauthorized Associations lists |
IN | Indian Ministry of Home Affairs Banned Organizations |
JP | Japan Economic sanctions and list of eligible people |
KG | Kyrgyz National List |
KZ | Kazakh Terror Financing list |
NL | Dutch National Sanctionlist Terrorism |
NZ | New Zealand Russia Sanctions |
ONZ | United Nations Security Council Consolidated List |
PL | Polish list of persons and entities subject to sanctions (MSWiA) |
QA | Qatar Unified Record of Persons and Entities on Sanction List |
RU | Rosfinmonitoring WMD-related entities |
SIN | Singapore Targeted Financial Sanctions |
UA | Ukraine NABC Sanctions Tracker |
UA | Ukraine National Security Sanctions |
UA | Ukraine SFMS Blacklist |
UAE | United Arab Emirates Local Terrorist List |
UK | Insolvency Disqualified Directors |
UK | UK OFSI Consolidated List of Targets |
UN | UN Security Council Consolidated Sanctions |
USA | US BIS Denied Persons List |
USA | US OFAC Consolidated (non-SDN) List |
USA | US OFAC Foreign Sanctions Evaders (FSE) List (U.S. Treasury) |
USA | US OFAC Specially Designated Nationals (SDN) List |
USA | US State Department Cuba Sanctions |
USA | US Trade Consolidated Screening List |
ZA | South African Targeted Financial Sanctions |
Change Log
Data | Numer wersji | Opis zmian |
---|---|---|
08.02.2022 | 2.0.0 | rozszerzenie informacji w danych zwracanych |
- | 1.0.0 | dodanie zamówienia do DataIntegratora |
Stare wersje API
Numer wersji | Link |
---|---|
1.0.0 | Dokumentacja |
Przykładowe zapytanie
{
"source":"aml_sanction",
"method":"check",
"params":{
"name":"Abdul-Haq",
"return_data_limit": 2
},
"version" : "2.0.0"
}
Opis parametrów
Nr | Nazwa | Opis |
---|---|---|
1 | name | Wyszukiwana nazwa |
2 | date_of_birth_year | Rok urodzenia szukanej osoby (nie wymagane) |
3 | date_of_birth_month | Miesiąc urodzenia szukanej osoby (nie wymagane) |
4 | date_of_birth_day | Dzień urodzenia szukanej osoby (nie wymagane) |
5 | return_data_limit | limit zwracanych danych (maksymalnie 500) (nie wymagane) |
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
Przykładowa odpowiedź
{
"status": "done",
"ident": "20357cb8-df9e-4e3d-97c7-e2c5fc595d15",
"user_account": null,
"progress": 100,
"data": [
{
"task_id": 4189200,
"source": "aml_sanction",
"method": "check",
"version": "2.0.0",
"params": {
"name": "Abdul-Haq",
"return_data_limit": 2
},
"meta": null,
"result": [
{
"name": "Abdul-Haq",
"date": "",
"searched_by": "name",
"full_name": "Abdul Haq",
"last_name": "",
"first_name": "",
"middle_name": "",
"year_of_birth": "",
"month_of_birth": "",
"day_of_birth": "",
"list": "SanctionsAustraliaFinancialSource",
"details": "",
"subject_type": "individual",
"checked": "2022-03-03"
},
{
"name": "Abdul-Haq",
"date": "",
"searched_by": "name",
"full_name": "Abdul Haq",
"last_name": "",
"first_name": "",
"middle_name": "",
"year_of_birth": "1973",
"month_of_birth": "",
"day_of_birth": "",
"list": "SanctionsAustraliaFinancialSource",
"details": "",
"subject_type": "individual",
"checked": "2022-03-03"
}
]
}
]
}
Opis pól
Nr | Nazwa Pola | Opis Pola |
---|---|---|
1 | name | wyszukiwana nazwa |
2 | date | wyszukiwana data |
3 | searched_by | sposób szukania (name/name and date), |
4 | full_name | pełna nazwa szukanaj osoby |
5 | last_name | nazwisko |
6 | first_name | imię, |
7 | middle_name | drugie imię , |
8 | year_of_birth | rok urodzenia (może być puste) |
9 | month_of_birth | miesiąć urodzenia (może być puste) |
10 | day_of_birth | dzień urodzenia (może być puste) |
11 | list | lista na których wpis został dany znaleziony |
12 | details | szczegóły wpisu |
13 | subject_type | typ individual/entity/vessel |
14 | checked | data sprawdzenia |
15 | tool | nazwa narzędzia |
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:
- Baza własna PEP Polska Transparent Data,
- CIA Factbook World Leaders
- Every Politician
- Members of EU Parliament
- Members of the European Committee of the Regions
- Peppercat Legislators
- Peppercat World Leaders
- Rulers
- RuPEP Public Database of PEPs in Russia and Belarus
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 - Raport Biała Lista JSON
Źródło umożliwia pobranie wszystkich danych z przygotowanych przez Transparent Data Raportów Biała Lista w formacie JSON. W zestawie danych znajdują się informacje zgodne z Wykazem Podatników VAT (tzw. Biała Lista), prowadzonym przez Ministerstwo Finansów, poszerzone o informacje dotyczące właściwości Urzędu Skarbowego oraz identyfikacji banków, w jakich założone są firmowe rachunki bankowe.
Parametr date
nie jest wymagany. W przypadku jego pominięcia zostaną wygenerowane dane na dzień dzisiejszy.
Parametr additional-info
nie jest wymagany. W przypadku jego pominięcia zostaną wygenerowane skrócone dane.
Przykładowe zapytanie
{
"source":"white_list",
"method":"getWhiteList",
"params":{
"nip":"7740001454",
"date": "2019-12-10",
"additional-info": true
}
}
Przykładowa odpowiedź
{
"status": "quened",
"ident": "5dd5a93b-9995-4e3a-b06a-71f10840db69"
}
W celu pobrania danych, należy wykorzystać zwrócony identyfikator.
Przykładowy zestaw danych wywołując metode /result
{
"status": "done",
"ident": "5dd5a93b-9995-4e3a-b06a-71f10840db69",
"user_account": "sample@com.pl",
"progress": 100,
"data": [
{
"task_id": 21,
"source": "white_list",
"method": "getWhiteList",
"params": {
"nip": "7740001454",
"date": "2019-12-10"
},
"meta": {
"type": "file",
"query": "",
"source": ""
},
"result": {
"id": "1001",
"date_status": "2019-12-10",
"nip": "7740001454",
"regon": "610188201",
"krs": "0000028860",
"pesel": null,
"name": "POLSKI KONCERN NAFTOWY ORLEN SPÓŁKA AKCYJNA",
"request_id": "5ljel-85m3j39",
"vat_status": "Czynny",
"working_address": "CHEMIKÓW 7, 09-411 PŁOCK",
"residence_address": null,
"postcode": "09-411",
"registration_legal_date": "2003-12-31",
"registration_denial_date": null,
"registration_denial_basis": null,
"removal_date": null,
"removal_basis": null,
"restoration_date": null,
"restoration_basis": null,
"virtual_account": "1",
"up_to_date": true,
"accounts": {
"Bank Polska Kasa Opieki Spółka Akcyjna": [
"80124054971978000050118306",
"70124011121111001070879914",
"37124031741111000028899332",
"67124052821111000048958743",
"46124031741787001047464116",
"55124031741111001059524978",
"49124052821111000048943547",
"38124052821111001080047440",
"87124031741787000028899358",
"89124031741111001032180939",
"82124052821111000048909585",
"81124042271978000048409900",
"97124062921111001083537159",
"06124052821111000048951887",
"04124052821111000048936015",
"29124062921213001086584127",
"18124031741111000032366066",
"56124042271111000048400835",
"78124052821111000048895107",
"74124054971111000050139066"
],
"mBank Spółka Akcyjna": [
"67114010100000243195001004",
"51114010100000243195001001",
"84114010100000243195001086",
"14114010100000243195001085",
"31114010100000243195001070",
"02114010100000243195001010",
"94114010100000243195001003"
],
"Powszechna Kasa Oszczędności Bank Polski Spółka Akcyjna": [
"03102010260000160202932796",
"53102039740000510200022384",
"60102010260000170202936862",
"35102010260000120203550597",
"48102010260000160202932762",
"53102010260000140202932770",
"40102010260000170203616901",
"55102010260000150202932200",
"14102010260000120202627438",
"97102010260000190202932218",
"58102010260000170203368354",
"30102010260000140203550589",
"85102010260000100203550571",
"19102010260000100202627446",
"59102010260000130202736965"
],
"Bank BGŻ BNP Paribas Spółka Akcyjna": [
"17160011271843983820000030",
"70160011271843983820000046",
"76160011271843983820000035",
"06160011271843983820000034",
"87160011271843983820000031",
"33160011271843983820000033",
"79160011271843983820000078",
"60160011271843983820000032"
],
"ING Bank Śląski Spółka Akcyjna": [
"15105000861000009030137625",
"08105000861000002258724406",
"90105000861000002310281825",
"09105000861000002441871155",
"39105000861000009031675904",
"28105000861000002310281486"
],
"Bank Handlowy w Warszawie Spółka Akcyjna": [
"57103015080000000500101652",
"47103013350000000500101500",
"54103015080000000500101415",
"04103015080000000500101636",
"02103015080000000500101963",
"26103015080000000500101628",
"82103015080000000500101202",
"70103015080000000500101903",
"85103015080000000500101148",
"19103015080000000500101075",
"63103015080000000500101253",
"60103015080000000500101113",
"76103015080000000500101504",
"82103015080000000500101008",
"13103015080000000500101474",
"10103015080000000500101237",
"73103015080000000500101946",
"98103015080000000500101011",
"79103015080000000500101644",
"66103015080000000500101199",
"79103015080000000500101547",
"29103015080000000500101962",
"38103015080000000500101121",
"16103015080000000500101032",
"38103015080000000500101024",
"88103015080000000500101482",
"95103015080000000500101938",
"35103015080000000500101563",
"04103015080000000500101539",
"51103015080000000500101954",
"28103015080000000500101010"
],
"Bank Gospodarstwa Krajowego": [
"54113000070003901111600001",
"47113000070003901111200002",
"74113000070003901111200001",
"20113000070003901111200003"
],
"Alior Bank Spółka Akcyjna": [
"52249000050000460029212301",
"19249000050000460027186856",
"31249000050000461294270480",
"75249000050000453063872359",
"56249000050000460037967449",
"98249000050000460077212408",
"70249000050000460092801879"
],
"Société Générale Spółka Akcyjna Oddział w Polsce": [
"54184000072211106008101019",
"68184000072211106008131322",
"19184000072211106008190210",
"37184000072211106008130522",
"76184000072211106007001419"
],
"Bank BPH Spółka Akcyjna": [
"90106000760000321000157452",
"25106000760000321000149213"
]
},
"relations": {
"representatives": [
{
"first_name": "IMIE",
"last_name": "NAZWISKO",
"company_name": null,
"nip": null,
"pesel": null
}
],
"authorized_clerks": [
{
"first_name": "IMIE2",
"last_name": "NAZWISKO2",
"company_name": null,
"nip": null,
"pesel": null
}
],
"partners": [
{
"first_name": "IMIE3",
"last_name": "NAZWISKO3",
"company_name": null,
"nip": null,
"pesel": null
},
{
"first_name": null,
"last_name": null,
"company_name": "NAZWA FIRMY",
"nip": null,
"pesel": null
}
]
},
"revenue_agency": {
"name": "Urząd Skarbowy w Płocku",
"adress": "ul. 1 Maja 10, 09-402 Płock",
"email": "us.plock@mf.gov.pl",
"phone": "24 361-65-00",
"fax": "24 361-65-45"
},
"up_to_date": true,
"last_check_date": "2019-12-10 12:15:23"
}
}
]
}
TD - Biała Lista Weryfikacja NIP/Konto
Źródło umożliwia odpytanie czy podany numer NIP i konto bankowe widnieją na Białej Liście Ministerstwa Finansów we wskazanym dniu.
W ramach odpowiedzi, użytkownik otrzyma informację zwrotną czy podany nip posiada konto bankowe (TAK/NIE), status działalności gospodarczej oraz unikalny identyfikator zapytania.
Przykładowe zapytanie
{
"source": "white_list_tab",
"method": "csv",
"params": {
"nip": "1010000516",
"bankaccount": "84188000090000001101689000",
"date": "2020-01-12"
}
}
Przykładowa odpowiedź
{
"status": "quened",
"ident": "fc5b7dd8-cd85-469f-9ecb-f84815ec6808"
}
W celu pobrania danych, należy wykorzystać zwrócony identyfikator
Przykładowy zestaw danych wywołując metode /result
{
"status": "done",
"ident": "fc5b7dd8-cd85-469f-9ecb-f84815ec6808",
"user_account": "sample@tsample.pl",
"progress": 100,
"data": [
{
"task_id": 79,
"source": "white_list_tab",
"method": "csv",
"params": {
"nip": "6262743001",
"bankaccount": "88105012301000009266593384",
"date": "2020-01-12"
},
"meta": {
"type": "file",
"query": "",
"source": ""
},
"result": {
"nip": "6262743001",
"date": "2020-01-12",
"status": "Czynny",
"bankcorrect": "Tak",
"request_id": "7601h-85k00gn",
"up_to_date": true,
"last_check_date": "2023-10-12"
}
}
]
}
TD - Biała Lista Przynależność NIP
Źródło umożliwia odpytanie o wszystkie konta bankowe dla podanego numeru NIP we wskazanym dniu. Dane są zgodne ze stanem Białej Listy Ministerstwa Finansów.
W ramach odpowiedzi użytkownik otrzyma listę kont bankowych przynależnych od podanego numeru nip, status działalności gospodarczej oraz unikalny identyfikator zapytania/
Przykładowe zapytanie
{
"source": "white_list_tab",
"method": "getAccountNumbers",
"params": {
"nip": "6262743001",
"date": "2019-12-01"
}
}
Przykładowa odpowiedź
{
"status": "quened",
"ident": "857335c2-de4a-42f1-80bd-85987dc1b18f"
}
W celu pobrania danych, należy wykorzystać zwrócony identyfikator,
Przykładowy zestaw danych wywołując metode /result
{
"status": "done",
"ident": "857335c2-de4a-42f1-80bd-85987dc1b18f",
"user_account": "sample@sample.pl",
"progress": 100,
"data": [
{
"task_id": 80,
"source": "white_list_tab",
"method": "getAccountNumbers",
"params": {
"nip": "6262743001",
"date": "2019-12-01"
},
"meta": {
"type": "file",
"query": "",
"source": ""
},
"result": {
"nip": "6262743001",
"date": "2019-12-01",
"status":"Czynny",
"bankaccounts":"57188000090000001101689001,84188000090000001101689000",
"request_id":"lm4fm-85nhamb",
"up_to_date": true,
"last_check_date": "2023-10-12"
}
}
]
}
TD - Biała Lista Przynależność rachunku
Źródło umożliwia odpytanie o prawidłowy numer NIP dla podanego rachunku bankowego we wskazanym dniu. Dane są zgodne ze stanem Białej Listy Ministerstwa Finansów.
W ramach odpowiedzi, użytkownik otrzymuje numer nip przynależny do numeru rachunku bankowego, status działalności gospodarczej, oraz unikalny identyfikator zapytania.
Przykładowe zapytanie
{
"source": "white_list_tab",
"method": "getNipByAccountNumber",
"params": {
"bankaccount": "50175010640000000020066911",
"date": "2019-12-01"
}
}
Przykładowa odpowiedź
{
"status": "quened",
"ident": "4c724bf0-f8d2-4c78-b1b2-5ce1e8cc4ea9"
}
W celu pobrania danych, należy wykorzystać zwrócony identyfikator,
Przykładowy zestaw danych wywołując metode /result
{
"status": "done",
"ident": "4c724bf0-f8d2-4c78-b1b2-5ce1e8cc4ea9",
"user_account": "sample@sample.pl",
"progress": 100,
"data": [
{
"task_id": 81,
"source": "white_list_tab",
"method": "getNipByAccountNumber",
"params": {
"bankaccount": "50175010640000000020066911",
"date": "2019-12-01"
},
"meta": {
"type": "file",
"query": "",
"source": ""
},
"result": {
"nip": "1010000019",
"status" : "Czynny",
"date": "2019-12-01",
"bankaccounts": "50175010640000000020066911",
"request_id":"ke5dm-86bggd0"
}
}
]
}
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"
}
}
]
}