Na této stránce najdete podrobný návod jaké endpointy na API volat pro vytvoření scénáře, zahájení identifikace a získání dat.

Scénáře ověření totožnosti pro Bank iD a výsledné identifikace jsou dostupné pouze přes API rozhraní a aktuálně se nezobrazují v naší webové samoobsluze.

1. vytvoření identifikačního scénáře

Každá identifikace osoby probíhá na základě scénáře ověření totožnosti ve kterém definujete zejména jaké údaje chcete z Bank iD ověření získat.

Pro různé situace tak můžete mít nastavený jiný scénář podle kterého osobu ověřujete (např. AML ověření, registrace uživatele, onboarding klienta apod.).

1.1. vytvoření scénáře

V rámci vytvoření scénáře definujete jeho název (pro případné filtrování/odlišení) a status zda je aktivní a může být použít.

POST /api/account/identify-scenarios

{
  "name": "string";  
  "active": true
}

v odpovědi získáte ID scénáře = {scenario}

1.2 nastavení schování scénáře

Pro vytvořený scénář je následně potřeba nastavit že se jedná o typ ověřování pomocí BankID a zároveň definujete bankIdScopes (požadovaná data k ověření), které obdržíte.

POST /api/account/identify-scenarios/{scenario}/versions

{
  "identificationType": "BankId",
  "bankIdScopes":
 [
    "profile.name",
    "profile.birthdate"
  ]
}

Kompletní výčet a význam bankIdScopes s rozdělením do produktů podle ceníku Bank iD:

CONNECT
1. profile.name = jméno a příjmení osoby
2. profile.email = emailová adresa vedená u banky
3. profile.phonenumber = tel. číslo vedené u banky
4. profile.birthdate = datum narození
IDENTIFY
1. profile.addresses = dostupné adresy (trvalá a případně další)
2. profile.titles = tituly
3. profile.gender = pohlaví
4. profile.birthnumber = rodné číslo
5. profile.paymentAccounts = platební účty
IDENTIFY PLUS
1. profile.birthplaceNationality = místo narození
2. profile.maritalstatus = rodinný stav
3. profile.idcards = doklady (typ dokladu, popis, stát, číslo, platnost, vydavatel dokladu, datum vydání)
4. profile.legalstatus = dospělost, politicky exponovaná osoba, svéprávnost
IDENTIFY AML
1. profile.verification = AML framework, čas ověřením, IČO organizace, která provedla ověření

2. postup ověřovaní vašich klientů

Jakmile máte vytvořený scénář podle kterého chcete koncové uživatele ověřovat, můžete jej použít pro vytvoření požadavku na ověřneí.

2.1. Vytvoření požadavku na identifikace

Nejdříve vytvoříte koncept požadavku ve kterém definujete:

identifyScenario = ID scénáře podle kterého ověření proběhne
redirectUrl = adresa kam uživatele přesměrujeme po dokončení ověření (volitelné)
name = název požadavku na identifikaci pro interní účely vyhledávání apod.

POST /api/identifications

{
  "identifyScenario": "ID scénáře",
  "redirectUrl": "https://example.com",
  "name": "string"
}

V odpovědi se vám vrátí ID identifikace = {identification}

2.2. zahájení identifikace

Po vytvoření požadavku můžete zahájit proces ověření. Tím přejde stav identifikace do stavu started a v odpovědi se vám vrátí URL adresa na kterou přesměrujete uživatele pro ověření.

POST /api/identifications/{identification}/start

2.3. získání dat z ověření

Jakmile se osoba ověří, tak si můžete z identifikace získat její stav a všechna získaná data.

GET /api/identifications/{identification}

O tom, že k identifikaci proběhlo se můžete dozvědět různými způsoby podle typu implementace:

deeplink s vaší aplikací = dozvíte se synchronně při návratu uživatele
webhooky = odebíráte realtime události o identifikacích viz samostatná sekce

Detailnější popis jednotlivých endpointů, parametrů vč. příkladů request / response najdete v naší dokumentaci.

Související články

Základní použití REST API

Průvodce vytvoření a použití scénáře pro Bank iD ověření přes API