Dokumentacja

Pierwsze kroki

1. Utwórz darmowe konto i organizację w panelu.
2. Wygeneruj klucz API w sekcji kluczy API (rw_live_ do danych produkcyjnych albo rw_test_ do sandboxa). Klucz jest pokazywany raz; zapisz go.
3. Sprawdź integrację na danych testowych kluczem rw_test_ (krok 1 poniżej).
4. Dodaj prawdziwy NIP kluczem rw_live_: plan Free monitoruje tylko Białą listę VAT (krok 2).
5. Poczekaj na pierwszy odczyt i pobierz wynik ryzyka (krok 3). KRS, KRZ i webhooki wymagają planu płatnego (krok 4).

1. Sandbox: dane testowe kluczem rw_test_

Klucz rw_test_ (wymaga konta) zwraca deterministyczne dane oznaczone sandbox: true tylko dla NIP-ów 1111111111, 2222222222 i 3333333333 i niczego nie zapisuje. Sandbox nie obsługuje jednorazowych sprawdzeń (/v1/checks/*: VAT, rachunek, VIES, sankcje) ani webhooków, a serwer MCP odrzuca klucze rw_test_.

curl https://api.riskwatch.pl/v1/entities/1111111111/risk \
  -H "Authorization: Bearer rw_test_yourkey"

2. Plan Free: dodaj NIP do monitoringu Białej listy VAT

Na planie Free jedynym dostępnym źródłem jest VAT; prośba o KRS albo KRZ kończy się błędem 403. Zastąp <YOUR_VALID_NIP> prawdziwym NIP-em kontrahenta.

curl -X POST https://api.riskwatch.pl/v1/watchlist \
  -H "Authorization: Bearer rw_live_yourkey" \
  -H "Idempotency-Key: quickstart-001" \
  -H "Content-Type: application/json" \
  -d '{"nips":["<YOUR_VALID_NIP>"],"sources":["VAT"]}'

Pierwszy odczyt jest asynchroniczny

Odpowiedź 200 oznacza, że NIP trafił na listę i pierwsze sprawdzenie zostało zakolejkowane, a nie że rejestr już odpowiedział. Do czasu pierwszego odczytu wynik nie ma danych źródłowych; brak danych to nie to samo co niskie ryzyko (LOW). Każdy odczyt ma znacznik czasu z rejestru, a niepewny odczyt nie nadpisuje ostatniego zweryfikowanego stanu.

3. Odczytaj wynik ryzyka

curl https://api.riskwatch.pl/v1/entities/<YOUR_VALID_NIP>/risk \
  -H "Authorization: Bearer rw_live_yourkey"

4. Starter i wyższe: KRS i webhooki

Starter dodaje KRS i 2 webhooki, Pro dodaje KRZ. Ten sam endpoint z sources ["VAT","KRS"] działa dopiero na planie płatnym; webhooki skonfigurujesz według strony Webhooki. Webhooki · Cennik

curl -X POST https://api.riskwatch.pl/v1/watchlist \
  -H "Authorization: Bearer rw_live_yourkey" \
  -H "Idempotency-Key: quickstart-002" \
  -H "Content-Type: application/json" \
  -d '{"nips":["<YOUR_VALID_NIP>"],"sources":["VAT","KRS"]}'

NIP-y są walidowane oficjalną sumą kontrolną. Znaki formatujące są usuwane, więc NNN-NNN-NN-NN i NNNNNNNNNN reprezentują ten sam znormalizowany zapis; zastąp wzorzec poprawnym NIP-em.