Vai al contenuto principale
ShieldID

Sviluppatori

Documentazione dell'API di verifica dell'identità, pensata per essere davvero utilizzata.

Un'unica API REST, una pagina ospitata per le parti che non desidera sviluppare e webhook firmati per sapere nell'istante stesso in cui un risultato è disponibile. Le chiavi Sandbox non vengono mai fatturate, quindi il modo più rapido per capire ShieldID è chiamarlo.

Inizi gratis nella sandboxLegga la guida rapida

La versione in cinque minuti

Quattro chiamate. Un unico modello mentale.

Tutto il resto di questa documentazione è un approfondimento di questo ciclo.

  1. Crei una sessione

    POST /v1/sessions con un return URL e un URL del webhook. Riceverà in risposta un session_id e un verification_url.

  2. Lo consegni al richiedente

    Invii il verification_url come link, oppure lasci che il richiedente inquadri il codice QR mostrato dalla pagina ospitata su desktop. Completerà la procedura sul proprio telefono.

  3. Riceva un webhook firmato

    Quando la sessione raggiunge VERIFIED o FAILED, ShieldID invia tramite POST il risultato al Suo URL del webhook, firmato in modo che possa fidarsi che provenga da noi.

  4. Legga il risultato

    Si fidi del webhook, oppure chiami direttamente GET /v1/sessions/{id}/result. In ogni caso otterrà verdetti per singolo controllo, non un unico punteggio opaco.

Provi

Crei la Sua prima sessione.

La stessa richiesta in tre linguaggi. È la chiamata descritta dal primo passaggio del modello mentale.

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

Le chiavi Sandbox (vk_sand_…) eseguono gratuitamente questo stesso flusso. Passi a una chiave vk_live_ e non cambierà nient'altro, tranne la fattura.

Trovi la Sua strada

Il resto della documentazione per sviluppatori.

Sei pagine. Legga quelle che Le servono.

SDKs

Il widget web, il flusso ospitato e cosa è in arrivo.
Apri SDKs

Sandbox

Come funziona la modalità di test e come ottenere una chiave.
Apri Sandbox

Stato

Di cosa daremo conto, quando il feed sarà attivo.
Apri Stato

Sandbox

Provi l'intero flusso prima di firmare qualsiasi cosa.

Una chiave sandbox (prefisso vk_sand_) esegue la stessa identica API, la stessa pagina ospitata e lo stesso flusso webhook della produzione. Le sessioni sono contrassegnate con environment: "sandbox" ovunque compaiano e le sessioni sandbox non vengono mai fatturate, con qualsiasi piano.

Consulti la guida alla sandbox
  • Creare sessioni reali, verificare un documento reale sul proprio telefono, ricevere in risposta un webhook firmato reale
  • Nulla di ciò che fa in sandbox incide su una fattura
  • Passi alla produzione sostituendo il prefisso della chiave; la struttura della richiesta non cambia

Sviluppato in modo trasparente

Che cosa è pronto e che cosa non lo è ancora.

Preferiamo dirglielo noi piuttosto che farglielo scoprire nel corso dell'integrazione.

Callback di completamento del widget web

Prossimamente

onComplete, onCancel e onStep esistono già oggi nell'interfaccia del widget, ma per ora nulla li attiva. Utilizzi l'URL di ritorno e il webhook: entrambi funzionano già.

Limiti di frequenza applicati

Prossimamente

Ogni chiave API ha un limite di frequenza registrato in base al Suo piano, ma per ora non viene applicato alle richieste: si regoli di conseguenza e non faccia affidamento su ShieldID per limitare il traffico.

Registrazione self-service alla sandbox

Prossimamente

Le chiavi sandbox vengono rilasciate su richiesta finché è in corso lo sviluppo della registrazione self-service. Ne faccia richiesta e gliene forniremo una in tempi rapidi.

Domande

Risposte chiare per gli sviluppatori.

Inizia ora

Andate online in un pomeriggio.

Inizi con una chiave sandbox, esegua una verifica sul Suo telefono e legga il webhook che Le viene inviato. Non è necessaria alcuna chiamata commerciale.

Inizi gratis nella sandboxLegga la guida rapida

Le sessioni sandbox non vengono mai fatturate.