## API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

```url
https://portal.bulkgate.com/api/1.0/otp/verify
```

> [!NOTE]
> Ak sa požiadavka nedostane k cieľu, zopakujte ju na [záložnom serveri](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/zalozny-server/) `backup1.bulkgate.com`.

## Podporované HTTP metódy

- `POST` - `application/json`

```http
POST /api/1.0/otp/verify HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

## Tabuľka s parametrami

| NÁZOV PARAMETRA   | HODNOTA                                                                                                                             | POVINNÝ | PREDVOLENÁ HODNOTA |
|:------------------|:------------------------------------------------------------------------------------------------------------------------------------|:--------|:----------------|
| application_id    | [Application ID](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/)                                                                                       | **Áno** | -               | 
| application_token | [Application token](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)	                                                                                           | **Áno** | -               |
| id                | ID získané po odoslaní požiadavky [SEND](https://www.bulkgate.com/sk/dokumentacia/otp-api/odoslanie-jednorazoveho-hesla/) alebo [RESEND](https://www.bulkgate.com/sk/dokumentacia/otp-api/preposlanie-jednorazoveho-hesla/) | **Áno** | -               |
| code              | Overovací kód na kontrolu                                                                                                         | **Áno** | -               |


## Príklad požiadavky

```http-json
POST /api/1.0/otp/verify HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json

{
    "application_id": 451,
    "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
    "id": "otp-id",
    "code": "0000"
}
```

## Odpoveď

**V prípade úspechu:**
```json
{
    "data": {
        "id": "otp-id",
        "verified": true
    }
}
```

**V prípade neplatného kódu:**
```json
{
    "data": {
        "id": "otp-id",
        "verified": false
    }
}
```

**V prípade chyby:**
```json
{
    "type": "unknown_identity",
    "code": 400,
    "error": "Unknown identity",
    "detail": null
}
```

```json
{
    "type": "invalid_input_parameters",
    "code": 400,
    "error": "Invalid input parameters",
    "detail": null
}
```

Kde:

- **type** a **error** (popis chyby) nájdete v [tabuľke typov chýb](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňujúca informácia o chybe