Hoppa till huvudinnehållet
ShieldID

Utvecklare

API-dokumentation för identitetsverifiering, gjord för att faktiskt användas.

Ett REST API, en hostad sida för de delar du inte vill bygga själv och signerade webhooks så att du får veta i samma stund som ett resultat finns. Sandbox-nycklar faktureras aldrig, så det snabbaste sättet att förstå ShieldID är att anropa det.

Börja gratis i sandboxLäs snabbstarten

Femminutersversionen

Fyra anrop. En enda mental modell.

Allt annat i dessa dokument är detaljer ovanpå den här loopen.

  1. Skapa en session

    POST /v1/sessions med en return URL och en webhook-URL. Du får tillbaka ett session_id och en verification_url.

  2. Lämna över till den sökande

    Skicka verification_url som en länk, eller låt personen skanna QR-koden som den hostade sidan visar på dator. Den sökande slutför på sin egen telefon.

  3. Ta emot en signerad webhook

    När sessionen når VERIFIED eller FAILED skickar ShieldID resultatet med POST till din webhook-URL, signerat så att du kan lita på att det kommer från oss.

  4. Läs resultatet

    Lita på webhooken, eller anropa GET /v1/sessions/{id}/result själv. Oavsett vilket får du utfall per kontroll, inte en enda ogenomskinlig poäng.

Prova själv

Skapa din första session.

Samma anrop i tre språk. Det här är anropet som steg ett i tankemodellen beskriver.

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" }

Sandbox-nycklar (vk_sand_…) kör exakt det här flödet gratis. Byt till en vk_live_-nyckel så ändras ingenting annat än fakturan.

Hitta rätt

Resten av utvecklardokumentationen.

Sex sidor. Läs de du behöver.

Snabbstart

Från sandbox-nyckel till första signerade webhook, i ordning.
Öppna Snabbstart

SDKs

Webbwidgeten, det hostade flödet och vad som kommer.
Öppna SDKs

Status

Vad vi kommer att rapportera om när flödet är live.
Öppna Status

Sandbox

Testa hela flödet innan du skriver under något.

En sandbox-nyckel (prefix vk_sand_) kör exakt samma API, värdbaserade sida och webhook-flöde som produktion. Sessioner märks med environment: "sandbox" överallt där de visas, och sandbox-sessioner debiteras aldrig, oavsett abonnemang.

Läs sandbox-guiden
  • Skapa riktiga sessioner, verifiera ett riktigt dokument med din egen telefon och få tillbaka en riktig signerad webhook
  • Inget du gör i sandbox påverkar en faktura
  • Byt till produktion genom att byta nyckelprefix; requestens utseende ändras inte

Byggt i det öppna

Vad som är klart och vad som inte är det ännu.

Vi berättar hellre det för dig än låter dig upptäcka det mitt under integrationen.

Callbacks vid slutförande i webbwidgeten

Kommer snart

onComplete, onCancel och onStep finns i widgetens gränssnitt idag, men ingenting utlöser dem ännu. Använd retur-URL:en och webhooken – båda fungerar nu.

Tillämpade hastighetsbegränsningar

Kommer snart

Varje API-nyckel har en hastighetsbegränsning kopplad till ditt abonnemang, men den tillämpas inte på anrop ännu – planera därefter och förlita dig inte på att ShieldID begränsar dig.

Självbetjäningsregistrering för sandbox

Kommer snart

Sandbox-nycklar utfärdas på begäran medan självbetjäningsregistrering byggs. Hör av dig så fixar vi en snabbt.

Frågor

Raka svar för utvecklare.

Kom igång

Gå live på en eftermiddag.

Börja med en sandbox-nyckel, kör en verifiering med din egen telefon och läs webhooken du får. Inget säljsamtal krävs.

Börja gratis i sandboxLäs snabbstarten

Sandbox-sessioner debiteras aldrig.