Verifikasi OTP
Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
Autentikasi
Lihat Autentikasi untuk memahami cara melakukan autentikasi API.
Contoh request
Header request
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Tampilkan blok kode ini di jendela mengambang
Body request
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Tampilkan blok kode ini di jendela mengambang
Parameter request
| Parameter | Tipe | Opsi | Keterangan |
|---|---|---|---|
| message_id | String | Wajib | ID pesan yang sesuai dengan kode verifikasi, dikembalikan oleh endpoint /messages |
| verify_code | String | Wajib | Kode verifikasi yang perlu divalidasi |
Parameter respons
Respons sukses
| Field | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| message_id | String | Wajib | ID pesan yang sesuai dengan kode verifikasi, dikembalikan oleh endpoint /v1/messages |
| verify_code | String | Wajib | Kode verifikasi yang perlu divalidasi |
| verified | Boolean | Wajib | Hasil validasi, true berarti validasi berhasil, false berarti validasi gagal |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Tampilkan blok kode ini di jendela mengambang
Perhatikan, untuk request validasi kode verifikasi pada pesan yang sama, jika validasi kode verifikasi berhasil, lalu endpoint validasi ini dipanggil lagi, maka endpoint akan mengembalikan kegagalan, dengan pesan bahwa kode verifikasi pesan ini telah selesai divalidasi; artinya tidak mendukung verifikasi ulang terhadap kode verifikasi yang sudah berhasil diverifikasi.
Respons gagal
Status code HTTP adalah 4xx atau 5xx, body respons berisi field sebagai berikut:
| Field | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| code | int | Wajib | Kode error, lihat penjelasan kode error |
| message | String | Wajib | Detail error |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
Tampilkan blok kode ini di jendela mengambang
Kode error
| Kode error | http code | Keterangan |
|---|---|---|
| 1000 | 500 | Error internal |
| 2001 | 401 | Autentikasi gagal, tidak menyertakan token yang benar |
| 2002 | 401 | Autentikasi gagal, token telah kedaluwarsa atau dinonaktifkan |
| 2004 | 403 | Tidak memiliki izin untuk memanggil API ini |
| 3001 | 400 | Format parameter request tidak valid, harap periksa apakah konten JSON sesuai dengan format parameter |
| 3002 | 400 | Parameter request salah, harap periksa apakah parameter request memenuhi persyaratan |
| 3003 | 400 | Kode verifikasi kedaluwarsa atau telah diverifikasi, untuk respons kode error ini, perlu mengirim ulang pesan kode verifikasi baru |
| 3011 | 400 | Kode verifikasi kedaluwarsa |
| 4001 | 400 | Pesan ini tidak ada |
