Identifikační služba
Úvod

Toto je GoPay 3G REST API pro identifikační službu. Pro veškerou příchozí i odchozí komunikaci s API je použito kódování UTF-8.

Pro komunikaci jsou používány dva hlavní endpointy:

  • Autentizační služba - Poskytuje autorizaci, která je nutná pro přístup k Identifikační službě.

  • Identifikační služba - Poskytuje službu pro identifikaci subjektů.

Autorizační služba používá několik různých typů autorizace. Pro každou operaci je definován konkrétní typ autorizačního tokenu.

API ENDPOINT
Autentizační služba - https://auth.beta.aws.gopay.cz
Identifikační služba - https://client.beta.aws.gopay.cz
Autorizační služba

Umožňuje autorizovat operace prováděné přes API GoPay. K připojení využíváme standard OAuth 2.0.

Autorizační služba využívá více typů autorizačních tokenů, mezi kterými je nutné odlišovat. Každý typ autorizačního tokenu má určenou oblast operací, pro které je určen.

Aplikační token

Aplikační token je vytvořen na základě předávaných přístupových údajů ve formě <ClientID>:<ClientSecret>. Token je předáván jako autorizační parametr v hlavičce HTTP dotazu prostřednictvím Authorization: Bearer <accessToken>. K připojení využíváme OAuth 2.0, konkrétně průchod Client credentials.

Pokud ještě nemáte ClientID a ClientSecret, kontaktujte nás.

REQUEST

GET /api/login/app

HLAVIČKA POŽADAVKU

Název parametru Popis parametru Povinný
Authorization HTTP autorizace pomocí níž předáváte <ClientID>:<ClientSecret> ANO

RESPONSE

Název parametru Popis parametru Povinný
accessToken Přístupový token ANO
curl
Request

curl -v -N https://auth.beta.aws.gopay.cz/api/login/app \
-X "GET" \
-u "<ClientID>:<ClientSecret>"


Response

{
    "accessToken":"eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJodHRwOi8vYXV0aC9hcHAvMSIsImlzcyI6ImdvcGF5LmNvbSIsInNjb3B"
}
Klientský token

Připojením získá Odběratel identity možnost číst identifikační data Klienta. Klientský token zároveň reprezentuje souhlas (Consent) Klienta s předáváním identifikačních údajů Odběratelem identity. K připojení využíváme OAuth 2.0, konkrétně průchod Authorization Code.

Postup připojení uživatelského profilu

Cílem připojení uživatelského profilu je získání klientského (Consent) tokenu, který bude následně využíván Odběratelem identity k dotazování Identifikační služby.

1) Přesměrování Klienta na autorizační službu

Odběratel identity přesměrovává Klienta na autorizační službu pro získání autorizačního kódu (code). V rámci GET parametrů Odběratel identity předává:

Název parametru Popis parametru Povinný
scopes perm.client.identification (oblast přístupu o kterou Odběratel identity žádá) ANO
client_id Identifikátor aplikace Odběratele identity ANO
state Párovací identifikátor (je zpětně vrácen jako GET parametr redirect_uri v dalším kroku) NE
redirect_uri URL na něž bude Klient vrácen po udělení souhlasu Odběrateli identity NE
prefill_id Výsledné ID funkce předvyplnění údajů NE
curl
curl -v "https://auth.beta.aws.gopay.cz/consent?scopes[]=perm.client.identification:read&state=customer123&client_id=777777777777&redirect_uri=https%3A%2F%2Fcallback.odberatel-identity.cz&prefill_id=GhUhElzTqPmA5tUVJzO74SeMFt0Y3NEhpvQhbu5sTI8COWYqJFrdki" \
-X "GET"
2) Přesměrování Klienta na URL Odběralete identity

Klient, po provedení registrace, případně přihlášení, udělí souhlas. Následně je přesměrován zpět na redirect_uri Odběratele identity s potřebným autorizačním kódem (code) pro následné získání klientského tokenu.

V případě, že došlo k neočekávanému zpracování, je vrácen parametr error s upřesněním konkrétní chyby.

V redirectu předáváme GET parametry:

