Zweryfikuj dokument za pomocą API

REST API VerifyPDF pozwala twoim własnym systemom weryfikować dokumenty bez otwierania panelu przez kogokolwiek. Ten artykuł omawia proces na wysokim poziomie. Pełne szczegóły żądania i odpowiedzi znajdziesz w dokumentacji pod /agents/.

Zanim zaczniesz

• REST API jest dostępne w planach Professional i Corporate. Nie jest dołączone do planu Basic ani konta bez planu. Zobacz Plany w skrócie.
• Potrzebujesz klucza API. Zobacz Generuj klucze API i zarządzaj nimi.

Podstawowy proces

1. Utwórz klucz API w sekcji Developers i skopiuj go raz.
2. Wyślij plik PDF do API z kluczem w nagłówku żądania API-KEY.
3. Odczytaj wynik, który wraca z tym samym wskaźnikiem zaufania i oceną ryzyka oszustwa, jakie widzisz w panelu. Zobacz Odczytaj wynik weryfikacji.

Każda weryfikacja przez API zużywa jeden dokument z twojego miesięcznego limitu lub salda przedpłaconego, dokładnie tak jak przesłanie z panelu. Zobacz Jak działają pakiety przedpłacone.

Dodaj własny identyfikator odniesienia

Możesz dołączyć custom_id do weryfikacji, na przykład swój wewnętrzny numer sprawy lub identyfikator zamówienia. To pozwala później odnaleźć weryfikację po twoim własnym odniesieniu. Każdy custom_id musi być unikalny w obrębie twojego konta.

Szybka ilustracja

Na wysokim poziomie żądanie wysyła plik PDF wraz z nagłówkiem API-KEY zawierającym twój klucz. Dokładny punkt końcowy, treść żądania i format odpowiedzi znajdują się w dokumentacji API pod /agents/ oraz w sekcji Developers w panelu. Korzystaj z nich, aby mieć gotowe do skopiowania przykłady, zamiast zgadywać.

Najpierw testuj, potem produkcja

Podczas budowania używaj klucza testowego. Do prawdziwych weryfikacji przełącz się na klucz produkcyjny. Zobacz Klucze API testowe i produkcyjne.

Następne kroki

• Chcesz, aby wyniki były przesyłane do ciebie zamiast odpytywania? Zobacz Skonfiguruj webhooki.
• Potrzebujesz pełnej dokumentacji? Przejdź do /agents/.