Schema bimoR.v1
Elementy
| Element | Opis |
|---|---|
| getReportRequest | Zapytanie o raport
Element wejściowy dla operacji zamówienia raportu (getReportRequest) w BIG API. |
| getReportResponse | Rezultat przetworzenia zapytania o raport
Element wyjściowy dla operacji zamówienia raportu (getReportRequest) w BIG API. |
| getStatisticRequest | Zamówienie wartości statystycznej
Element wejściowy dla operacji zamówienia wartości statystycznej (getStatisticRequest) w BIG API. |
| getStatisticResponse | Rezultat przetworzenia zamówienia wartości statystycznej
Element wyjściowy dla operacji zamówienia wartości statystycznej (getStatisticRequest) w BIG API. |
Typy złożone
| Complex Type | Opis | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AccountPaymentStatusVector | Wektor statusów płatności rachunku | ||||||||||||||||
| AccountsSummaryRequest | Zamówienie podsumowania zobowiązań z BIK
Typ reprezentuje zamówienie podsumowania zobowiązań podmiotu przetwarzanych w rejestrze BIK. W zamówieniu można zdefiniować rodzaj podsumowywanych zobowiązań. | ||||||||||||||||
| BikAccountsSummary | Podsumowanie dotyczące rachunków podmiotu | ||||||||||||||||
| BikCR2VerificationData | Dane komponentu bikCR2Verification
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikCR2Verification | ||||||||||||||||
| BikEntrepreneurAccountsSummaryData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikEntrepreneurAccountsSummary.
Podsumowanie zobowiązań przedsiębiorstwa (BIK)
Podsumowanie zobowiązań podmiotu niebędącego konsumentem przetwarzanych w rejestrze BIK. | ||||||||||||||||
| BikEntrepreneurOverdueLiabilitiesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikEntrepreneurOverdueLiabilities.
Niespłacone zobowiązania przedsiębiorstwa (BIK)
Niespłacone zobowiązania podmiotu niebędącego konsumentem przetwarzane w rejestrze BIK. | ||||||||||||||||
| BikEntrepreneurVerificationData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikEntrepreneurVerification.
Wskaźnik weryfikacji przedsiębiorstwa (BIK)
Wskaźnik weryfikacji podmiotu niebędącego konsumentem w SI BIK Przedsiębiorca | ||||||||||||||||
| BikIndividualAccountsSummaryData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikIndividualAccountsSummary.
Podsumowanie zobowiązań konsumenta (BIK)
Podsumowanie zobowiązań konsumenta przetwarzanych w rejestrze BIK. | ||||||||||||||||
| BikIndividualOverdueLiabilitiesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikIndividualOverdueLiabilities.
Niespłacone zobowiązania konsumenta (BIK)
Niespłacone zobowiązania konsumenta przetwarzane w rejestrze BIK. | ||||||||||||||||
| BikIndividualVerificationData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikIndividualVerification.
Wskaźnik weryfikacji konsumenta (BIK)
Wskaźnik weryfikacji konsumenta w SI BIK Klient Indywidualny | ||||||||||||||||
| BikSmeIndexData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu BikSmeIndexData | ||||||||||||||||
| ComponentData | Dane komponentu
Abstrakcyjny typ reprezentujący dane zwracane w ramach komponentu raportu finansowego. Dostępne w protokole komponenty raportu są opisane w rozdziale Produkty oraz wymienione w słowniku komponentów (@componentEnum)
Ten typ jest abstrakcyjny. W komunikatach są używane wyłącznie typy dziedziczące po nim.
Po typie "ComponentData" dziedziczą:
| ||||||||||||||||
| ComponentRequest | Zamówienie komponentu
Typ reprezentujący zamówienie określonego komponentu.
Po typie "ComponentRequest" dziedziczą: | ||||||||||||||||
| Composition | Kompozycja raportu
Typ reprezentujący kompozycję raportu z BIG InfoMonitor.
Ten typ jest abstrakcyjny. W komunikatach są używane wyłącznie typy dziedziczące po nim.
Po typie "Composition" dziedziczą: | ||||||||||||||||
| Consent | Upoważnienie
Typ używany do zdefiniowania zgody lub upoważnienia udzielonego subskrybentowi przez podmiot będący przedmiotem zapytania, w szczególności zakresu tego upoważnienia.
Powiązane reguły walidacji:
| ||||||||||||||||
| ConsentList | Zgody i upoważnienia
Typ zawierający listę uzyskanych zgód i upoważnień | ||||||||||||||||
| CustomComponent | Dedykowany komponent raportu
Typ reprezentujący dedykowany komponent (produkt elementarny), wchodzących w skład raportu BIG InfoMonitor. Komponent dedykowany (spoza standardowej listy obsługiwanych w protokole) może być dostępny dla określonego subskrybenta po wcześniejszych uzgodnieniach z BIG IM. | ||||||||||||||||
| CustomComponentRequest | Zamówienie komponentu dedykowanego
Typ używany do zamawiania komponentu dedykowanego | ||||||||||||||||
| CustomComponentRequests | Zamówienie komponentu dedykowanego
Typ używany do zamawiania komponentu dedykowanego
Powiązane reguły walidacji:
| ||||||||||||||||
| DlugiInfoData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu dlugiInfo.
Informacje o przedsiębiorcy (długi.info)
Informacje o podmiocie niebędącym konsumentem, przetwarzane w bazie długi.info. | ||||||||||||||||
| DlugiInfoEntity | Podmiot w długi.info | ||||||||||||||||
| DlugiInfoLiabilitiesSummary | Podsumowanie zobowiązań w długi.info | ||||||||||||||||
| DlugiInfoLiability | |||||||||||||||||
| DocumentsByProvider | Dokumenty kwestionowane zarejestrowane przez wierzyciela
Kolekcja informacji o dokumentach kwestionowanych, zarejestrowanych w BIG IM przez określony podmiot. | ||||||||||||||||
| DocumentsReportComposition | Kompozycja raportu o dokumencie
Typ reprezentujący kompozycję raportu o dokumencie. Typ używany do definiowania zawartości zamawianego raportu o dokumencie
Powiązane reguły walidacji:
| ||||||||||||||||
| ExchangeRateTable | Tabela kursów walut
Typ reprezentujący tabelę kursów walut opublikowaną przez Narodowy Bank Polski. | ||||||||||||||||
| FinancialReportComposition | Kompozycja raportu o zobowiązaniach
Typ reprezentujący kompozycję raportu o zobowiązaniach. Typ jest używany do definiowania zamawianego raportu o zobowiązaniach w oparciu o jego komponenty (raporty elementarne). | ||||||||||||||||
| FulfilledLiabilitiesByCreditor | Zobowiązania zarejestrowane przez wierzyciela
Kolekcja informacji o spełnianych zobowiązaniach, zarejestrowanych w BIG IM przez określonego wierzyciela. | ||||||||||||||||
| GetReportRequest | Zamówienie raportu
Typ umożliwiający przekazanie danych zamówienia raportu z BIG InfoMonitor | ||||||||||||||||
| GetReportResponse | Rezultat przetworzenia zamówienia raportu
Typ elementu wyjściowego dla metody getReportRequest w BIG API, zawiera listę możliwych rezultatów operacji zamówienia raportu. | ||||||||||||||||
| GetRequest | Zapytanie
Typ reprezentujący zapytanie o raport
Ten typ jest abstrakcyjny. W komunikatach są używane wyłącznie typy dziedziczące po nim.
Po typie "GetRequest" dziedziczą: | ||||||||||||||||
| GetStatisticRequest | Zamówienie wartości statystycznej
Typ elementu wejściowego dla metody getStatisticRequest w BIG API. Pozwala wskazać wartość pochodzącą z systemu, której dotyczy zamówienie. | ||||||||||||||||
| GetStatisticResponse | Rezultat przetworzenia zamówienia wartości statystycznej
Typ elementu wyjściowego dla operacji getStatisticRequest w BIG API, zawiera listę możliwych rezultatów operacji. | ||||||||||||||||
| GetStatisticSuccess | Pozytywny rezultat przetworzenia zapytania
Typ używany do przekazywania pozytywnego rezultatu przetworzenia zapytania o wartość statystyczną | ||||||||||||||||
| IdentificationError | Błąd identyfikacji
Typ używany do przekazywania informacji o błędzie identyfikacji | ||||||||||||||||
| ImCompromisedDocumentsData | Dane komponentu
Typ używany do zwracania danych w ramach raportu o dokumencie. | ||||||||||||||||
| ImEntrepreneurFulfilledLiabilitiesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imEntrepreneurFulfilledLiabilities.
Pozytywne informacje gospodarcze dotyczące przedsiębiorstwa (BIG InfoMonitor)
Informacje gospodarcze dotyczące spłacanych zobowiązań podmiotu niebędącego konsumentem, przetwarzane w rejestrze BIG InfoMonitor | ||||||||||||||||
| ImEntrepreneurLiabilitiesRequest | Zamówienie komponentu dotyczącego zobowiązań przedsiębiorcy
Typ reprezentuje zamówienie komponentu raportu zawierającego informacje o zobowiązaniach przedsiębiorcy pochodzących z bazy BIG IM. | ||||||||||||||||
| ImEntrepreneurOverdueLiabilitiesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imEntrepreneurOverdueLiabilities.
Negatywne informacje gospodarcze dotyczące przedsiębiorstwa (BIG InfoMonitor)
Informacje gospodarcze dotyczące niespłaconych zobowiązań podmiotu niebędącego konsumentem, przetwarzane w rejestrze BIG InfoMonitor | ||||||||||||||||
| ImEntrepreneurVerificationData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imEntrepreneurVerification.
Wskaźnik weryfikacji przedsiębiorstwa (BIG InfoMonitor)
Wskaźnik weryfikacji podmiotu niebędącego konsumentem w SIBIG. | ||||||||||||||||
| ImIndividualFulfilledLiabilitiesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imIndividualFulfilledLiabilities.
Pozytywne informacje gospodarcze dotyczące konsumenta (BIG InfoMonitor)
Informacje gospodarcze dotyczące spłacanych zobowiązań konsumenta, przetwarzane w rejestrze BIG InfoMonitor | ||||||||||||||||
| ImIndividualLiabilitiesRequest | Zamówienie komponentu dotyczącego zobowiązań indywidualnych
Typ reprezentuje zamówienie komponentu raportu zawierającego informacje o zobowiązaniach konsumenta pochodzących z bazy BIG IM. | ||||||||||||||||
| ImIndividualOverdueLiabilitiesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imIndividualOverdueLiabilities.
Negatywne informacje gospodarcze dotyczące konsumenta (BIG InfoMonitor)
Informacje gospodarcze dotyczące niespłaconych zobowiązań konsumenta, przetwarzane w rejestrze BIG InfoMonitor | ||||||||||||||||
| ImIndividualVerificationData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imIndividualVerification.
Wskaźnik weryfikacji konsumenta (BIG InfoMonitor)
Wskaźnik weryfikacji konsumenta w SIBIG. | ||||||||||||||||
| ImInquiriesData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu imIndividualInquiries oraz imEntrepreneurInquiries.
Zapytania dotyczące konsumenta (BIG InfoMonitor)
Zapytania dotyczące konsumenta przetwarzane w rejestrze BIG InfoMonitor.
Zapytania dotyczące przedsiębiorstwa (BIG InfoMonitor)
Zapytania dotyczące podmiotu niebędącego konsumentem przetwarzane w rejestrze BIG InfoMonitor. | ||||||||||||||||
| IndividualDlugiInfoData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu individualDlugiInfo.
Informacje o konsumencie (długi.info)
Informacje o konsumencie, przetwarzane w bazie długi.info. | ||||||||||||||||
| InquiredDocument | Sprawdzany dokument | ||||||||||||||||
| LiabilitiesSummaryData | Dane komponentu liabilitiesSummary
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu liabilitiesSummary.
Podsumowanie zobowiązań
| ||||||||||||||||
| LiabilitiesSummaryRequest | Zamówienie podsumowania zobowiązań
Typ reprezentuje zamówienie podsumowania zobowiązań podmiotu. W zamówieniu można zdefiniować rodzaj podsumowywanych zobowiązań oraz źródło pochodzenia informacji o nich. | ||||||||||||||||
| LiabilitiesSummaryRequests | Zamówienia podsumowań
Typ umożliwiający zamówienie kolekcji podsumowań zobowiązań o określonych zakresach. | ||||||||||||||||
| MarketSegmentInquiries | Liczba zapytań z segmentu rynkowego
Łączna liczba zapytań o raport (dotyczący tego samego podmiotu, co bieżący), złożonych w BIG IM przez przedstawicieli określonego segmentu rynkowego. | ||||||||||||||||
| NegativeEconomicInformationOutput | Negatywna informacja gospodarcza (wyjście)
Typ reprezentuje nagatywną informację gospodarczą odczytaną z rejestru BIG IM. Zawiera zarówno atrybuty nadawane przez wierzyciela jak i nadawane przez BIG. | ||||||||||||||||
| OverdueLiabilitiesByCreditor | Zobowiązania zarejestrowane przez wierzyciela
Kolekcja informacji o niespełnionych zobowiązaniach, zarejestrowanych w BIG IM przez określonego wierzyciela. | ||||||||||||||||
| PaymentStatusVectorData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikPaymentStatusVector.
Wektory statusów płatności (BIK)
Wektory statusów płatności dla poszczególnych zobowiązań przetwarzanych w rejestrze BIK. | ||||||||||||||||
| PeselData | Dane komponentu Pesel
Typ używany do zwracania w ramach raportów informacji o zgodności przesłanych danych z danymi z rejestru PESEL
Informacja o zgodności danych osoby fizycznej z rejestrem PESEL
Informacja o zgodności danych osoby fizycznej przekazanych w zapytaniu z danymi z rejestru PESEL (Powszechny Elektroniczny System Ewidencji Ludności). Rejestr jest przeszukiwany po numerze PESEL. Rejestr umożliwia weryfikację wyłącznie pierwszego imienia oraz nazwiska z numerem PESEL. | ||||||||||||||||
| PositiveEconomicInformationOutput | Pozytywna informacja gospodarcza (wyjście)
Typ reprezentuje pozytywną informację gospodarczą odczytaną z rejestru BIG IM. Zawiera zarówno atrybuty nadawane przez wierzyciela jak i nadawane przez BIG. | ||||||||||||||||
| PrzeswietlPlData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu przeswietlPl.
Informacje o przedsiębiorcy (prześwietl.pl)
Informacje o przedsiębiorcy, przetwarzane w bazie prześwietl.pl. | ||||||||||||||||
| Report | Pozytywny rezultat przetworzenia zapytania o raport
Typ używany do przekazywania pozytywnego rezultatu przetworzenia zapytania o raport | ||||||||||||||||
| ReportComponent | Komponent raportu
Typ reprezentujący komponent (produkt elementarny), wchodzących w skład raportu BIG InfoMonitor. Protokół bimo pozwala na zamówienie komponentów z zamkniętej listy dostępnych w BIG IM. Komponenty raportów są opisane w rozdziale Produkty. | ||||||||||||||||
| ReportComponentRequests | Zamówienia komponentów raportu
Typ używany do zamawiania określonych komponentów raportu finansowego. | ||||||||||||||||
| ReportComponents | Komponenty raportu
Kolekcja zamówionych komponentów raportu. Każdy komponent zawiera informacje dotyczące przedmiotu zapytania w odpowiedniej dla niego strukturze komunikatu. | ||||||||||||||||
| RequestError | Błąd walidacji zapytania
Typ używany do przekazywania informacji dotyczących wykrytych przez system błędów walidacji zapytania | ||||||||||||||||
| ScoreData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu bikCreditRisk2 i bikCreditRisk3 | ||||||||||||||||
| ScoreResult | Wynik oceny punktowej | ||||||||||||||||
| ZbpEntrepreneurVerificationData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu zbpEntrepreneurVerification.
Wskaźnik weryfikacji przedsiębiorstwa (ZBP)
| ||||||||||||||||
| ZbpIndividualVerificationData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu zbpIndividualVerification.
Wskaźnik weryfikacji konsumenta (ZBP)
| ||||||||||||||||
| ZbpRestrictedDocumentsData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu zbpRestrictedDocuments.
Dokumenty zastrzeżone (ZBP)
Informacje o zastrzeżonych dokumentach konsumentów przetwarzane w rejestrze ZBP. | ||||||||||||||||
| ZbpUnreliableEntrepreneursByNipData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu zbpUnreliableEntrepreneursByNip.
Niespłacone zobowiązania przedsiębiorstwa wyszukane po NIP (ZBP)
Niespłacone zobowiązania podmiotu niebędącego konsumentem przetwarzane w rejestrze ZBP, wyszukane z użyciem NIP. | ||||||||||||||||
| ZbpUnreliableEntrepreneursByRegonData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu zbpUnreliableEntrepreneursByRegon.
Niespłacone zobowiązania przedsiębiorstwa wyszukane po REGON (ZBP)
Niespłacone zobowiązania podmiotu niebędącego konsumentem przetwarzane w rejestrze ZBP, wyszukane z użyciem REGON. | ||||||||||||||||
| ZbpUnreliableIndividualsData | Dane komponentu
Typ używany do zwracania w ramach raportów o zobowiązaniach danych komponentu zbpUnreliableIndividuals.
Niespłacone zobowiązania konsumenta (ZBP)
Niespłacone zobowiązania konsumenta przetwarzane w rejestrze ZBP |
Typy proste
| Simple Type | Opis |
|---|---|
| aggregatedResultEnum | Słownik zagregowanych rezultatów przeszukania wskazanych w zapytaniu rejestrów |
| bikAccountTypeEnum | Słownik rodzajów rachunków kredytowych przetwarzanych w BIK |
| bikPaymentStatusEnum | Słownik możliwych statusów płatności rachunków kredytowych przetwarzanych w BIK |
| componentEnum | Słownik dostępnych komponentów raportu (produktów elementarnych) |
| componentProcessingResultEnum | Słownik rezultatów przetwarzania zamówień komponentów raportu (produktów elementarnych). |
| consentScopeEnum | Słownik dostępnych zakresów upoważnienia / zgody |
| cr2ResultEnum | Słownik rezultatów naliczenia oceny punktowej wg modelu CreditRisk 2 |
| cr3ResultEnum | Słownik rezultatów naliczenia oceny punktowej wg modelu CreditRisk 3 |
| documentReportEnum | Słownik dostępnych raportów o dokumencie |
Typ prosty umożliwiający zapisanie adresu email. E-mail jest pozbawiony wszelkich separatorów i znaków niedozwolonych . Składa się z ciągu znaków, @ i domeny | |
| getOperationTypeEnum | Słownik operacji dostępnych w protokole (w obszarze produktów). |
| int10 | Typ prosty umożliwiający zapisanie liczby całkowitej o długości maksymalnie 10 cyfr. |
| int2 | Typ prosty umożliwiający zapisanie liczby całkowitej o długości maksymalnie 2 cyfr. |
| int3 | Typ prosty umożliwiający zapisanie liczby całkowitej o długości maksymalnie 3 cyfr. |
| int4 | Typ prosty umożliwiający zapisanie liczby całkowitej o długości maksymalnie 4 cyfr. |
| int5 | Typ prosty umożliwiający zapisanie liczby całkowitej o długości maksymalnie 5 cyfr. |
| legalFormList | Typ prosty umożliwiający zapisanie listy form prawnych podmiotu |
| liabilitiesSourceEnum | Słownik baz źródłowych dla informacji o zobowiązaniach. |
| liabilitiesSourceList | Typ prosty umożliwiający zapisanie listy baz źródłowych dla zobowiązań |
| liabilitiesTypeEnum | Słownik rodzajów zobowiązań przetwarzanych w SIBIG. |
| liabilitiesTypeList | Typ prosty umożliwiający zapisanie listy typów zobowiązań |
| marketSegmentEnum | Słownik dla klasyfikacji segmentów rynkowych wg BIG InfoMonitor. |
| nonNegativeFloat5 | Typ prosty umożliwiający zapisanie dziesiętnej liczby wymiernej o maksymalnej długości 5 znaków. |
| nonNegativeFloat7 | Typ prosty umożliwiający zapisanie dziesiętnej liczby wymiernej o maksymalnej długości 7 znaków. |
| paymentStatusVector | Historia statusu płatności rachunku (od najnowszego do najstarszego). Historia zawiera nie więcej niż 35 ostatnich aktualizacji rachunku. |
| phoneNumber | Numer telefonu pozbawiony wszelkich separatorów. Składa się z opcjonalnego jednego plusa na początku i conajmniej 4 cyfr. |
| pkd | Kod PKD 2007 |
| productEnum | Słownik dostępnych raportów o zobowiązaniach |
| propertiesEnum | Słownik dostępnych wartości statystycznych pochodzących z SIBIG. |
| restrictedDocumentsEnum | Słownik możliwych rezultatów przeszukania bazy ZBD - Dokumenty Zastrzeżone. |
| riskGroupAssignmentResultEnum | Słownik statusów przypisania grupy i podgrupy ryzyka |
| riskGroupEnum | Słownik grup ryzyka |
| riskSubgroupEnum | Słownik podgrup ryzyka |
| selectModeEnum | Słownik dostępnych trybów wyboru komponentów raportu o zobowiązaniach. |
| smeRiskIndexEnum | Słownik wartości dla Wskaźnika Ryzyka MSP, wyliczanego w oparciu o model BIKScoSME Credit Risk |
| unreliableDebtorsEnum | Słownik możliwych rezultatów przeszukania bazy ZBP - niesolidni dłużnicy. |
Grupy
| Grupa | Opis |
|---|---|
| componentAttributes | Grupa standardowych atrybutów komponentu raportu (produktu elementarnego). |
| dlugiInfo | Grupa elementów wykorzystywanych w komponentach raportu pochodzących z bazy długi.info |
| imFulfilledLiabilities | Spełniane zobowiązania z BIG IM
Typ reprezentuje informacje o spełnianych zobowiązaniach podmiotu, pochodzących z rejestru BIG IM. |
| imOverdueLiabilities | Niespełnione zobowiązania z BIG IM
Typ reprezentuje informacje o niespełnionych zobowiązaniach podmiotu, pochodzących z rejestru BIG IM. |