Název parametru Popis parametru
code Autorizační kód pro získání access tokenu, životnost 10 minut
state Párovací identifikátor
error Chyba v procesu
curl
curl -v "https://callback.odberatel-identity.cz/?code=98e804e5-f5ae-4c07-9e2e-539c06d623a2&state=customer123" \
-X "GET"
3) Získání klientského tokenu

Na základě získaného autorizačního kódu (code) provede Odběratel identity volání níže pro získání klientského access tokenu. Pro opětovné získání čerstvého access tokenu je nutné použít postup obnovy klientského tokenu.

REQUEST

POST /api/token

TĚLO POŽADAVKU

Název parametru Popis parametru Povinný
code Dočasný autorizační kód ANO
client_id client_credentials ANO
client_secret client_credentials ANO
grant_type Typ požadavku ANO

RESPONSE

Název parametru Popis parametru Datový typ
accessToken Přístupový token, aktivní po dobu 60 minut string
refreshToken Slouží pro získání nového access tokenu string
clientProfileId Identifikátor klientského profilu integer
curl
Request

curl -v https://auth.beta.aws.gopay.cz/api/token \
-X "POST" \
-d "client_id=777777777777&client_secret=AbAbAbAbAbAb&grant_type=authorization_code&code=67c6540e-4bbf-4e0d-a4c7-3fa418d30f5e"


Response

{"refreshToken":
    "eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5
    Nzc1MDc3NS1lODdmLTQyNzgtOTdlNC1iY2IxNzJjZDNhMzMiLCJpc3MiOiJnb3BheS5jb20i
    LCJqdGkiOiItNTY1MDU5NzQ0ODI1NDgzODAzIn0.MmJf0ZYgM9KBEWjnNeml_GKGmj3pctjt
    ufWwe-685N0oecux48nTq5SuRqfTfpflLUN76XwW4XVXiDYupG2xGgJiFk5KgemOzaIrM01I
    lcOBoDxQFXxH96rKgODIhZ0Y1CpIspQMFwBgdEksC-mlumQM5quJd8i8Hj31yg2nA1I0IOhW
    PAUg0dRg4tEUn_V1JFM3_qlU5mFzFZTWLOuV5bF4CRxxbTx2RGbU9HExHmmRVBzpze-XISmc
    wLR4uzxRs9YgPzpzE3ZXudXv3SUpdNn0X-i-lApfBWJ9k0jm2bfdO77tTi4_JwgdoBEj3RMy
    XD1UxvylAI2zNQrFg7GTsA",
"accessToken":
    "eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJo
    dHRwOi8vYXV0aC9hcHAvMzI3IiwiaXNzIjoiZ29wYXkuY29tIiwic2NvcGVzIjpbInBlcm0u
    Y2xpZW50LmlkZW50aWZpY2F0aW9uIiwiaHR0cDovL2NsaWVudC9jbGllbnRwcm9maWxlLzU4
    MSJdLCJleHAiOjE1MTM1OTcwOTgsImp0aSI6Ijg5MTc0NzE1Mjc3Nzk1MjczNDkifQ.QKKKC
    9EkxWS-7yi2LiRwELruziDlulOOAEAdAfxIPHSaubqllLVTFnCHf-Dm4bCkHhv-t7e9sJemt
    6AED4BH1fRg8s3_p0sahEd362O-gt0NyTTkPfnmmvUcbk2EfuFLZAoQqeni4NWgHTJWKWc9H
    NyFgAkyEbhopJ8mc5wP3o1AjiArHuLZmFaB9Cu6FWB64w5hkpTzx_YzpjVU1YxypF-8rPFRn
    X4duHSPXRhr7WmM-NjFwsYxBvuqNkagzENsvveJs3CnNIryZ0tlSgxiSEpCQeHRIJigHWpoG
    Vg_cy2f-pN-nU1OLdPHNh8Ycb_xRvjA5CXC8mhXamo95F4dpg",
"clientProfileId": 123
}
Obnova

Klientský token má omezenu životnost na dobu 60 minut. Pro opětovné získání čerstvého access tokenu je nutné použít postup, viz níže.

Refresh token je nutné držet relaci na Klienta. Je nutné zajistit jeho bezpečné uložení. Pro snížení pravděpodobnosti úniku využíváme výměnu refresh tokenu při každém obnovení.

REQUEST

POST /api/token

