## API URL

Adresa URL používaná k odeslání požadavků HTTP:

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

> [!NOTE]
> Nedostane-li se požadavek k cíli, zopakujte ho na [záložním serveru](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/zalozni-server/) `backup1.bulkgate.com`.

## Podporované HTTP metody

- `POST` - `application/json`

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

## Tabulka s parametry

| JMÉNO PARAMETRU   | HODNOTA                                                                                                                             | POVINNÝ | VÝCHOZÍ HODNOTA |
|:------------------|:------------------------------------------------------------------------------------------------------------------------------------|:--------|:----------------|
| application_id    | [Application ID](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/administrace-api/)                                                                                       | **Ano** | -               | 
| application_token | [Application token](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-tokeny/)	                                                                                           | **Ano** | -               |
| id                | ID získané po odeslání [SEND](https://www.bulkgate.com/cs/dokumentace/otp-api/odeslani-jednorazoveho-hesla/) nebo [RESEND](https://www.bulkgate.com/cs/dokumentace/otp-api/preposlani-jednorazoveho-hesla/) požadavku | **Ano** | -               |
| code              | Verifikační kód ke kontrole                                                                                                         | **Ano** | -               |


## Příklad požadavku

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

## Odpověď

**V případě úspěchu:**
```json
{
    "data": {
        "id": "otp-id",
        "verified": true
    }
}
```

**V případě neplatného kódu:**
```json
{
    "data": {
        "id": "otp-id",
        "verified": false
    }
}
```

**V případě 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) najdete v [tabulce typů chyb](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňující informace o chybě