Verifikasi
Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
Autentikasi
Menggunakan metode HTTP Basic Authentication. Tambahkan Authorization pada HTTP Header:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Tampilkan blok kode ini di jendela mengambang
Algoritma pembuatan base64_auth_string: base64(dev_key:dev_secret)
Contoh Permintaan
Header Permintaan
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 Permintaan
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Tampilkan blok kode ini di jendela mengambang
Parameter Permintaan
| Parameter | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| message_id | String | Wajib | ID pesan yang terkait dengan kode verifikasi, dikembalikan oleh endpoint /messages |
| verify_code | String | Wajib | Kode verifikasi yang akan divalidasi |
Parameter Respons
Respons Berhasil
| Field | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| message_id | String | Wajib | ID pesan yang terkait dengan kode verifikasi, dikembalikan oleh endpoint /v1/messages |
| verify_code | String | Wajib | Kode verifikasi yang akan divalidasi |
| verified | Boolean | Wajib | Hasil verifikasi, true jika validasi berhasil, false jika gagal |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Tampilkan blok kode ini di jendela mengambang
Catatan: Untuk kode verifikasi pada pesan yang sama, jika permintaan validasi berhasil, permintaan validasi berikutnya akan gagal, menandakan bahwa verifikasi untuk pesan ini sudah selesai; kode verifikasi yang sudah berhasil diverifikasi tidak dapat divalidasi kembali.
Respons Gagal
Kode status HTTP 4xx atau 5xx, body respons mencakup field berikut:
| Field | Tipe | Opsi | Deskripsi |
|---|---|---|---|
| code | int | Wajib | Kode error, lihat Kode Error untuk detailnya |
| 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 | Kode HTTP | Deskripsi |
|---|---|---|
| 1000 | 500 | Kesalahan internal |
| 2001 | 401 | Autentikasi gagal, token salah atau tidak ada |
| 2002 | 401 | Autentikasi gagal, token kedaluwarsa atau telah dinonaktifkan |
| 2004 | 403 | Tidak memiliki izin untuk mengakses API ini |
| 3001 | 400 | Format parameter permintaan tidak valid, pastikan sesuai dengan format JSON yang dibutuhkan |
| 3002 | 400 | Parameter permintaan salah, pastikan sudah sesuai dengan ketentuan |
| 3003 | 400 | Kode verifikasi kedaluwarsa atau sudah diverifikasi, perlu mengirim pesan verifikasi baru untuk kode error ini |
| 4001 | 400 | Pesan tidak ditemukan |