HLAVIČKA POŽADAVKU

Název parametru Popis parametru Datový typ
client_id client_credentials integer
client_secret client_credentials string
grant_type Typ požadavku string
refresh_token Refresh token string

RESPONSE

Název parametru Popis parametru Datový typ
accessToken Přístupový token, aktivní po dobu 60 minut. string
refreshToken Slouží pro získání nového access tokenu. POZOR - refreshToken se mění s každým voláním. string
clientProfileId Identifikátor klientského profilu integer
curl
Request

curl -v -N https://auth.beta.aws.gopay.cz/api/token \
-X "POST" \
-d "client_id=777777777777&client_secret=AbAbAbAbAbAb&grant_type=refresh_token&refresh_token=eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5"

Response

{"refreshToken":"eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJh
    ZmExNTc3NS0zYzcwLTQxYzctYWYwMS0wNDFlMGNmZjc4ZmUiLCJpc3MiOiJnb3BheS5jb20i
    LCJqdGkiOiItNjMzNzM5NzQyMjM1NTcyNjc0MyJ9.CNE4Za3mtBntw-imqCsctqyqXHikJxI
    rVrFArqc929Aikeg-zTipJ3vFgd2xwvJHvW3aIM2xagCNWH76RROC40CUTkI8SSQPNAD33sl
    dTBS3pf45BtCXUqSn9R_XOfWbMoi7A9mWxFoCNVGj4s9Z9A3oo2nbw68WCr0lrWrbSUZDxmy
    s-9Nbq2OgkILJweNj2kNSLIalcxqhbA-dv_-s7XSm6XNk82sY7DVkD5f5FMckwje_YwLP3aw
    dXP-y5aEEZvN3CBO_NpohCXbFkKevSAoBqlVaQPhwo4TIVt9eHrK_FX-ep3QYNNIuFM2YhcP
    XMBKqtO0oKYOXc4bHyx_PbQ",
"accessToken":"eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJo
    dHRwOi8vYXV0aC9hcHAvMzI3IiwiaXNzIjoiZ29wYXkuY29tIiwic2NvcGVzIjpbInBlcm0u
    Y2xpZW50LmlkZW50aWZpY2F0aW9uIiwiaHR0cDovL2NsaWVudC9jbGllbnRwcm9maWxlLzU4
    MSJdLCJleHAiOjE1MTM1OTgzMjksImp0aSI6Ii02MTI4MTc0ODcwNTUyMTYwNDk4In0.TKNf
    3YtCn9scQhFry2hfYavgsT3nyeJ4l6Am8Fm0CWI147UGRCWHuWZcEu6SqdFCxu1mlyOXLZl_
    gs4UhynW3UjDkCTE2rSkMEK3Lbcp7122okLYA1JZr1ZPAt2RQhrlnfsPOuBGZcDDnmtdqJwc
    v481jvBzKywfgHknM9__ZVl5H3CeE6We0woxSxOg9swFtBXrUEZRZU53OOJ7XEUmOHxtPNsn
    cSV0rY-tX79Xyf3192GaGoN5xVMcLkYXIVs4QT0dUa1n16J6kvJ_JhggniBeNXjIleGEcVKK
    N0soCwQqTSb2TNVt66oqZhYcR55sDxMiMZU0nrs1v8KPEpiVfg",
"clientProfileId": 123
}
Revokace

Pomocí revokace tokenu provede Odběratel identity odpojení identifikačního profilu.

REQUEST

POST /api/revoke

HLAVIČKA POŽADAVKU

Název parametru Popis parametru Datový typ
client_id client_credentials integer
client_secret client_credentials string
token Refresh token string

RESPONSE

Název parametru Popis parametru
{} Prázdná odpověď - úspěšné provedení značí odpověď HTTP 200
curl
Request

curl -v -N https://auth.beta.aws.gopay.cz/api/revoke \
-X "POST" \
-d "client_id=777777777777&client_secret=AbAbAbAbAbAb&token=eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5"

Response

Http 200
Identifikační služba

V rámci identifikační služby nabízí GoPay provedení identifikace uživatele bez nutnosti jeho fyzické přítomnosti. Získané údaje GoPay ukládá na zabezpečené úložiště a umožňuje k nim permanentní přístup prostřednictvím API v datové formě nebo ve formátu .PDF ve formě opisu identifikace. Zároveň s tím GoPay uložená data monitoruje a podporuje jejich aktuální platnost.

