Oveření One Time Password (OTP)
API URL
Adresa URL používaná k odeslání požadavků HTTP:
https://portal.bulkgate.com/api/1.0/otp/verify
POST /api/1.0/otp/verify HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
Tabulka parametrů
JMÉNO PARAMETRU | HODNOTA | POVINNÝ | VÝCHOZÍ HODNOTA |
---|---|---|---|
application_id | Application ID | Ano | - |
application_token | Application token | Ano | - |
id | ID získané po odeslání SEND nebo RESEND požadavku | Ano | - |
code | Verifikační kód ke kontrole | Ano | - |
Příklad úplného požadavku
POST /api/1.0/otp/verify HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache
{
"application_id": "APPLICATION_ID",
"application_token": "APPLICATION_TOKEN",
"id": "opt-id",
"code": "0000"
}
Odpověď na tento příkaz může být:
V případě úspěchu:
{
"data": {
"id": "opt-id",
"verified": true
}
}
V případě neplatného kódu:
{
"data": {
"id": "opt-id",
"verified": false
}
}
V případě chyby:
{
"type": "unknown_identity",
"code": 400,
"error": "Unknown identity",
"detail": null
}
{
"type": "invalid_input_parameters",
"code": 400,
"error": "Invalid input parameters",
"detail": null
}