Przejdź do treści głównej
ShieldID

Dla programistów

Dokumentacja API weryfikacji tożsamości, stworzona z myślą o praktycznym użyciu.

Jedno API REST, hostowana strona dla elementów, których nie chcą Państwo budować samodzielnie, oraz podpisane webhooki, dzięki którym dowiadują się Państwo o wyniku w chwili jego otrzymania. Klucze sandbox nigdy nie są rozliczane, więc najszybszym sposobem poznania ShieldID jest jego wywołanie.

Zacznij za darmo w sandboksiePrzeczytaj krótki przewodnik

Wersja na pięć minut

Cztery wywołania. Jeden model myślowy.

Wszystko inne w tej dokumentacji to szczegóły nadbudowane nad tą pętlą.

  1. Utworzenie sesji

    POST /v1/sessions z adresem URL powrotu i adresem URL webhooka. W odpowiedzi otrzymują Państwo session_id i verification_url.

  2. Przekazanie wnioskodawcy

    Proszę wysłać verification_url jako link lub pozwolić wnioskodawcy zeskanować kod QR wyświetlany przez stronę hostowaną na komputerze. Wnioskodawca kończy proces na własnym telefonie.

  3. Odbiór podpisanego webhooka

    Gdy sesja osiągnie stan VERIFIED lub FAILED, ShieldID wysyła wynik metodą POST na Państwa adres webhooka, podpisany tak, aby mogli Państwo mieć pewność, że pochodzi od nas.

  4. Odczyt wyniku

    Proszę zaufać webhookowi lub samodzielnie wywołać GET /v1/sessions/{id}/result. Tak czy inaczej otrzymują Państwo werdykty dla poszczególnych kontroli, a nie jedną nieprzejrzystą ocenę.

Wypróbuj

Utwórzcie Państwo pierwszą sesję.

To samo żądanie w trzech językach. To właśnie to wywołanie opisuje krok pierwszy modelu myślowego.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Klucze sandbox (vk_sand_…) uruchamiają dokładnie ten przepływ za darmo. Po zamianie na klucz vk_live_ nie zmienia się nic poza fakturą.

Jak zacząć

Pozostała dokumentacja dla programistów.

Sześć stron. Proszę czytać te, których Państwo potrzebują.

SDKs

Widżet webowy, przepływ hostowany i to, co nadchodzi.
Otwórz SDKs

Status

O czym będziemy informować, gdy kanał statusu zostanie uruchomiony.
Otwórz Status

Sandbox

Przed podpisaniem czegokolwiek proszę przetestować cały proces.

Klucz sandbox (prefiks vk_sand_) uruchamia identyczne API, stronę hostowaną i przepływ webhooków jak środowisko produkcyjne. Sesje są oznaczane environment: "sandbox" wszędzie, gdzie się pojawiają, a sesje w sandboxie nigdy nie są rozliczane, w żadnym planie.

Zobacz przewodnik po sandboxie
  • Tworzenie prawdziwych sesji, weryfikacja prawdziwego dokumentu na własnym telefonie, otrzymanie prawdziwego, podpisanego webhooka
  • Nic, co Państwo zrobią w sandboxie, nie trafia na fakturę
  • Przejście na produkcję polega na zamianie prefiksu klucza; struktura żądania się nie zmienia

Tworzone w otwarty sposób

Co jest już gotowe, a co jeszcze nie.

Wolimy powiedzieć o tym Państwu sami, niż żeby dowiadywali się Państwo w trakcie integracji.

Wywołania zwrotne zakończenia w widżecie webowym

Wkrótce

onComplete, onCancel i onStep istnieją już w interfejsie widżetu, ale na razie nic ich nie wywołuje. Proszę skorzystać z adresu powrotnego (return URL) i webhooka — oba działają już teraz.

Egzekwowane limity zapytań

Wkrótce

Każdy klucz API ma limit zapytań zapisany w ramach Państwa planu, ale nie jest on jeszcze egzekwowany na żądaniach — prosimy odpowiednio planować i nie polegać na tym, że ShieldID ograniczy ruch.

Samodzielna rejestracja w sandboxie

Wkrótce

Klucze sandbox wydajemy na prośbę, do czasu zbudowania samodzielnej rejestracji. Wystarczy poprosić, a szybko go Państwu przygotujemy.

Pytania

Konkretne odpowiedzi dla programistów.

Rozpocznij

Uruchomienie w jedno popołudnie.

Proszę zacząć od klucza sandbox, przeprowadzić weryfikację na własnym telefonie i przeczytać webhook, który Państwo otrzymają. Bez rozmowy z działem sprzedaży.

Zacznij za darmo w sandboksiePrzeczytaj krótki przewodnik

Sesje w sandboxie nigdy nie są rozliczane.