Autorizační služba: auth.beta.dev.gopay.cz.

Identifikační služba: client.beta.dev.gopay.cz.

Identifikační služba je komplexní zpracování a porovnání všech vstupních informací a materiálů poskytnutých uživatelem, jako jsou porovnání fotografie na dokladu s fotografiemi na druhém dokladu či “facematch” (jedná se o živě pořízenou fotografii), dále validace majitele bankovního účtu či disponenta na úrovni manžel či manželka s majitelem dokladu, porovnání ručně zadané adresy s IP a GEO lokalizací a mnoho dalších interních křížových kontrol, vypracovaných konkrétně pro tuto službu s cílem zvýšení kvality výstupních dat výrazně nad rámec legislativních požadavků.

Stav identifikace

Umožňuje číst identifikační údaje Klienta, případně aktuální stav průběhu identifikace.

Parametr clientProfileId je získán z odpovědi požadavku získání klientského tokenu.

REQUEST

GET /api/client-profile/{clientProfileId}/identification-status
Název parametru Popis parametru Povinný Datový typ
clientProfileId Identifikátor klientského profilu ANO path, string

HLAVIČKA POŽADAVKU

Název parametru Popis parametru Povinný
Authorization Bearer Klientský <access-token> ANO

RESPONSE

Název parametru Popis parametru Datový typ
clientProfileId Identifikátor klientského profilu integer
state Stav identifikace klientského profilu string
reasons Důvody neprovedení/průběhu identifikace Klienta string
dateStarted Den počátku identifikačního procesu Klienta string, yyyy-mm-dd HH:MM:SS:MS
dateLastChange Datum poslední změny v rámci procesu identifikace string, yyyy-mm-dd HH:MM:SS:MS HH:MM:SS:MS
subjectType Právní povaha identifikovaného subjektu string
subjectData Objekt obsahující dostupná data o Klientovi objekt
identificationData Veškeré informace získané procesem identifikace objekt
curl
Request

curl -v -N https://client.beta.aws.gopay.cz/api/client-profile/123/identification-status \
-H "Authorization: Bearer eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ"

Response

{
    "clientProfileId": 123,
    "state": "NOT_IDENTIFIED",
    "reasons": [
        "DENIED_FACEMATCH"
    ],
    "dateStarted": "2018-07-19 10:00:02.423",
    "dateLastChange": "2018-07-22 10:00:02.423"
}
Doplnění údajů

Pokud Odběratel identity požaduje doplnit/změnit identifikační údaje, potom přesměrovává Klienta na Identifikační službu GoPay pro doplnění údajů.

Zde se Klient přihlašuje do svého profilu, kde může provést požadované změny.

URL pro přesměrování: https://client.beta.aws.gopay.cz/identification

PDF opis

Umožňuje vygenerovat PDF opis identifikovaného Klienta.

Parametr clientProfileId je získán z odpovědi dotazu na stav identifikace / odpovědi získání klientského tokenu.

REQUEST

GET /api/client-profile/{clientProfileId}/identification-pdf
Název parametru Popis parametru Povinný Datový typ
clientProfileId Identifikátor klientského profilu ANO path, string
onDate Generování PDF opisu k určitému datu (pokud není uvedeno, je vrácen nejaktuálnější stav) NE query, YYYY-MM-DD

V hlavičce požadavku je možné použít jak Klientský, tak i Aplikační token (pokud byl souhlas Klienta historicky udělen).

HLAVIČKA POŽADAVKU

Název parametru Popis parametru Povinný
Authorization Bearer access-token ANO

RESPONSE

Odpověď typu application/pdf.

curl
Request

curl -v - N https://client.beta.aws.gopay.cz/api/client-profile/123/identification-pdf?onDate=2018-12-31 \
-H "Authorization: Bearer eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ"

Response

Odpověď typu: application/pdf

Další funkce

Dodatečné funkcionality využívají shodné komunikace s platební bránou jako funkce standardní implementace, ale rozšiřují ji o nové možnosti.

Předvyplnění údajů

