Lewati ke konten utama

Error & status code

Setiap response memakai HTTP status code standar dan format JSON yang sama, sehingga error bisa ditangani dengan satu pola.

Daftar status code​

StatusArtiCara memperbaiki
200OKRequest berhasil.Baca hasil di data.
400Bad RequestRequest tidak valid: parameter wajib hilang, body JSON rusak, atau file tidak didukung.Periksa nama, tipe, dan format parameter di halaman produk.
401UnauthorizedAPI key tidak valid atau tidak dikirim.Kirim header x-api-co-id dengan key yang aktif.
402Payment RequiredSaldo atau subscription tidak cukup.Isi saldo di Dashboard, lalu ulangi request.
403ForbiddenAkses ditolak, mis. eKYC akun belum disetujui untuk produk verifikasi identitas.Selesaikan eKYC di Dashboard atau cek akses produk.
404Not FoundData tidak ditemukan.Periksa ID, kode, atau nomor yang dikirim.
413Payload Too LargeFile melebihi batas ukuran.Kecilkan file sesuai batas di halaman produk.
422UnprocessableData tidak lolos validasi.Periksa format field (mis. NIK, tanggal lahir) dan batas nilainya.
429Too Many RequestsKuota atau rate limit habis.Kurangi laju request atau tunggu kuota direset; upgrade paket bila perlu.
500Server ErrorKesalahan di server kami.Ulangi beberapa saat lagi; hubungi support bila berlanjut.
502Bad GatewayProvider upstream mengembalikan error.Ulangi beberapa saat lagi.
503UnavailableLayanan atau provider sementara tidak tersedia.Ulangi beberapa saat lagi.
504Gateway TimeoutProvider tidak merespons tepat waktu.Ulangi request; pakai timeout yang cukup di sisi Anda.

Tidak semua produk memakai semua kode di atas. Halaman produk mencantumkan kondisi error yang spesifik.

Format response​

Response sukses maupun error memakai envelope JSON yang sama. Gunakan is_success untuk mengecek hasil dan message untuk detail error.

Response error
{
"is_success": false,
"message": "User not authenticated",
"data": null
}
  • is_success: true jika request berhasil, false jika error.
  • message: pesan singkat tentang hasil request.
  • data: payload utama (objek atau array), null saat error.
  • paging: hanya ada di endpoint yang memakai paginasi.
Chat API

Chat API memakai format error sendiri (error.code, error.message, error.details). Lihat Chat API › Reference.

Apakah halaman ini membantu?