Lumaktaw sa pangunahing nilalaman
ShieldID

Mga Developer

Dokumentasyon ng identity verification API, ginawa para talagang magamit.

Isang REST API, isang hosted page para sa mga bahaging ayaw mong buuin, at mga signed webhook para malaman mo agad kapag may resulta na. Hindi kailanman sinisingil ang mga sandbox key, kaya ang pinakamabilis na paraan para maintindihan ang ShieldID ay ang subukan itong tawagin.

Magsimula nang libre sa sandboxBasahin ang quickstart

Ang limang-minutong bersyon

Apat na call. Isang mental model.

Ang lahat ng iba pa sa mga doc na ito ay detalye lang sa ibabaw ng loop na ito.

  1. Gumawa ng session

    POST /v1/sessions na may return URL at webhook URL. Makakatanggap ka ng session_id at verification_url.

  2. Ibigay ito sa applicant

    Ipadala ang verification_url bilang link, o hayaan silang i-scan ang QR code na ipinapakita ng hosted page sa desktop. Tatapusin nila ito sa sarili nilang telepono.

  3. Tumanggap ng signed webhook

    Kapag umabot sa VERIFIED o FAILED ang session, ipo-POST ng ShieldID ang resulta sa iyong webhook URL, na may signature para mapagkakatiwalaan mong galing ito sa amin.

  4. Basahin ang resulta

    Magtiwala sa webhook, o tawagin mismo ang GET /v1/sessions/{id}/result. Sa alinmang paraan, makakakuha ka ng verdict kada check, hindi isang malabong score lang.

Subukan ito

Gawin ang una ninyong session.

Parehong request sa tatlong wika. Ito ang call na inilalarawan ng unang hakbang ng mental model.

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

Pinapatakbo ng mga sandbox key (vk_sand_…) ang eksaktong flow na ito nang libre. Palitan ng vk_live_ key at wala nang magbabago maliban sa invoice.

Hanapin ang iyong daan

Ang iba pang developer docs.

Anim na page. Basahin ang mga kailangan mo.

Quickstart

Mula sandbox key hanggang unang signed webhook, nang may kaayusan.
Buksan Quickstart

SDKs

Ang web widget, ang hosted flow, at ang paparating pa.
Buksan SDKs

Sandbox

Paano gumagana ang test mode, at paano kumuha ng key.
Buksan Sandbox

Sandbox

Subukan ang buong flow bago ka pumirma ng anuman.

Ang sandbox key (prefix na vk_sand_) ay gumagamit ng parehong API, hosted page at webhook flow gaya ng production. Minamarkahan ng environment: "sandbox" ang mga session saan man lumabas ang mga ito, at ang mga sandbox session ay hindi kailanman sinisingil, sa anumang plan.

Basahin ang sandbox guide
  • Gumawa ng totoong session, mag-verify ng totoong dokumento sa sarili mong telepono, at tumanggap ng totoong signed webhook
  • Walang anumang gawin mo sa sandbox ang makakaapekto sa isang invoice
  • Lumipat sa production sa pamamagitan ng pagpalit ng key prefix; hindi nagbabago ang hugis ng request

Binuo nang hayag sa publiko

Ano ang tapos na, at ano ang hindi pa.

Mas gusto naming sabihin ito sa iyo kaysa malaman mo ito sa gitna ng integration.

Mga completion callback ng web widget

Malapit na

Umiiral na ngayon ang onComplete, onCancel at onStep sa interface ng widget, ngunit wala pang nagpapagana sa mga ito. Gamitin ang return URL at ang webhook — parehong gumagana na ngayon.

Mga ipinapatupad na rate limit

Malapit na

May rate limit ang bawat API key na nakatala sa iyong plan, ngunit hindi pa ito ipinapatupad sa mga request — magplano nang naaayon, at huwag umasa sa ShieldID para i-throttle ka.

Self-serve sandbox signup

Malapit na

Ibinibigay ang mga sandbox key kapag hiniling habang binubuo pa ang self-serve signup. Humiling lang at mabilis namin itong ihahanda.

Mga Tanong

Diretsong sagot para sa mga developer.

Magsimula

Mag-go live sa loob lang ng isang hapon.

Magsimula sa sandbox key, magsagawa ng verification sa sarili mong telepono, at basahin ang webhook na ipapadala nito sa iyo. Hindi kailangan ng sales call.

Magsimula nang libre sa sandboxBasahin ang quickstart

Hindi kailanman sinisingil ang mga sandbox session.