Slouží pro předvyplnění údajů o Klientovi pro účely budoucí registrace/identifikace.

REQUEST

POST /api/prefill-client-data

HLAVIČKA POŽADAVKU

Název parametru Popis parametru Povinný
Content-Type application/json ANO
Authorization Bearer Klientský <access-token> ANO

TĚLO POŽADAVKU

Název parametru Popis parametru Datový typ
firstName Jméno zákazníka string
lastName Příjmení zákazníka string
email Validní e-mail zákazníka string
phoneNumber Telefonní číslo zákazníka s předvolbou string
domesticBankAccount Domácí forma bankovního účtu string
internationalBankAccount Mezinárodní forma bankovního účtu objekt
address Adresa zákazníka string

RESPONSE

Název parametru Popis parametru Datový typ
prefillId ID provedené operace string
curl
Request

curl -v - N https://client.beta.aws.gopay.cz/api/prefill-client-data \
-X "POST" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ" \
-d '{
        "firstName":"Jaroslav",
        "lastName":"Novák",
        "email":"jaroslav@novak.com",
        "phoneNumber":"+420777111222",
        "address":"Pekárenská 12, 37001 České Budějovice",
        "domesticBankAccount":"1108398027/3030",
        "internationalBankAccount": {
          "iban":"CZ6508000000192000145399",
          "bic":"KOMBCZPP"
          }
    }'   
    
Response

{
    "prefillId": "GhUhElzTqPmA5tUVJzO74SeMFt0Y3NEhpvQhbu5sTI8COWYqJFrdki"
}
Objekty

Popis jednotlivých objektů použitých při komunikaci s platební bránou

internationalBankAccount

Mezinárodní forma bankovního účtu

Název parametru Popis parametru Datový typ
iban Kód IBAN bankovního účtu Klienta string
bic SWIFT kód banky Klienta string
json
 {
   "iban":"CZ6508000000192000145399",
   "bic":"KOMBCZPP"
 }
subjectData

Objekt obsahující dostupná data o Klientovi

Název parametru Popis parametru Datový typ
firstName Křestní jméno string
lastName Příjmení string
dateOfBirth Datum narození string, yyyy-mm-dd
birthNumber Rodné číslo string
sex Pohlaví string
nationality Kód země string
json
{
    "firstName": "Pavel",
    "lastName": "Novák",
    "dateOfBirth": "1990-06-12",
    "birthNumber": "900612/0001",
    "sex": "MALE",
    "nationality": "CZE"
 }
identificationData

Veškeré informace získané procesem identifikace

Název parametru Popis parametru Datový typ
person Údaje identifikované osoby objekt
bankAccount Identifikace bankovním účtem objekt
address Ověření trvalé adresy objekt
additionalDocument Další doklady objekt
json
{
    "persons": [
      {
        "firstName": "Pavel",
        "lastName": "Novák",
        "dateOfBirth": "1990-06-12",
        "birthNumber": "900612/0001",
        "sex": "MALE",
        "country": "CZE",
        "faceMatch": {
          "verified": true,
          "source": "UPLOAD",
          "ip": "77.75.77.39",
          "dateReceived": "2018-02-15 17:10:44.760",
        },
        "identDocuments": [
          {
            "documentNumber": 123456,
            "state": "VERIFIED",
            "source": "UPLOAD",
            "documentType": "ID_CARD",
            "expiryDate": "2018-02-15 17:10:44.760",
            "nationalCountry": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "bankAccounts": [
          {
            "state": "VERIFIED",
            "country": "CZE",
            "prefix": {},
            "accountNumber": 2174251001,
            "bankCode": 192,
            "iban": "CZ6003000000002174251001",
            "bic": "CEKOCZPP",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "addresses": [
          {
            "state": "VERIFIED",
            "street": "Vinohradská",
            "streetNumber": 22,
            "postalCode": 11000,
            "city": "Praha",
            "country": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "additionalDocuments": [
          {
            "documentType": "BANK_STATEMENT",
            "source": "UPLOAD",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ]
      }
    ],
    "bankAccounts": [
      {
        "state": "VERIFIED",
        "country": "CZE",
        "prefix": {},
        "accountNumber": 2174251001,
        "bankCode": 192,
        "iban": "CZ6003000000002174251001",
        "bic": "CEKOCZPP",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
    ],
    "addresses": [
      {
        "state": "VERIFIED",
        "street": "Vinohradská",
        "streetNumber": 22,
        "postalCode": 11000,
        "city": "Praha",
        "country": "CZE",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
    ],
    "additionalDocuments": [
      {
        "documentType": "BANK_STATEMENT",
        "source": "UPLOAD",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
    ]
  }
person

Údaje identifikované osoby

Název parametru Popis parametru Datový typ
firstName Křestní jméno string
lastName Příjmení string
dateOfBirth Datum narození string, yyyy-mm-dd
birthNumber Rodné číslo string
sex Pohlaví string
nationality Kód země string
faceMatch Údaje získané rozpoznáním obličeje objekt
identDocument Údaje hlavního identifikačního dokladu objekt
bankAccount Identifikace bankovním účtem objekt
address Ověření trvalé adresy objekt
additionalDocument Další doklady objekt
json
 [{
        "firstName": "Pavel",
        "lastName": "Novák",
        "dateOfBirth": "1990-06-12",
        "birthNumber": "900612/0001",
        "sex": "MALE",
        "nationality": "CZE",
        "faceMatch": {
          "verified": true,
          "source": "UPLOAD",
          "ip": "77.75.77.39",
          "dateReceived": "2018-02-15 17:10:44.760"
        },
        "identDocuments": [
          {
            "documentNumber": 123456,
            "state": "VERIFIED",
            "source": "UPLOAD",
            "documentType": "ID_CARD",
            "expiryDate": "2018-02-15 17:10:44.760",
            "nationalCountry": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "bankAccounts": [
          {
            "state": "VERIFIED",
            "country": "CZE",
            "prefix": {},
            "accountNumber": 2174251001,
            "bankCode": 192,
            "iban": "CZ6003000000002174251001",
            "bic": "CEKOCZPP",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "addresses": [
          {
            "state": "VERIFIED",
            "street": "Vinohradská",
            "streetNumber": 22,
            "postalCode": 11000,
            "city": "Praha",
            "country": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "additionalDocuments": [
          {
            "documentType": "BANK_STATEMENT",
            "source": "UPLOAD",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ]
  }]
faceMatch

Údaje získané rozpoznáním obličeje

Název parametru Popis parametru Datový typ
verified Udává, zda byla identidikace úspěšná boolean
source Zdroj poskytnutí obrazu string
ip IP adresa string
dateReceived Datum získání obrazu obličeje string, yyyy-mm-dd HH:MM:SS:MS
json
{
      "verified": true,
      "source": "UPLOAD",
      "ip": "77.75.77.39",
      "dateReceived": "2018-02-15 17:10:44.760"
  }
identDocument

Údaje hlavního identifikačního dokladu

Název parametru Popis parametru Datový typ
documentNumber Identifikační číslo dokladu string
state Stav dokladu string
source Zdroj poskytnutí obrazu string
documentType Typ nahraného dokladu string
expiryDate Datum platnosti dokladu string, yyyy-mm-dd HH:MM:SS:MS
nationalCountry Kód země string
ip IP adresa string
dateReceived Datum získání dokladu string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Datum ověření dokladu string, yyyy-mm-dd HH:MM:SS:MS
json
[
        {
          "documentNumber": 123456,
          "state": "VERIFIED",
          "source": "UPLOAD",
          "documentType": "ID_CARD",
          "expiryDate": "2018-02-15 17:10:44.760",
          "nationalCountry": "CZE",
          "ip": "77.75.77.39",
          "dateReceived": "2018-02-15 17:10:44.760",
          "dateVerified": "2018-02-17 10:10:45.860"
        }
  ]
bankAccount

Identifikace bankovním účtem

Název parametru Popis parametru Datový typ
state Stav ověření bankovního účtu string
country Kód země string
prefix Předčíslí bankovního účtu Klienta string
accountNumber Číslo bankovního účtu Klienta string
bankCode Kód banky Klienta string
iban Kód IBAN bankovního účtu Klienta string
bic SWIFT kód banky Klienta string
ip IP adresa string
dateReceived Datum získání údajů o bankovním účtu string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Datum oveření bankovního účtu string, yyyy-mm-dd HH:MM:SS:MS
json
[
        {
             "state": "VERIFIED",
             "country": "CZE",
             "prefix": {},
             "accountNumber": 2174251001,
             "bankCode": 192,
             "iban": "CZ6003000000002174251001",
             "bic": "CEKOCZPP",
             "ip": "77.75.77.39",
             "dateReceived": "2018-02-15 17:10:44.760",
             "dateVerified": "2018-02-17 10:10:45.860"
        }
  ]
address

Ověření trvalé adresy

Název parametru Popis parametru Datový typ
state Stav ověření adresy string
street Ulice string
streetNumber Číslo popisné string
postalCode Poštovní směrovací číslo string
city Město string
country Kód země string
ip IP adresa string
dateReceived Datum získání adresy string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Datum ověření adresy string, yyyy-mm-dd HH:MM:SS:MS
json
[
      {
        "state": "VERIFIED",
        "street": "Vinohradská",
        "streetNumber": 22,
        "postalCode": 11000,
        "city": "Praha",
        "country": "CZE",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
]
additionalDocument

Další doklady

Název parametru Popis parametru Datový typ
documentType Typ nahraného dokladu string
source Zdroj poskytnutí obrazu string
ip IP adresa string
dateReceived Datum získání dodatečného dokladu string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Datum ověření dodatečného dokladu string, yyyy-mm-dd HH:MM:SS:MS
json
[
      {
        "documentType": "BANK_STATEMENT",
        "source": "UPLOAD",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
]
Číselníky
error

Chyba při přesměrování Klienta na URL Odběralete identity

Hodnota parametru Popis
access_denied Klient neudělil souhlas
invalid_scope Nepovolená oblast přístupových práv
state

Stav identifikace klientského profilu

Hodnota parametru Popis
PENDING Probíhající identifikace
IDENTIFIED Identifikace provedena
PARTIALLY_IDENTIFIED Identifikace částečně provedena
NOT_IDENTIFIED Identifikace nebyla provedena
reasons

Seznam důvodů, proč nebyla identifikace Klienta provedena, či proč stále probíhá

Hodnota parametru Popis
EXPIRED_IDENTIFICATION Vypršela platnost identifikace
EXPIRED_IDENT_DOCUMENT Vypršela platnost identifikačního dokladu
WAITING_IDENT_DOCUMENT Čekání na identifikační doklad
WAITING_ADDITIONAL_DOCUMENT Čekání na dodatečný doklad
WAITING_ADDRESS Čekání na ověření adresy
WAITING_BANK_ACCOUNT Čekání na ověření bankovního účtu
DENIED_FRAUD Zamítnuto - padělaný doklad
DENIED_FACEMATCH Zamítnuto - neshoda obličeje
DENIED_BAD_QUALITY_DOCUMENT Zamítnuto - špatná kvalita dokladu
subjectType

Právní povaha identifikovaného subjektu

Hodnota parametru Popis
PERSON Fyzická osoba
COMPANY Právnická osoba
sex

Pohlaví

Hodnota parametru Popis
MALE Muž
FEMALE Žena
source

Zdroj poskytnutí obrazu

Hodnota parametru Popis
UPLOAD Nahrání souboru
WEBCAM Webová kamera
MOBILE Mobilní telefon
Stav dokladu

Stav nahraného dokladu

Hodnota parametru Popis
VERIFIED Platný
EXPIRED Neplatný
documentType

Typ nahraného dokladu

Hodnota parametru Popis
ID_CARD Průkaz totožnosti
DRIVING_LICENSE Řidičský průkaz
PASSPORT Cestovní pas
VISA Vízum
UNSUPPORTED Nepodporovaný doklad
UTILITY_BILL Účet za služby
BANK_STATEMENT Výpis z bankovního účtu
Stav ověření bankovního účtu

Stav ověření bankovního účtu

Hodnota parametru Popis
VERIFIED Oveřen
Stav ověření adresy

Stav ověření trvalé adresy Klienta

Hodnota parametru Popis
VERIFIED Oveřena
HTTP result kódy
200 Http 200

Volání proběhlo úspěšně

403 Http 403

Neautorizovaný přístup

409 Http 409

Validační chyby

500 Http 500

Volání skončilo chybou

404 Http 404

Neexistující služba