NAV undefined
undefined
bash

Introduksi

Selamat datang di Iluma! Misi kami disini adalah menyediakan infrastruktur digital yang dapat membantu kesuksesan bisnis anda. Dengan produk-produk yang sehubungan dengan data, kami dapat membantu anda dalam melakukan proses Know-Your-Customer (KYC) Anda, dan mengurangi resiko baik dari segi uang masuk (penerimaan pembayaran) maupun uang keluar (pembayaran ke pihak luar). Contoh-contoh bisnis yang terbantu oleh produk kami meliputi dari bisnis platform hingga fintech lending dan eCommerce, dan bisnis-bisnis lain yang sehubungan dengan itu.

API Iluma berkisar seputar REST. API kami memiliki URL yang intuitif, mengacu pada standar REST, dan menggunakan kode respon standar HTTP untuk menampilkan error. Kami menggunakan fitur-fitur dan istilah-istilah HTTP terintegrasi, yang dapat dipahami oleh kebanyakan klien-klien HTTP umum. Bentuk respon yang dikembalikan oleh semua API kami berupa JSON (termasuk kode error). Kami terus menerus memperbaharui versi API oleh endpoint dan versi-versi yang terbaru akan selalu tersedia di sini.

Pelajari API kami dengan Postman

Untuk mempermudah anda mengenali API kami lebih dalam, kami telah menerbitkan Postman Collection sehingga Anda dapat melihat contoh-contoh versi terbaru dari API Iluma di satu tempat. Untuk menggunakan ini, Anda harus:

Otentikasi

Agar berhasil mengotentikasi dengan API Iluma, Anda harus menggunakan Otentikasi Basic dengan API key Anda sebagai nama pengguna dan tanpa kata sandi. Jika Anda membuat request header secara manual, anda harus menambahkan parameter -authorization, juga Anda harus menambahkan titik dua dan meng-encode API key anda menggunakan Base64 encoding. Misalnya jika API key Anda:

iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Pertama, tambahkan tanda titik dua di bagian akhir:

iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Lalu encode API key tersebut menggunakan Base64 encode untuk mendapatkan:

aWx1bWFfZGV2ZWxvcG1lbnRfRlg0ZjBNNXN4RGdrNXFGeVpuazYwWmVuZ0FmQTlvMzF4M2VjZDI5dmloamM0Vmh5SjhGY2xaaEhqanc6

Iluma API mengacu pada standar REST sehingga API ini lebih rapi dan lebih mudah dipahami. Semua respons API kami akan dikembalikan dalam bentuk JSON. Anda bisa mencoba API kami lebih dalam dengan mendapatkan dan menggunakan API key untuk environment development dan live yang sudah kami sediakan. Kami akan mengembalikan data dummy untuk semua request yang dibuat di environment development dan Anda tidak akan dikenakan biaya apa pun.

Sebelum menggunakan API, pastikan Anda telah mendaftarkan akun anda dan dikonfirmasi oleh kami karena permintaan API tanpa otentikasi akan gagal. Hubungi kami untuk memulai. Our sales team will process your application and send you the details you need to retrieve your API keys from the Get API Key endpoint. Then you can authenticate subsequent requests by including your secret API key in the request header. Your development and live keys determine your environment. Your Oauth Token and API keys should be kept private so do not share these.

Tim sales kami akan mem-proses aplikasi anda dan akan mengirim detil informasi yang anda butuhkan untuk mendapatkan API key anda dari Get API Key endpoint. Lalu anda dapat melakukan otentikasi pada request-request anda dengan memasukkan API key di request header.

Untuk mendapatkan API key anda, anda harus melakukan GET request ke Get API Key endpoint kami menggunakan business ID Iluma dan token OAuth Iluma yang tim sales kami akan sediakan untuk anda. Lalu anda bisa mulai mengautentikasi akun dengan memasukkan API key Anda dalam request header. Environment API anda ditentukan oleh jenis API key anda baik itu live maupun development. Token Oauth dan API key Anda harus dirahasiakan dan tidak boleh disebar secara publik.

Semua request API harus dilakukan melalui HTTPS dan bukan HTTP (semua panggilan yang dilakukan melalui HTTP biasa akan gagal). Kami sedang terus mengembangkan library dan plugin dan jika Anda mempunyai library Anda sendiri, kami siap membantu anda berintegrasi dengan library tersebut. Pastikan Anda telah menyelesaikan otentikasi sebelum menggunakan API kami.

Get API Key

Endpoint: Get API Key

GET https://api.iluma.ai/businesses/:business_id/api_keys?token=:token

Contoh Get API Key Request

curl https://api.iluma.ai/businesses/5abc/api_keys?token=123 \
    -X GET

Untuk mendapatkan API key iluma anda, anda harus melakukan otentikasi melalui GET request ke endpoint tersebut menggunakan business ID dan token OAuth Iluma anda. Business ID dan token OAuth bisa didapatkan dari tim sales kami setelah anda berhasil melakukan registrasi akun.

Callback

Sebagian servis kami meng-implementasi-kan proses callback untuk menjaga kualitas performa http request dan kenyamanan customer kami. Servis yang memiliki proses callback di antaranya adalah Bank Name Validator, NPWP Validator eWallet Validator and ID Card OCR. Callback akan memberikan response API yang sudah selesai (contohnya, status akhir berhasil atau gagal setelah kami memproses request anda melalui semua sumber data yang tersedia. Anda bisa melihat dokumentasi dari setiap produk untuk informasi lebih lanjut tentang respon callback dari masing-masing produk tersebut.

Berbagai metode yang dijelaskan di bagian ini memungkinkan anda untuk membuat, mengambil dan mengubah callback url anda. Respon APInya bergantung pada environment yang anda pakai, mohon pakai development API key anda untuk membuat callback untuk development enviroment, dan Live API Key untuk membuat callback untuk Live Environment.

Semua panggilan balik akan dikirim melalui alamat IP berikut:

Live Environment:

Development Environment:

Skema Respon Callback

Kecuali dijelaskan berbeda, semua endpoint dibagian ini akan mengembalikan respon dengan skema sebagai berikut.

Parameter Deskripsi
status string (dibutuhkan)
Status dari URL ini yang anda buat
url string (dibutuhkan)
Alamat URL yang akan kami kirimkan callback
type string (dibutuhkan)
Endpoint yang dikonfigurasikan untuk alamat callback url
created string (dibutuhkan)
Timestamp yang menunjukan kapan callback url ini dibuat. ISO8601 format
updated string (dibutuhkan)
Timestamp yang menunjukan kapan callback url ini terakhir diubah. ISO8601 format
id string (dibutuhkan)
ID referensi unik kami untuk pengaturan callback url ini

Token Otentikasi Callback

Endpoint: Token Otentikasi Callback

GET https://api.iluma.ai/v1/callback/authentication_tokens

Contoh token otentikasi callback

curl https://api.iluma.ai/v1/callback/authentication_tokens \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Token Otentikasi Callback mengembalikan token yang tersimpan di X-CALLBACK-TOKEN header dari request callback kami ke dalam url callback anda. Dengan ini, anda dapat mem-verifikasi request yang berasal dari kita. Jaga baik-baik kerahasiaan token ini. Bila dengan alasan apapun anda perlu untuk merubah token anda, Hubungi Kami.

Contoh Respon Token Otentikasi Callback

{
    "token": "47a843dfd72a9f564b6fb2e4092294d939884d62602a1a7f3679820f7ce0d0f2",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Skema Token Otentikasi Callback

Parameter Deskripsi
token string (dibutuhkan)
Token anda. Jaga baik-baik kerahasiaannya.
created string (dibutuhkan)
Waktu pembuatan token.
updated string (dibutuhkan)
Waktu terakhir peng-update-an token.
id string (dibutuhkan)
ID unik token otentikasi callback anda.

Membuat URL Callback

Endpoint: Create Callback Url

POST https://api.iluma.ai/v1/callback/urls

Contoh Pembuatan Url Callback

curl https://api.iluma.ai/v1/callback/urls \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "type": "EWALLET_ACCOUNT_VALIDATION",
        "url": "https://acme.client.com/webhook/ewallet"
    }'

Buat POST request ke endpoint ini untuk membuat callback url yang baru ke endpoint yang anda hendaki

Payload pengujian akan dikirim ke URL anda dengan konten berikut:

{
  "test": true
}

Anda perlu memastikan bahwa backend anda merespons dengan kode status HTTP 200 untuk payload tersebut. Jika tidak, URL panggilan balik anda tidak akan disimpan.

Request Membuat Url Callback

Parameter Description
type string (dibutuhkan)
Gunakan akses produk sesuai dengan produk yang digunakan untuk selanjutnya dikonfigurasikan ke callback url. Berikut adalah daftar akses produk Iluma:
NPWP_DATA_REQUEST, NAME_VALIDATOR_REQUEST, EWALLET_ACCOUNT_VALIDATION, ID_IMAGE_OCR_REQUEST, BUSINESS_DOCUMENT_OCR_REQUEST, DOCUMENT_OCR_CAPTURE_REQUEST, BANK_NAME_VALIDATOR_DETAILS
url string (dibutuhkan)
Link url untuk menerima callback yang dikirim dari Iluma

Contoh Respon Pembuatan Url Callback

{
    "status": "ACTIVE",
    "url": "https://iluma.ai/webhook/ewallet",
    "type": "EWALLET_ACCOUNT_VALIDATION",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Error Pembuatan Url Callback

Kode Error Deskripsi
DUPLICATE_CALLBACK_URL_ERROR
400		 Url callback ini sudah pernah dibuat sebelumnya. Gunakan methode PATCH untuk meng-update url ini.
NON_2XX_RESPONSE_ERROR
400		 Url anda tidak mengembalikan respon dalam daftar respon http 2xx.
REQUEST_FAILURE_ERROR
500		 Kami gagal membuat request ke url anda.

Daftar Callback Urls

Endpoint: Daftar URL Callback

GET https://api.iluma.ai/v1/callback/urls

Contoh daftar Callback Url

curl https://api.iluma.ai/v1/callback/urls \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Buat GET request ke endpoint ini untuk mengambil list dari semua callback url yang pernah anda buat untuk environment tersebut. Jika anda belum pernah membuat satupun callback url, kami akan memberikan response error.

Contoh Respon Callback Url 

[
    {
        "status": "ACTIVE",
        "url": "https://iluma.ai/webhook/ewallet",
        "type": "EWALLET_ACCOUNT_VALIDATION",
        "created": "2019-01-08T08:08:08.888Z",
        "updated": "2019-01-08T08:08:08.888Z",
        "id": "59e608887eb26d005d44aeb8"
    },
    {
        "status": "INACTIVE",
        "url": "https://iluma.ai/webhook/name_validator",
        "type": "NAME_VALIDATOR_REQUEST",
        "created": "2019-01-08T08:08:08.888Z",
        "updated": "2019-01-08T08:08:08.888Z",
        "id": "59e608887eb26d005d44aeb8"
    }
]

Contoh Error Callback Url

Kode Error Deskripsi
CALLBACK_URL_NOT_FOUND_ERROR
404		 Anda belum membuat callback URL ini.

Mendapatkan Url Callback Url Sesuai Tipe

Endpoint: Mendapatkan Url Callback Url Sesuai Tipe

GET https://api.iluma.ai/v1/callback/urls/:type

Contoh Mendapatkan Url Callback Url Sesuai Tipe

curl https://api.iluma.ai/v1/callback/urls/NAME_VALIDATOR_REQUEST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Buat Get Request ke endpoint ini untuk mengambil satu callback url secara spesifik dari yang sebelumnya anda buat. Tambahkan type sebagai paramater di url

Contoh Mendapatkan Url Callback Url Sesuai Tipe

{
    "status": "ACTIVE",
    "url": "https://iluma.ai/webhook/name_validator",
    "type": "NAME_VALIDATOR_REQUEST",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Error Mendapatkan Url Callback Url Sesuai Tipe

Kode Error Deskripsi
CALLBACK_URL_NOT_FOUND_ERROR
404		 Anda belum pernah membuat url callback untuk tipe ini.

Update Callback Url Sesuai Tipe

Endpoint: Update Callback Url By Type

PATCH https://api.iluma.ai/v1/callback/urls/:type

Contoh Update Callback Url Sesuai Tipe

curl https://api.iluma.ai/v1/callback/urls/NAME_VALIDATOR_REQUEST \
    -X PATCH \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -d url="https://iluma.ai/webhook/name_validator"

Contoh Update Callback Url Sesuai Tipe

curl https://api.iluma.ai/v1/callback/urls/NAME_VALIDATOR_REQUEST \
    -X PATCH \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -d status="ACTIVE"

Buat PATCH request untuk mengubah baik callback url maupun status dari url anda. Hanya salah satu dari antara url atau status yang bisa diubah pada waktu yang bersamaan. Meng-update status menjadi INACTIVE memungkinkan anda untuk berhenti menerima callback dari service tertentu. Ini sangat berguna jika servis anda sedang dalam perbaikan dan anda tidak mau kami untuk mengirimkan request ke url anda.

Contoh Update Callback Url Sesuai Tipe

{
    "status": "ACTIVE",
    "url": "https://iluma.ai/webhook/name_validator",
    "type": "NAME_VALIDATOR_REQUEST",
    "created": "2019-01-08T08:08:08.888Z",
    "updated": "2019-01-08T08:08:08.888Z",
    "id": "59e608887eb26d005d44aeb8"
}

Error Update Callback Url Sesuai Tipe

Kode Error Deskripsi
CALLBACK_URL_NOT_FOUND_ERROR
404		 Anda belum pernah membuat url callback untuk tipe ini.
NON_2XX_RESPONSE_ERROR
400		 Url anda tidak mengembalikan respon dalam daftar respon http 2xx.
REQUEST_FAILURE_ERROR
500		 Kami gagal membuat request ke url anda.

Identity

Rangkaian produk identity Iluma dapat membantu Anda untuk memudahkan proses pendaftaran dan onboarding dari customer Anda dengan melakukan ekstraksi informasi yang ter-otomasi dari dokumen-dokumen identitas yang mereka miliki, pengecekan terhadap konsistensi perincian yang dikirim oleh customer anda dengan data internal dan data di catatan pemerintahan, dan apakah customer anda memang benar memiliki identifikasi yang otentik.

Dapatkan Kode Bank yang Tersedia

Endpoint: Dapatkan kode bank yang tersedia

GET https://api.iluma.ai/v1.2/bank/available_bank_codes

Contoh Dapatkan kode bank yang tersedia

curl https://api.iluma.ai/v1.2/bank/available_bank_codes \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Temukan daftar kode bank di bawah ini untuk bank yang kami dukung dengan awalan negara. Kami mendukung permintaan rekening di 140+ bank di Indonesia. Jika Anda ingin kami mendukung bank tertentu, harap hubungi kami

Bank Codes

Parameter Description
name string (wajib)
Nama bank
code string (required)
Bank code
swift_code string (wajib)
Kode SWIFT Bank
remark string (opsional)
Keterangan untuk kode bank.

Example Get Available Bank Codes Response

[
    {
        "name": "Bank ANZ Indonesia",
        "code": "ANZ",
        "swift_code": "ANZBIDJX"
    },
    {
        "name": "Bank Artha Graha International",
        "code": "ARTHA",
        "swift_code": "ARTGIDJA"
    },
    {
        "name": "Bank Artos Indonesia",
        "code": "ARTOS",
        "swift_code": "ATOSIDJ1",
        "remark": "Deprecating in Jan 2023. Please use `JAGO` going forward"
    }
]

Dapatkan Kode Bank yang Tersedia - v1.2

Endpoint: Dapatkan kode bank yang tersedia

GET https://api.iluma.ai/bank/available_bank_codes

Contoh Dapatkan kode bank yang tersedia

curl https://api.iluma.ai/bank/available_bank_codes \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Temukan daftar kode bank di bawah ini untuk bank yang kami dukung dengan awalan negara. Kami mendukung permintaan rekening di 140+ bank di Indonesia, termasuk beberapa BPD dan BPR dan 40+ bank di Vietnam. Jika Anda ingin kami mendukung bank tertentu, harap hubungi kami

Bank Codes

Parameter Description
name string (wajib)
Nama bank
code string (required)
Bank code with prefix (ID_ untuk kode bank Indonesia dan VN_ untuk kode Vietnam)
swift_code string (wajib)
Kode SWIFT Bank
remark string (opsional)
Keterangan untuk kode bank.

Contoh Dapatkan Respons Kode Bank yang Tersedia

[
  {
    "name": "Bank ANZ Indonesia",
    "code": "ID_ANZ",
    "swift_code": "ANZBIDJX"
  },
  {
    "name": "Bank Artha Graha International",
    "code": "ID_ARTHA",
    "swift_code": "ARTGIDJA"
  },
  {
    "name": "Bank Artos Indonesia",
    "code": "ID_ARTOS",
    "swift_code": "ATOSIDJ1",
    "remark": "Deprecating in Jan 2023. Please use `JAGO` going forward"
  },
  {
    "code": "VN_SHB",
    "name": "SHB",
    "swift_code": "",
    "remark": ""
  },
  {
    "code": "VN_SAIGONBANK",
    "name": "SAIGONBANK",
    "swift_code": "",
    "remark": ""
  },
  {
    "code": "VN_SCB",
    "name": "SCB",
    "swift_code": "",
    "remark": ""
  }
]

Validasi Nama Bank

Endpoint: Validasi nama di akun bank dengan nama yang sudah disediakan

POST https://api.iluma.ai/v2.2/identity/bank_account_data_requests

Contoh Request Validasi Nama Bank

curl https://api.iluma.ai/v2.2/identity/bank_account_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "given_name": "FIRA DIYANKA",
    "surname": "FEBRIYANTI",
    "reference_id": "foo123"
    }'

Servis Validasi Nama Akun Bank dapat digunakan untuk mengecek nama yang tertera di setiap akun bank di Indonesia serta mengecek kesamaan nama dari nama di hasil dan nama yang anda berikan menggunakan Sistem Kesamaan Nama kami. Servis ini juga dapat memberikan indikasi apakah akun bank ini ber-tipe virtual atau tidak (contohnya seperti Akun Normal), dan memungkinkan anda untuk melakukan konfirmasi bahwa akun ini benar dimiliki oleh seorang individu tertentu. Hal ini dapat mengurangi kemungkinan terjadinya fraud pada bisnis anda.

Request Validasi Nama Bank

Parameter Deskripsi
bank_account_number string (dibutuhkan)
Nomor akun bank
bank_code string (dibutuhkan)
Kode bank dengan awalan negara (hanya Indonesia yang saat ini didukung). Lihat Kode Bank
given_name string (dibutuhkan)
Nama pertama yang akan digunakan untuk melakukan pencocokkan nama. Tolong jangan sertakan sebutan atau panggilan seperti bapak, saudara etc.
surname string (opsional)
Nama marga atau nama terakhir yang akan digunakan untuk melakukan pencocokkan nama
reference_id string (opsional)
Ini adalah ID pengenal bersifat unik yang dibuat oleh anda untuk permintaan (request) ini. Mengikutsertakan ini di dalam permintaan (request) anda dapat membantu anda dalam proses rekonsiliasi dengan sistem kami
upper_threshold number (opsional)
Integer, Nilai minimum adalah 0, Nilai maximum adalah 100. Meng-indikasi-kan ambang batas atas dari toleransi kecocokkan
lower_threshold number (opsional)
Integer, Nilai minimum adalah 0, Nilai maximum adalah 100. Meng-indikasi-kan ambang batas bawah dari toleransi kecocokkan

Respon Validasi Nama Bank

Contoh Respon Validasi Nama (Belum Pernah Tersimpan)

{
    "status": "PENDING",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_59e608887eb26d005d44aeb8",
    "reference_id": "foo123"
}

Contoh Respon Validasi Nama (Sudah Pernah Tersimpan - SUKSES dan COCOK)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false
    },
}

Contoh Respon Validasi Nama (Sudah Pernah Tersimpan - SUKSES dan TIDAK COCOK)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "NOT_MATCH",
        "is_virtual_account": false
    },
}

Contoh Respon Validasi Nama (Sudah Pernah Tersimpan - SUKSES dan COCOK dan memiliki attribute "need_review")

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false,
        "need_review": true
    },
}

Contoh Respon Validasi Nama (Sudah Pernah Tersimpan - SUKSES dan TIDAK JELAS)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "UNCLEAR",
        "is_virtual_account": false
    },
}

Contoh Respon Validasi Nama (Sudah Pernah Tersimpan - GAGAL)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": false
    },
}

Contoh Respon Validasi Nama (Terdapat kesalahan jaringan sementara pada sisi Iluma, pengguna tidak akan dikenakan biaya)

{
  "status": "FAILED",
  "bank_account_number": "1234567890",
  "bank_code": "ID_BCA",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id": "bknv_5c6ba591cf3c3867d75053d7",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "reference_id": "foo123"
}

Algoritma sistem kesamaan nama kami akan mendeteksi tingkat kemiripan antara nama yang kami dapatkan dari hasil dan nama yang anda berikan. Anda bisa melihat tiga kategori yang mungkin terdapat di respon, MATCH, UNCLEAR, atau NOT_MATCH.

Mohon diingat, jika anda meng-konfigurasi ambang batas atas dan bawah menjadi angka yang sama, anda hanya akan mendapat kategory MATCH atau NOT_MATCH

Bila suatu akun bank pernah kami simpan sebelumnya, anda akan mendapatkan respon instan dari request POST anda. Untuk akun bank yang belum pernah kami simpan sebelumnya, anda akan mendapat "status": "PENDING", dan anda akan mendapat callback ketika request anda selesai kami proses, karena proses pengecekan terhadap bank memerlukan waktu beberapa saat. Karena itu pastikan anda telah membuat dan meng-konfigurasi url callback untuk servis ini di akun anda. Anda bisa melihat bagian Callback untuk detil lebih lanjut.

Skema Validasi Nama

Parameter Description
bank_code string (dibutuhkan)
Kode bank dengan awalan negara (hanya Indonesia yang saat ini didukung). Lihat Kode Bank
bank_account_number string (dibutuhkan)
Nomor akun bank
status string (dibutuhkan)
PENDING Request validasi nama masih sedang di-proses
SUCCESS Nomor akun bank ada di daftar bank
FAILURE Nomor akun bank tidak ada di daftar bank
updated string (dibutuhkan)
Waktu peng-update-an terakhir dari request anda
id string (dibutuhkan)
Nomor referensi unik request anda
reference_id string (opsional)
Ini adalah ID pengenal bersifat unik yang hanya akan dikembalikan di dalam tanggapan (response) jika diberikan di dalam permintaan (request) yang anda buat
result object (opsional)
Hanya ada untuk request dengan status COMPLETED

Skema Objek Result

Parameter Description
is_found boolean (required)
Ditemukan atau tidak
name_matching_result string (opsional)
Hanya ada jika status adalah COMPLETED
MATCH Tingkat kesamaan diatas batas atas
NOT_MATCH Tingkat kesamaan dibawah batas bawah
UNCLEAR Tingkat kesamaan diantara batas atas dan bawah
is_virtual_account boolean (opsional)
Hanya ada jika status adalah COMPLETED dengan is_found adalah true
true mengindikasikan virtual akun (default), false mengindikasikan sebaliknya.
Berikut adalah bank utama yang dapat kami lakukan: BNI, BCA, MANDIRI, BRI, CIMB, PERMATA, Maybank, NOBU Bank, Sinarmas, BTPN, BTN, Danamon, BJB, Bank Artha Graha, HSBC Indonesia. Bank lain akan kami kembalikan dengan nilai false sebagai default
need_review boolean (opsional)
Hanya ada jika status adalah COMPLETED dengan is_found adalah true
true need_review		 string (optional)
Only exist if status is COMPLETED with is_found is true
true mengindikasikan bahwa akun ini ditemukan dalam blacklist kami atau terindikasi fraud. Harap jadikan ini sebagai warning untuk melakukan tindakan tambahan jika diperlukan.Fitur ini masih dalam tahap beta harap hubungi akun manajer kami atau tim CS kami atau ajukan langsung melalui help@iluma.ai

Error Validasi Nama

Kode Error Deskripsi
UNSUPPORTED_BANK_CODE_ERROR
400		 Bank tujuan ini tidak di-support oleh kami, request anda mungkin menggunakan kode bank yang salah.
BANK_ACCOUNT_NUMBER_VALIDATION_ERROR
400		 Nomor rekening bank tujuan tidak valid.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Mendapatkan Validasi Nama menggunakan ID

Endpoint: Mendapatkan status request data

GET https://api.iluma.ai/v2.2/identity/bank_account_data_requests/:id

Contoh Request Validasi Nama menggunakan ID

curl https://api.iluma.ai/v2.2/identity/bank_account_data_requests/bknv_59e608887eb26d005d44aeb8 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan Validasi Nama. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Request Mendapatkan Validasi Nama menggunakan ID

Parameter Deskripsi
id string (dibutuhkan)
ID dari request pembuatan Validasi Nama. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan Validasi Nama.

Contoh Respon Validasi Nama Menggunakan ID (Belum Pernah Tersimpan)

{
    "status": "PENDING",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_59e608887eb26d005d44aeb8",
    "reference_id": "foo123"
}

Contoh Respon Validasi Nama Menggunakan ID (Sudah Pernah Tersimpan - SUKSES dan COCOK)


{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false
    },
}

Contoh Respon Validasi Nama (Sudah Pernah Tersimpan - SUKSES dan COCOK dan memiliki attribute "need_review")

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "name_matching_result": "MATCH",
        "is_virtual_account": false,
        "need_review": true
    },
}

Contoh Respon Validasi Nama Menggunakan ID (Sudah Pernah Tersimpan - GAGAL)

{
    "status": "FAILED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "updated": "2019-02-19T06:50:25.619Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "failure_reason": "TEMPORARY_NETWORK_ERROR",
}

Contoh Respon Validasi Nama (Terdapat kesalahan jaringan sementara pada sisi Iluma, pengguna tidak akan dikenakan biaya)

{
  "status": "FAILED",
  "bank_account_number": "1234567890",
  "bank_code": "ID_BCA",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id": "bknv_5c6ba591cf3c3867d75053d7",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "reference_id": "foo123"
}

Skema Validasi Nama

Harap lihat di seksi ini.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Detail Validator Nama Rekening Bank

Endpoint: Validasi nama pada rekening bank

POST https://api.iluma.ai/v1.2/identity/bank_account_validation_details

Contoh Permintaan Validator Nama Bank

curl https://api.iluma.ai/v1.2/identity/bank_account_validation_details \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "reference_id": "foo123"
    }'

Bank Name Validator dapat digunakan untuk mencari nama pemegang rekening rekening bank di Indonesia dan Vietnam. Ini juga memberikan indikasi apakah akun tersebut adalah akun bank virtual atau bukan (mis. Rekening Normal), memungkinkan Anda mengonfirmasi bahwa akun tersebut benar-benar dimiliki oleh individu dan meminimalkan kemungkinan penipuan.

Bank Name Validator Request

Parameter Description
bank_account_number string (wajib)
Nomor rekening bank
bank_code string (wajib)
Kode bank dengan awalan negara. Lihat Dapatkan Kode Bank yang Tersedia v1.2
reference_id string (opsional)
ID Anda untuk permintaan ini. Memberikan ini dapat membantu Anda merekonsiliasi permintaan yang Anda buat ke sistem kami

Respon Validator Nama Bank

Contoh Respons Validator Nama Bank (Tanggapan bank tertunda)

{
    "status": "PENDING",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_59e608887eb26d005d44aeb8",
    "reference_id": "foo123"
}

Contoh Respons Validator Nama Bank (Rekening ditemukan)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "account_holder_name": "FIRA DIYANKA",
        "is_virtual_account": false
    },
}

Contoh Respons Validator Nama Bank (Rekening ditemukan) dengan atribut need_review

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "account_holder_name": "FIRA DIYANKA",
        "is_virtual_account": false,
        "need_review": true,
    },
}

Contoh Respons Validator Nama Bank (Rekening tidak ditemukan)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": false
    },
}

Contoh Respons Validator Nama Bank (Kesalahan jaringan sementara di sisi Iluma, pengguna tidak akan dikenakan biaya)

{
  "status": "FAILED",
  "bank_account_number": "1234567890",
  "bank_code": "ID_BCA",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id": "bknv_5c6ba591cf3c3867d75053d7",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "reference_id": "foo123"
}

Karena mungkin perlu beberapa detik untuk memvalidasi nama rekening bank dengan sumber kami, semua hasil dikembalikan kepada Anda melalui panggilan balik. Pastikan URL panggilan balik dikonfigurasi untuk data rekening bank di akun Anda (Setel dengan jenis: BANK_NAME_VALIDATOR_DETAILS). Lihat bagian Callback untuk detail lebih lanjut.

Jika nomor akun tidak ditanyakan baru-baru ini, respons HTTP sinkron akan memiliki "status": "PENDING". Untuk kasus di mana kami baru saja menanyakan akun, respons HTTP sinkron akan berisi data respons yang sama dengan callback.

Bank Name Validator Schema

Parameter Description
bank_code string (wajib)
Kode bank dengan awalan negara. Lihat Dapatkan Kode Bank yang Tersedia v1.2
bank_account_number string (wajib)
Nomor rekening bank
status string (wajib)
PENDING Permintaan validasi nama masih diproses
COMPLETED Permintaan validasi nama berhasil diproses
FAILED Permintaan validasi nama telah gagal diproses
result object (opsional)
Hanya ada jika status COMPLETED
failure_reason string (opsional)
Alasan kegagalan permintaan
updated string (required)
Tanggal terakhir yang diperbarui dari permintaan validasi nama
id string (wajib)
ID permintaan validator nama unik
reference_id string (opsional)
ID Anda untuk permintaan ini. Akan hadir hanya jika dikirimkan dalam payload permintaan

Result object schema

Parameter Description
is_found boolean (wajib)
Menemukan akun atau tidak
akun_holder_name string (opsional)
Hanya ada jika status COMPLETED dengan is_found adalah true menunjukkan Nama Pemilik Akun
is_virtual_account string (opsional)
Hanya ada jika status COMPLETED dengan is_found adalah true
true menunjukkan akun virtual (default), false menunjukkan akun normal.
Ini memeriksa rekening di sebagian besar bank besar yang menerbitkan rekening virtual: BNI (ID), BCA (ID), MANDIRI (ID), BRI (ID), CIMB (ID), PERMATA (ID), Maybank (ID) , NOBU Bank (ID), Sinarmas (ID), BTPN (ID), BTN (ID), Danamon (ID), BJB (ID), Bank Artha Graha (ID), HSBC Indonesia (ID). Bank lain akan mengembalikan false secara default.
perlu_ulasan string (opsional)
Hanya ada jika status COMPLETED dengan is_found adalah true
true menunjukkan bahwa akun ditemukan dalam beberapa bentuk daftar hitam atau perilaku penipuan yang dilaporkan. harap perlakukan ini sebagai tanda peringatan dan lakukan uji tuntas tambahan jika perlu. Fitur ini masih dalam tahap beta dan dapat diaktifkan dengan mengajukan permintaan melalui manajer akun Anda, tim Sukses Pelanggan kami, atau menulis surat kepada kami di help@iluma.ai

Bank Name Validator Errors

Error Code Description
UNSUPPORTED_BANK_CODE_ERROR
400		 Bank tujuan tidak didukung, permintaan menggunakan kode bank yang salah.
BANK_ACCOUNT_NUMBER_VALIDATION_ERROR
400		 Nomor rekening bank tujuan tidak valid.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Detail Validator Nama Rekening Bank: Dapatkan dengan id

Endpoint: Dapatkan status permintaan data

GET https://api.iluma.ai/v1.2/identity/bank_account_validation_details/:id

Example Bank Name Validator: Get by id Request

curl https://api.iluma.ai/v1.2/identity/bank_account_validation_details/bknv_qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Anda dapat menanyakan status permintaan yang ada dengan membuat permintaan GET ke sumber daya menggunakan id yang dikembalikan kepada Anda saat membuat sumber daya permintaan. Anda akan menerima respons dengan format yang sama seperti yang ditampilkan dalam skema respons di atas.

Validator Nama Bank: Dapatkan dengan permintaan id

Parameter Description
id string (wajib)
Id dari permintaan untuk mengambil. Id ini harus cocok dengan id permintaan data rekening bank unik yang diberikan dalam tanggapan kami pada saat pembuatan sumber daya

Contoh Validator Nama Bank: Get by id Response (Tanggapan bank tertunda)

{
    "status": "PENDING",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_59e608887eb26d005d44aeb8",
    "reference_id": "foo123"
}

Contoh Respons Validator Nama Bank (Rekening ditemukan)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "account_holder_name": "FIRA DIYANKA",
        "is_virtual_account": false
    },
}

Contoh Respons Validator Nama Bank (Rekening ditemukan) dengan atribut need_review

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": true,
        "account_holder_name": "FIRA DIYANKA",
        "is_virtual_account": false,
        "need_review": true,
    },
}

Contoh Respons Validator Nama Bank (Rekening tidak ditemukan)

{
    "status": "COMPLETED",
    "bank_account_number": "1234567890",
    "bank_code": "ID_BCA",
    "created": "2017-07-03T10:51:44.484Z",
    "updated": "2017-07-03T10:51:44.484Z",
    "id": "bknv_5c6ba591cf3c3867d75053d7",
    "reference_id": "foo123",
    "result": {
        "is_found": false
    },
}

Contoh Respons Validator Nama Bank (Kesalahan jaringan sementara di sisi Iluma, pengguna tidak akan dikenakan biaya)

{
  "status": "FAILED",
  "bank_account_number": "1234567890",
  "bank_code": "ID_BCA",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id": "bknv_5c6ba591cf3c3867d75053d7",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "reference_id": "foo123"
}

Skema Validator Nama Bank

Please refer to this section.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Validasi Ewallet

Endpoint: Validasi informasi yang terdapat di dalam akun ewallet

POST https://api.iluma.ai/v0/identity/ewallet_account_data_requests

Contoh Request Validasi Akun Ewallet

curl https://api.iluma.ai/v0/identity/ewallet_account_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "ewallet_account_number": "08120000123",
        "ewallet_type": "GOPAY"
    }'

Servis Validasi Akun Ewallet dapat digunakan untuk mengecek informasi yang tertera di ewallet utama di Indonesia. Untuk sekarang kami dukung pengecekan ewallet GOPAY, OVO, dan LINKAJA. Kami akan menambah sumber yang lain. Validasi Akun Ewallet dapat membantu anda untuk konfirmasi destinasi akun dana sebelum membuat transfer ke wallet, dan pada kasus tertentu dapat membantu untuk verifikasi identitas pengguna.

Request Validasi Akun Ewallet

Parameter Deskripsi
ewallet_account_number string (dibutuhkan)
Nomor akun ewallet. Untuk ewallet yang menggunakan nomor telepon, kami memfasilitasi +62xxx, 08xxx dengan "-" atau " " pembagian
ewallet_type string (dibutuhkan)
nama ewallet yang ingin di cek. Untuk sekarang kami men-support antara ewallet DANA, GOPAY, LINKAJA, OVO, atau SHOPEEPAY

Respon Validasi Akun Ewallet

Contoh Respon Validasi Akun Ewallet (Respon Pending)

{
    "id": "9a48e1b2-da78-4561-8b02-f20fd89542d0",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08111",
    "result": {},
    "status": "PENDING",
    "is_found": null,
    "updated": "2017-07-03T10:51:44.484Z"
}

Contoh Respon Validasi Akun Ewallet (Akun Ditemukan)

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08222",
    "result": {
        "account_status": "ACTIVE",
        "ewallet_account_name": "FIRA DIYANKA"
    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Example Ewallet Account Validator Response (LINKAJA dan GOPAY - Akun ditemukan dan terverifikasi. Pengguna akun ini telah melakukan verifikasi KYC di aplikasi LINKAJA atau GOPAY)

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08223",
    "result": {
        "kyc_status": "VERIFIED",
        "account_status": "ACTIVE",
        "ewallet_account_name": "FIRA DIYANKA"

    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Example Ewallet Account Validator Response (LINKAJA dan GOPAY - Akun ditemukan dan belum terverifikasi. Pengguna akun ini belum melakukan verifikasi KYC di aplikasi LINKAJA atau GOPAY. Field ewallet_account_name akan berisi string kosong)

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08224",
    "result": {
        "kyc_status": "UNVERIFIED",
        "account_status": "ACTIVE",
        "ewallet_account_name": ""
    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Contoh Respon Validasi Akun Ewallet (Akun Tidak Ditemukan)

{
    "id": "cf366af5-9ea6-4d56-9f5a-8d7a9691ddf8",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08333",
    "result": {
        "account_status": null,
        "ewallet_account_name": null
    },
    "status": "COMPLETED",
    "is_found": false,
    "updated": "2020-01-03 08:23:16.521060+00:00"
}

Dikarenakan akan memerlukan beberapa detik untuk validasi akun ewallet dengan sumber kita, semua hasil yang dikembalikan ke anda akan melewati callback. Struktur callback akan sama dengan skema respon di bawah. Mohon di pastikan callback URL anda telah di konfigurasi untuk data akun ewallet di akun anda (anda dapat mengset dengan type: EWALLET_ACCOUNT_VALIDATION). Anda bisa melihat bagian Callback untuk detil lebih lanjut.

Apabila nomor akun tersebut belum pernah di request, respons HTTP sinkron akan memiliki "status": "PENDING". Apabila untuk akun yang telah pernah di request, HTTP sinkron akan memuat informasi yang sama dengan callback.

Skema Validasi Akun Ewallet

Parameter Deskripsi
id string (dibutuhkan)
ID unik validasi akun ewallet yang anda request
ewallet_type string (dibutuhkan)
Tipe ewallet. Hanya boleh mengisi antara DANA, GOPAY, LINKAJA, OVO, atau SHOPEEPAY
ewallet_account_number string (dibutuhkan)
Nomor akun ewallet
result object (dibutuhkan)
objek JSON yang memuat semua informasi yang bisa kami dapatkan tentang akun ini. Objek ini meliputi:
account_status
ACTIVE Akun eWallet ini untuk sekarang aktif
INACTIVE Akun ewallet ini sekarang tidak aktif
ewallet_account_name Nama yang terdapat di akun eWallet. Akan berisi string kosong bila akun belum terverifikasi
kyc_status
VERIFIED Akun eWallet ini sudah terverifikasi
UNVERIFIED Akun ewallet ini belum terverifikasi
status string (dibutuhkan)
PENDING Request anda sedang di-proses
WAITING_ON_SOURCE Request anda merupakan duplikat karena masih ada request anda sebelumnya yang sedang kami proses dan mempunyai statusPENDING
COMPLETED Request validasi ewallet anda telah selesai
is_found string (dibutuhkan)
Apakah akun nama di ewallet ditemukan atau tidak
updated string (dibutuhkan)
Waktu peng-update-an terakhir dari validasi akun ewallet anda di format UTC tanggal ISO

Error Validasi Akun Ewallet

Kode Error Deskripsi
UNSUPPORTED_EWALLET_TYPE_ERROR
400		 ewallet ini belum di support oleh kami. akun ewallet yang kami support dapat ditemukan di skema request diatas
INVALID_ACCOUNT_NUMBER_FORMAT
400		 format nomor akun ewallet ini tidak valid.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Mendapatkan Validasi Ewallet menggunakan ID

Endpoint: Mendapatkan status request data

GET https://api.iluma.ai/v0/identity/ewallet_account_data_requests/:id

Contoh Request Validasi Ewallet menggunakan ID

curl https://api.iluma.ai/v0/identity/ewallet_account_data_requests/
qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan Validasi Ewallet. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Request Mendapatkan Validasi Ewallet menggunakan ID

Parameter Deskripsi
id string (dibutuhkan)
ID dari request pembuatan Validasi Ewallet. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan Validasi Ewallet.

Contoh Respon Validasi Ewallet Menggunakan ID

{
    "id": "490a7d40-83af-4b25-8ead-da2e197be6f3",
    "ewallet_type": "MAGIC",
    "ewallet_account_number": "08222",
    "result": {
        "account_status": "ACTIVE",
        "ewallet_account_name": "FIRA DIYANKA"
    },
    "status": "COMPLETED",
    "is_found": true,
    "updated": "2020-01-03 08:21:27.110718+00:00"
}

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Validasi NPWP

Endpoint: Validasi NPWP

POST https://api.iluma.ai/v1/identity/npwp_data_requests

Contoh Request Validasi NPWP

curl https://api.iluma.ai/v1/identity/npwp_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{ "account_number": "123456789012345" }'

Servis Validasi NPWP dapat digunakan untuk mengecek nama dari seorang pemegang NPWP di Indonesia.

Supported country: 🇮🇩

Request Validasi NPWP

Parameter Deskripsi
scope string (opsional)
Lingkup permintaan validasi. Permintaan NPWP_VALIDATOR menggunakan nomor rekening dan permintaan NPWP_VALIDATOR_ADVANCE menggunakan nomor kartu identitas. Enum: NPWP_VALIDATOR, NPWP_VALIDATOR_ADVANCE. Nilai default: NPWP_VALIDATOR.
account_number string (opsional)
Nomor NPWP (panjang nomor harus 15 digit atau format harus 12.345.678.9-012.345). Wajib jika scope adalah NPWP_VALIDATOR.
id_card_number string (opsional)
Nomor KTP. Wajib jika scope adalah NPWP_VALIDATOR_ADVANCE.

Respon Validasi NPWP

Bila nomor NPWP yang anda request belum pernah tersimpan sebelumnya, respon akan memiliki "status": "PENDING", dan anda akan mendapatkan callback ketika request anda selesai kami proses. Karena itu pastikan anda telah membuat dan meng-konfigurasi url callback untuk servis ini (menetapkan itu dengan tipe: NPWP_DATA_REQUEST) di akun anda. Anda bisa melihat bagian Callback untuk detil lebih lanjut. Ketika sudah pernah tersimpan sebelumnya, kami akan mengembalikan respon secara instan.

Contoh Respon Validasi NPWP (Belum Pernah Disimpan)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "000000000000000",
  "status": "PENDING"
}

Contoh Callback Validasi NPWP (Akun ditemukan)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "999999999999999",
  "status": "COMPLETED",
  "is_found": true,
  "result":{
    "account_name": "FIRA DIYANKA"
  }
}

Contoh Callback Validasi NPWP (Akun tidak ditemukan)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "111111111111111",
  "status": "COMPLETED",
  "is_found": false,
  "result":{}
}

Contoh Callback Validasi NPWP (Gagal)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "444444444444444",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "is_found": false,
  "result":{}
}

Contoh Respon Validasi NPWP Menggunakan Nomor KTP (Belum Pernah Disimpan)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id_card_number": "999999999999999",
  "status": "PENDING"
}

Contoh Callback Validasi NPWP Menggunakan Nomor KTP (Akun ditemukan)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id_card_number": "999999999999999",
  "status": "COMPLETED",
  "is_found": true,
  "result":{
    "account_name": "FIRA DIYANKA"
  }
}

Contoh Callback Validasi NPWP Menggunakan Nomor KTP (Akun tidak ditemukan)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id_card_number": "999999999999999",
  "status": "COMPLETED",
  "is_found": false,
  "result":{}
}

Contoh Callback Validasi NPWP Menggunakan Nomor KTP (Gagal)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "id_card_number": "444444444444444",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR",
  "is_found": false,
  "result":{}
}

Skema Validasi NPWP

Parameter Deskripsi
id string (dibutuhkan)
Nomor referensi NPWP unik dari request anda.
created string (dibutuhkan)
Waktu pembuatan request anda.
updated string (dibutuhkan)
Waktu peng-update-an terakhir dari request anda.
account_number string (opsional)
Nomor NPWP.
id_card_number string (opsional)
Nomor KTP.
status string (dibutuhkan)
PENDING Request anda sedang di-proses
WAITING_ON_SOURCE Request anda merupakan duplikat karena masih ada request anda sebelumnya yang sedang kami proses dan mempunyai statusPENDING
COMPLETED Request validasi NPWP anda telah selesai
FAILED NPWP request gagal. Anda bisa melihat bagaian failure_reason untuk detil lebih.
failure_reason string (opsional)
Lihat Alasan Kegagalan Validasi NPWP.
is_found string (dibutuhkan)
Apakah akun nama di NPWP ditemukan atau tidak
result object (dibutuhkan)
Objek JSON yang memuat semua informasi yang bisa kami dapatkan tentang akun ini. Objek ini meliputi:
account_name
Nama yang terdapat di akun NPWP. Akan berisi string kosong bila informasi belum ditemukan.

NPWP Validator Failure Reasons

Failure Reason Description
TEMPORARY_NETWORK_ERROR Terdapat gangguan jaringan sementara pada sumber kami. Anda dapat mencoba kembali permintaan ini.
MULTIPLE_NPWP_ACCOUNT_ERROR Data WP by NIK, ditemukan pada lebih dari 1 WP, silakan gunakan vasilitas perubahan data mandiri pada aplikasi ereg, ataupun DJP Online.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Magic Replies

Harap lihat referensi berikut

Mendapatkan Validasi NPWP menggunakan ID

Endpoint: Mendapatkan status request data

GET https://api.iluma.ai/v1/identity/npwp_data_requests/:id

Contoh Request Validasi NPWP menggunakan ID

curl https://api.iluma.ai/v1/identity/npwp_data_requests/
qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan Validasi NPWP. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Request Mendapatkan Validasi NPWP menggunakan ID

Parameter Deskripsi
id string (dibutuhkan)
ID dari request pembuatan Validasi NPWP. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan Validasi NPWP.

Contoh Respon Validasi NPWP Menggunakan ID

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "created": "2017-07-03T10:51:44.484Z",
  "updated": "2017-07-03T10:51:44.484Z",
  "account_number": "999999999999999",
  "status": "COMPLETED",
  "is_found": true,
  "result":{
    "account_name": "FIRA DIYANKA"
  }
}

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Validasi Individu

Endpoint: Validasi Data Individu

POST https://api.iluma.ai/v2/identity/id_card_data_verifications

Contoh Request Validasi Data Individu

curl https://api.iluma.ai/v2/identity/id_card_data_verifications \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -F 'id_card_number="3275031210930027"' \
    -F 'name="penito kristian"' \
    -F 'birthdate="12-10-1991"' \

Endpoint Validasi data individu kami kembangkan untuk membantu Anda memeriksa apakah nomor KTP atau NIK yang diberikan teradapat dalam catatan resmi pemerintah Indonesia, dan kecocokan nama serta tanggal lahir dengan catatan resmi.

Supported country: 🇮🇩

Rekues Validasi Data Individu

Content type: form-data

Parameter Description
name string (wajib)
Nama lengkap individu sesuai KTP
Min - 2 karakter, Maks - 100 karakter
id_card_number string (wajib)
NIK atau nomor KTP
birthdate string (wajib)
Tanggal lahir sesuai yang tertera di KTP
Format string DD-MM-YYYY
birthplace string (opsional)
Kota kelahiran sesuai KTP
name_threshold number (opsional)
Menentukan tingkat kemiripan nama untuk menghasilkan match. Default 90

Respons Validasi Data Individu

Contoh Respons Validasi Data Individu - Completed (Found)

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
  "created": "2022-06-29T08:18:43.529Z",
  "updated": "2022-06-29T08:18:43.529Z",
  "id_card_number": "3275031210930027",
  "name": "penito kristian",
  "name_threshold": 90,
  "birthdate": "12-10-1990",
  "birthplace": "Surabaya",
  "status": "COMPLETED",
  "id_card_number_found": true,
  "results": {
    "name": {
      "match": true
    },
    "birthdate": {
      "match": true
    },
    "birthplace": {
      "match": true
    }
  }
}

Contoh Respons Validasi Data Individu - Completed (Not Found)

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930021",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "Surabaya",
  "status": "COMPLETED",
  "id_card_number_found": false
}

Contoh Respons Validasi Data Individu - Failure

{
  "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d2",
  "created": "2022-03-21T12:24:42.480Z",
  "updated": "2022-03-21T12:24:42.480Z",
  "id_card_number": "3275031210930021",
  "name": "penito kristian",
  "birthdate": "12-10-1990",
  "birthplace": "Surabaya",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Anda akan menerima respons JSON dengan id referensi saat mengirimkan permintaan POST.

ID Data Verification Schema

Parameter Description
id string (wajib)
Pengidentifikasi unik dari permintaan
created string (wajib)
Tanggal penerimaan permintaan. Stempel waktu ISO8601 dalam UTC
updated string (wajib)
Tanggal permintaan yang terakhir diperbarui. Stempel waktu ISO8601 dalam UTC
id_card_number string (wajib)
Nomor KTP sesuai KTP
name string (wajib)
Nama lengkap individu sesuai KTP
birthdate string (wajib)
Tanggal lahir sesuai yang tertera di KTP
birthplace string (opsional)
Kota kelahiran sesuai KTP
id_card_number_found boolean (wajib)
Apakah rincian yang diberikan sudah diverifikasi di database Dukcapil
failure_reason string (opsional)
Alasan kegagalan. Nilai yang mungkin: TEMPORARY_NETWORK_ERROR dan lainnya

Result Object Schema

Parameter Description
name.match boolean (wajib)
Jika kemiripan nama sama dengan atau melebihi name_threshold, hasil akan menjadi true
birthdate.match boolean (opsional)
Jika tanggal lahir cocok, hasil akan menjadi true
birthplace.match boolean (opsional)
Jika tempat lahir cocok, hasil akan menjadi true

ID Data Verification Errors

Error Code Description
API_VALIDATION_ERROR
400		 Payload permintaan tidak sesuai dengan yang ditentukan. Bidang formulir yang hilang disediakan di payload respons.
INVALID_API_KEY
401		 Format kunci API tidak valid
API_KEY_IS_NOT_LIVE_ERROR
403		 Kunci API tidak memiliki izin untuk melakukan permintaan ini
RATE_LIMIT_EXCEEDED
429		 Melampaui Batas Nilai. Harap untuk melihat penjelasan lebih lanjut di halaman deskripsi error.
SERVER_ERROR
500		 Layanan sedang down atau error lainnya

Endpoint: API Flow

Flow API dijelaskan di halaman ini.

Validasi Foto Individu

Endpoint: Validasi Foto Individu

POST https://api.iluma.ai/v1/identity/id_card_verifications

Contoh Request Validasi Foto Individu

curl https://api.iluma.ai/v1/identity/id_card_verifications \
    -X POST \
    -u <your-api-key>: \
    -F 'name="penito kristian"' \
    -F 'id_card_number="3275031210930027"' \
    -F 'birthdate="12-10-1991"' \
    -F 'phone="081234567890"' \
    -F 'selfie=@"/path/to/selfie.png"'' \
    -F 'ktp_image=@"/path/to/ktp_image.png"''
    -F 'email="test@test.com"' \

Endpoint Validasi foto individu kami kembangkan untuk membantu Anda memeriksa apakah nomor KTP atau NIK yang diberikan teradapat dalam catatan resmi pemerintah Indonesia dan memeriksa apakah foto diri cocok dengan foto KTP.

Supported country: 🇮🇩

Versions

Anda sedang melihat API versi V1. Klik di sini untuk melihat versi lainnya.

Rekues Validasi Foto Individu

Parameter Description
name string (wajib)
Nama individu sesuai KTP
Min - 2 karakter, Maks - 100 karakter
id_card_number string (wajib)
Nomor KTP sesuai KTP
birthdate string (wajib)
Tanggal lahir sesuai yang tertera di KTP
Format string DD-MM-YYYY
selfie file (wajib)
Gambar selfie individu untuk dicocokkan dengan gambar yang dimiliki Dukcapil untuk NIK yang disediakan
Jenis pantomim yang didukung: image/jpeg, image/png. Ukuran file maksimum: 2 MB. Ukuran file minimum: 100KB, 500x500 piksel
phone string (opsional)
Nomor Telepon Terkait dengan nomor KTP. Format yang Didukung: (+62xxx, 08xxx)
ktp_image file (wajib)
Gambar KTP individu untuk dicocokkan dengan gambar yang dimiliki Dukcapil untuk NIK yang disediakan
Jenis pantomim yang didukung: image/jpeg, image/png. Ukuran file maksimum: 2 MB. Ukuran file minimum: 100KB, 500x500 piksel
email string (opsional)
Alamat email individu untuk memeriksa email yang terdaftar di Dukcapil

Respons Validasi Foto Individu

Contoh Respons Validasi Foto Individu - Completed (Verified)

{
    "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
    "created": "2022-03-21T12:24:42.480Z",
    "updated": "2022-03-21T12:24:42.480Z",
    "id_card_number": "3275031210930027",
    "name": "penito kristian",
    "birthdate": "12-10-1990",
    "phone": "081234567890",
    "email": "test@test.com",
    "status": "COMPLETED",
    "is_verified": true,
}

Contoh Respons Validasi Foto Individu - Completed (Unverified)

{
    "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
    "created": "2022-03-21T12:24:42.480Z",
    "updated": "2022-03-21T12:24:42.480Z",
    "id_card_number": "3275031210930027",
    "name": "penito kristian",
    "birthdate": "12-10-1990",
    "phone": "081234567890",
    "email": "test@test.com",
    "status": "COMPLETED",
    "is_verified": false,
    "failure_reason": "Selfie Not Match"
}

Contoh Respons Validasi Foto Individu - Failure

{
    "id": "idvr_c2b7a96a-9dc2-491e-b274-71c84b6e25d1",
    "created": "2022-03-21T12:24:42.480Z",
    "updated": "2022-03-21T12:24:42.480Z",
    "id_card_number": "3275031210930027",
    "name": "penito kristian",
    "birthdate": "12-10-1990",
    "phone": "081234567890",
    "email": "test@test.com",
    "status": "FAILED",
    "is_verified": false,
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Anda akan menerima respons JSON dengan id referensi saat mengirimkan permintaan POST.

Skema Verifikasi Kartu Identitas Biometrik

Parameter Deskripsi
id string (wajib)
Pengidentifikasi unik dari permintaan
created string (wajib)
Tanggal penerimaan permintaan. Stempel waktu ISO8601 dalam UTC
updated string (wajib)
Tanggal permintaan yang terakhir diperbarui. Stempel waktu ISO8601 dalam UTC
id_card_number string (wajib)
Nomor KTP sesuai KTP
name string (wajib)
Nama individu sesuai KTP
birthdate string (wajib)
Tanggal lahir sesuai yang tertera di KTP
email string (opsional)
Alamat email individu
phone string (opsional)
Nomor Telepon individu. Format yang Didukung: (+62xxx, 08xxx)
is_verified boolean (wajib)
Apakah rincian yang diberikan sudah diverifikasi di database Dukcapil
failure_reason string (opsional)
Alasan kegagalan. Nilai yang mungkin: TEMPORARY_NETWORK_ERROR dan lainnya

Endpoint: API Flow

Alur API untuk endpoint ini tersedia di sini.

Magic Replies

Harap lihat referensi berikut

Id card verifications Errors

Kode Kesalahan Keterangan
API_VALIDATION_ERROR
400		 Payload permintaan tidak sesuai dengan yang ditentukan. Bidang formulir yang hilang disediakan di payload respons.
INVALID_API_KEY
401		 Format kunci API tidak valid
API_KEY_IS_NOT_LIVE_ERROR
403		 Kunci API tidak memiliki izin untuk melakukan permintaan ini
FILE_TOO_LARGE
413		 Gambar selfie terlalu besar
FILE_TOO_SMALL
413		 Gambar selfie terlalu kecil
UNSUPPORTED_CONTENT_TYPE
415		 Gambar selfie memiliki jenis file yang salah
RATE_LIMIT_EXCEEDED
429		 Melampaui Batas Nilai. Harap untuk melihat penjelasan lebih lanjut di halaman deskripsi error.
SERVER_ERROR
500		 Layanan sedang down atau error lainnya

List Alasan kegagalan

failure_reason Description
NIK is Invalid NIK tidak valid
Selfie is Invalid Selfie tidak valid
NIK not found NIK tidak ditemukan
Full Name Not Match Nama lengkap tidak sama
DOB Not Match Tanggal lahir tidak sama
Selfie Not Match, Score More Than 30, Less Than 70 Selfie tidak sama
Selfie Not Match, Score More Than 0, Below 30 Selfie tidak sama
Full Name Not Match & DOB Not Match Kedua parameter tidak sama
Full Name Not Match & Selfie Not Match Kedua parameter tidak sama
DOB Not Match & Selfie Not Match Kedua parameter tidak sama
Full Name Not Match & DOB Not Match & Selfie Not Match Semua parameter tidak sama
TEMPORARY_NETWORK_ERROR Jaringan sedang dalam masalah untuk sementara waktu

Panduan

Untuk mengurangi error yang diakibatkan verifikasi gambar, disarankan untuk memandu pengguna untuk mengambil foto selfie dan KTP mereka dengan peraturan berikut:

Gambar diatas paling disarankan.

Gambar ini masih bisa diterima jika ukuran gambar KTP masih lebih besar dari latar belakang.

OCR Kartu Identitas

Endpoint: Membaca detail kartu identitas dengan OCR

POST https://api.iluma.ai/v1/identity/id_card_images

Contoh Request OCR Kartu Identitas

curl https://api.iluma.ai/v1/identity/id_card_images \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -F 'type="indonesia_ktp"' \
    -F 'image=@"/path/to/file.png"'
    -F 'reference_id="foo123"'

Endpoint OCR Kartu ID hadir untuk membantu Anda mengambil teks dan gambar dari foto Kartu Tanda Pengenal Pemerintah Indonesia yang resmi. Kami merekomendasikan untuk mengunakan foto-foto dengan orientasi landscape yang standar, tepat menghadap ke kamera dan terfokus jelas untuk efektivitas yang maksimal. Kami akan membersihkan dan memproses gambar apapun yang Anda sediakan namun metode terbaik untuk memastikan akurasi hasil OCR adalah apabila Anda dapat mengatur kualitas pengambilan gambar mentah tersebut.

Supported country: 🇮🇩

Request OCR Kartu Identitas

Content type: multi-part/form

Parameter Deskripsi
type string (dibutuhkan)
Tipe ID yang sedang di-kueri. Saat ini kita men-support passport, indonesia_ktpdannpwp_card` (NPWP).
image file (dibutuhkan)
Foto kartu identitas ini mime type image/png, image/bmp, image/jpeg. Maksimum ukuran 2MB.
reference_id string (opsional)
Ini adalah ID pengenal bersifat unik yang hanya akan dikembalikan di dalam tanggapan (response) jika diberikan di dalam permintaan (request) yang anda buat

Respon OCR Kartu Identitas

Contoh Respon OCR Kartu Identitas - Sedang Diproses

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "PENDING",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Contoh Respon OCR Kartu Identitas - Sukses

Contoh NIK

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
    "idNumber": "1234567890123456",
    "name": "FIRA DIYANKA",
    "religion": "KRISTEN",
    "gender": "LAKI-LAKI",
    "birthPlaceBirthday": "JAKARTA,17-10-1975",
    "province": "JAWA TENGAH",
    "city": "KABUPATEN JEPARA",
    "district": "KELING",
    "village": "KELET",
    "rtrw": "015/004",
    "address":"JL. VETERAN GG. GARUDA NO.73D/34",
    "occupation": "KARYAWAN SWASTA",
    "expiryDate": "12-08-2016",
    "nationality": "WNI",
    "maritalStatus":"BELUM KAWIN"
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Contoh NPWP

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "npwpId": "123456789123000",
        "address": null,
        "idNumber": null,
        "npwpName": "FIRA DIYANKA",
        "registrationOffice": null
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "npwp_card",
  "reference_id":"foo123"
}

Contoh Passport

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "gender": "Female",
        "country": "UNITED STATES OF AMERICA",
        "surname": "TRAVELER",
        "given_name": "HAPPY",
        "is_tampered": true,
        "date_of_birth": "1965-02-05T00:00:00.000Z",
        "date_of_issue": "2020-10-15T00:00:00.000Z",
        "date_of_expiry": "2030-10-14T00:00:00.000Z",
        "place_of_birth": "WASHINGTON, D.C.,U.S.A.",
        "passport_number": "E00007734",
        "issuing_authority": ""
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "passport",
  "reference_id":"foo123"
}

Contoh Respon OCR Kartu Identitas - Sukses dengan Tak Data

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Contoh Respon OCR Kartu Identitas - Gagal

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "status": "FAILED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "failure_reason": "IMAGE_RECOGNIZE_ERROR",
  "reference_id":"foo123"
}

Anda akan menerima respon JSON dengan id referensi pada saat mengirimkan POST request. Karena butuh waktu beberapa detik untuk menunggah dan memproses file gambar, semua hasil akan dikembalikan kepada Anda dalam bentuk callback. Pastikan Anda telah mengkonfigurasi callback URL untuk OCR kartu ID pada akun Anda (Atur dengan mengetik: 'ID_IMAGE_OCR_REQUEST'). Silakan mengacu pada bagian Callback untuk detail lebih lanjut.

Skema OCR Kartu Identitas

Parameter Deskripsi
id string (dibutuhkan)
Nomor identifikasi yang unik dari request anda untuk digunakan di panggilan API nantinya.
data json (opsional)
Isi teks yang telah dibaca dari kartu identitas anda.
status string (dibutuhkan)
Status dari proses OCR
created string (dibutuhkan)
UTC Timestamp pembuatan OCR request dalam format ISO 8601
updated string (dibutuhkan)
UTC Timestamp perubahan OCR request terakhir dalam format ISO 8601
type string (dibutuhkan)
Tipe ID yang sedang di-kueri.
failure_reason string (opsional)
Alasan kegagalan request anda.

Errors OCR Kartu Identitas

Kode Error Deskripsi
API_VALIDATION_ERROR
400		 Validasi input gagal. Field errors dalam response akan merincikan fields yang melanggar validasi.
FILE_TOO_LARGE
413		 Ukuran file lebih besar dari 2.000.000 byte dan melebihi batas ukuran. Kecilkan payload sebelum mencoba kembali.
UNSUPPORTED_CONTENT_TYPE
415		 Format file tidak didukung. Lihat kembali tipe file sebelum mencoba lagi.
Hanya PNG, JPG, BMP yang didukung.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Mendapatkan OCR Kartu Identitas menggunakan ID

Endpoint: Mendapatkan status request data 

GET https://api.iluma.ai/v1/identity/id_card_images/:id

Contoh Request OCR Kartu Identitas menggunakan ID

curl https://api.iluma.ai/v1/identity/id_card_images/qwertyuiop1234567890 
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan OCR Kartu Identitas. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Request Mendapatkan OCR Kartu Identitas menggunakan ID

Parameter Deskripsi
id string (dibutuhkan)
ID dari request pembuatan OCR Kartu Identitas. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan OCR Kartu Identitas.

Contoh Respon OCR Kartu Identitas menggunakan ID - Sedang Diproses

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "PENDING",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Contoh Respon OCR Kartu Identitas menggunakan ID Referensi - Sukses
Contoh NIK

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
    "idNumber": "1234567890123456",
    "name": "FIRA DIYANKA",
    "religion": "KRISTEN",
    "gender": "LAKI-LAKI",
    "birthPlaceBirthday": "JAKARTA,17-10-1975",
    "province": "JAWA TENGAH",
    "city": "KABUPATEN JEPARA",
    "district": "KELING",
    "village": "KELET",
    "rtrw": "015/004",
    "address":"JL. VETERAN GG. GARUDA NO.73D/34",
    "occupation": "KARYAWAN SWASTA",
    "expiryDate": "12-08-2016",
    "nationality": "WNI",
    "maritalStatus":"BELUM KAWIN"
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Contoh NPWP

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "npwpId": "123456789123000",
        "address": null,
        "idNumber": null,
        "npwpName": "FIRA DIYANKA",
        "registrationOffice": null
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "npwp_card",
  "reference_id":"foo123"
}

Contoh Passport

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {
        "gender": "Female",
        "country": "UNITED STATES OF AMERICA",
        "surname": "TRAVELER",
        "given_name": "HAPPY",
        "is_tampered": true,
        "date_of_birth": "1965-02-05T00:00:00.000Z",
        "date_of_issue": "2020-10-15T00:00:00.000Z",
        "date_of_expiry": "2030-10-14T00:00:00.000Z",
        "place_of_birth": "WASHINGTON, D.C.,U.S.A.",
        "passport_number": "E00007734",
        "issuing_authority": ""
  },
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "passport",
  "reference_id":"foo123"
}

Contoh Respon OCR Kartu Identitas menggunakan ID - Sukses dengan Tak Data

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "data": {},
  "status": "COMPLETED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "reference_id":"foo123"
}

Contoh Respon OCR Kartu Identitas menggunakan ID - Gagal

{
  "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
  "status": "FAILED",
  "created": "2021-02-19T06:50:25.619Z",
  "updated": "2021-02-19T06:50:25.619Z",
  "type": "indonesia_ktp",
  "failure_reason": "IMAGE_RECOGNIZE_ERROR",
  "reference_id":"foo123"
}

Mendapatkan OCR Kartu Identitas menggunakan ID Referensi

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/id_card_images?reference_id=:reference_id&limit=:limit&after_id=:after_id

Example ID Card OCR: Get by Reference id Request

curl https://api.iluma.ai/v1/identity/id_card_images?reference_id=foo123
    -X GET \
    -u iluma_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID Referensi yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan OCR Kartu Identitas. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Request Mendapatkan OCR Kartu Identitas menggunakan ID Referensi

Parameter Deskripsi
reference_id string (dibutuhkan)
ID Referensi dari request pembuatan Validasi KTP terhadap Nomor Telepon. ID Referensi adalah ID Referensi yand diinput oleh user
limit integer (opsional)
Jumlah request yang akan diambil dari database. Nilai default adalah 10 catatan.
after_id string (opsional)
Field ini diberikan berdasarkan response ketika ada kelebihan record yang tersisa berdasarkan batas yang ditentukan. Ini untuk memungkinkan pengambilan kumpulan catatan berikutnya pada ID Referensi yang sama

Kartu Identitas OCR Dapatkan dengan Skema Id Referensi

Contoh Respon OCR Kartu Identitas menggunakan ID Referensi - Sukses 

{
  "data":[{
    "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
    "data": {
      "idNumber": "1234567890123456",
      "name": "FIRA DIYANKA",
      "religion": "KRISTEN",
      "gender": "LAKI-LAKI",
      "birthPlaceBirthday": "JAKARTA,17-10-1975",
      "province": "JAWA TENGAH",
      "city": "KABUPATEN JEPARA",
      "district": "KELING",
      "village": "KELET",
      "rtrw": "015/004",
      "address":"JL. VETERAN GG. GARUDA NO.73D/34",
      "occupation": "KARYAWAN SWASTA",
      "expiryDate": "12-08-2016",
      "nationality": "WNI",
      "maritalStatus":"BELUM KAWIN"
    },
    "status": "COMPLETED",
    "created": "2021-02-19T06:50:25.619Z",
    "updated": "2021-02-19T06:50:25.619Z",
    "type": "indonesia_ktp",
    "reference_id":"foo123"
  }],
  "has_more": false,
  "links": [
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123",
          "rel": "first",
          "method": "GET"
      },
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123",
          "rel": "self",
          "method": "GET"
      }
  ]
}

Contoh Respon OCR Kartu Identitas menggunakan ID Referensi - Sukses dengan limit dan after_id di dalam objek response 

{
  "data":[{
    "id": "f95ae802-4d96-4066-ada7-fe9487d4ca5e",
    "data": {
      "idNumber": "1234567890123456",
      "name": "FIRA DIYANKA",
      "religion": "KRISTEN",
      "gender": "LAKI-LAKI",
      "birthPlaceBirthday": "JAKARTA,17-10-1975",
      "province": "JAWA TENGAH",
      "city": "KABUPATEN JEPARA",
      "district": "KELING",
      "village": "KELET",
      "rtrw": "015/004",
      "address":"JL. VETERAN GG. GARUDA NO.73D/34",
      "occupation": "KARYAWAN SWASTA",
      "expiryDate": "12-08-2016",
      "nationality": "WNI",
      "maritalStatus":"BELUM KAWIN"
    },
    "status": "COMPLETED",
    "created": "2021-02-19T06:50:25.619Z",
    "updated": "2021-02-19T06:50:25.619Z",
    "type": "indonesia_ktp",
    "reference_id":"foo123"
  }],
  "has_more": true,
  "links": [
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123",
          "rel": "first",
          "method": "GET"
      },
      {
          "href": "/v1/identity/id_card_images?reference_id=foo123&limit=1",
          "rel": "self",
          "method": "GET"
      },
      {
            "rel": "next",
            "href": "/v1/identity/id_card_images?reference_id=foo123&limit=1&after_id=764d6583-6866-490d-b6c3-98f3de797d1b",
            "method": "GET"
      }
  ]
}

Contoh Respon OCR Kartu Identitas menggunakan ID Referensi - Id referensi tidak ditemukan

{
  "data":[],
  "has_more":false,
  "links": [
        {
            "href": "/v1/identity/id_card_images?reference_id=foo456",
            "rel": "first",
            "method": "GET"
        },
        {
            "href": "/v1/identity/id_card_images?reference_id=foo456",
            "rel": "self",
            "method": "GET"
        }
    ]
}
Parameter Description
data array (required)
Array dari OCR Kartu Identitas Objects yang dikembalikan oleh query. Array bisa kosong
has_more boolean (required)
Mengidentifikasi apakah ada item lainnya yang dapat di-query dengan after_id dari item terakhir pada hasil sekarang
links array (required)
Array link yang digunakan untuk memproses request. Mungkin termasuk link untuk kumpulan catatan berikutnya apabila has_more diatur menjadi tru

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Perbandingan Wajah

Endpoint: Membandingkan kemiripan dari dua wajah

POST https://api.iluma.ai/v2/identity/face_comparisons

Contoh Request Perbandingan Wajah

curl https://api.iluma.ai/v2/identity/face_comparisons \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    --form 'image_one=@"image_one.jpg"' \
    --form 'image_two=@"image_two.jpg"'

Servis Perbandingan Wajah dapat membantu anda untuk mealkukan validasi terhadap dua photo dari orang yang sama seperti foto wajah mereka dan foto yang berasal dari kartu identitas mereka. Kami akan memindai dan membaca foto dalam kartu identitas, lalu membandingkannya dengan foto kedua. Kami sengaja membagi menjadi dua gambar karena kami tidak menyarankan untuk melakukan pengecekan hanya dengan satu foto seperti foto seroang user yang memegang kartu identitas mereka misalnya. Ini dikarenakan di tipe foto seperti ini, gambar kartu identitas akan menjadi sangat kecil dan berkualitas kurang baik (karena kurang fokus). Hal ini dapat mengurangi akurasi proses perbandingan wajah kami.

Mohon diingat bahwa anda harus menggunakan API key production yang live. API key development akan mengembalikan error INVALID_API_KEY.

Request Perbandingan Wajah

Parameter Deskripsi
image_one file (required)
Gambar Individual untuk digunakan dalam face comparison.
Max Size 2MB.
image_two file (required)
Gambar Individual untuk digunakan dalam face comparison.
Max Size 2MB.

Respon Perbandingan Wajah

Contoh Respon Perbandingan Wajah - Sukses

{
  "status": "COMPLETED",
  "match_percentage": 94.6,
  "id": "5ba359137f94918d2b0cb8bb"
}

Contoh Respon Perbandingan Wajah - Gagal

{
  "status": "FAILED",
  "failure_reason": "IMAGE_INVALID_SIZE",
  "id": "5ba359137f94918d2b0cb8bb"
}

Anda akan mendapatkan respon JSON dengan nomor referensi request anda ketika anda mengirimkan request POST.

Skema Perbandingan Wajah

Parameter Deskripsi
status string (required)
Status dari proses Perbandingan Wajah.
match_percentage number (optional)
Tingkat persentase kemiripan wajah.
failure_reason string (optional)
Alasan kegagalan request.
id string (required)
Nomor referensi unik dari request anda.

Error Perbandingan Wajah

Error Code Deskripsi
API_VALIDATION_ERROR
400		 Response ini mungkin dikarenakan hal berikut: input gambar tidak disupport dan dalam endpoint ini hanya support PNG, JPG/JPEG, BMP; jika lebih besar dari 2MB; dan jika required parameter dalam request ini kurang

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Face Liveness Check

Endpoint ini memungkinkan Anda mengirimkan selfie untuk melakukan pemeriksaan keaktifan wajah pasif.

Endpoint: Perform liveness checks

POST https://api.iluma.ai/v0/identity/liveness_checks

Contoh Permintaan - Lakukan pemeriksaan liveness

curl https://api.iluma.ai/v0/identity/liveness_checks \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -F 'reference_id="test_reference_id"' \
    -F 'image=@"/path/to/file.png"'
Parameter Description
reference_id string (opsional)
ID unik klien untuk permintaan ini
selfie file (wajib)
Gambar selfie individu. Jenis mime yang didukung: image/jpeg, image/png. Ukuran file maksimum: 500KB. Ukuran file minimum: 100KB, 400x400 piksel

Example Response

{
  "id": "lvck_00df1710-8b06-4cd1-a32c-8f2b39cad6fe",
  "created": "2022-03-25T05:56:14.193Z",
  "updated": "2022-03-25T05:56:20.827Z",
  "reference_id": "test",
  "status": "COMPLETED",
  "confidence": 99,
  "is_live": true,
  "result": {
    "are_eyes_open": true,
    "is_face_cropped": false,
    "face_mask_detected": false,
    "multiple_faces_detected": true
  }
}

Response Schema

Parameter Description
id string (wajib)
Pengidentifikasi unik dari permintaan dokumen untuk digunakan dalam panggilan API selanjutnya
reference_id string (wajib)
ID unik klien untuk permintaan ini. Akan mengembalikan nol jika TIDAK disediakan oleh klien di badan permintaan
created string (wajib)
Tanggal penerimaan permintaan OCR. Stempel waktu ISO8601 dalam UTC
updated string (wajib)
Tanggal permintaan OCR yang terakhir diperbarui. Stempel waktu ISO8601 dalam UTC
status string (wajib)
Nilai yang mungkin: COMPLETED - pemrosesan berhasil diselesaikan, FAILED - pemrosesan terputus dan/atau gagal pada tahap apa pun
failure_reason string (opsional)
Alasan kegagalan. Nilai yang mungkin: TEMPORARY_NETWORK_ERROR
is_live boolean (wajib)
Hasil pemeriksaan liveness. Hadir jika statusnya COMPLETED
confidence nomor (wajib)
Skor kepercayaan pada bendera is_live. Hadir jika statusnya COMPLETED
hasil objek (opsional)
Diberikan jika statusnya COMPLETED

Result Object Schema

Parameter Description
are_eyes_open boolean (wajib)
Parameter ini akan mendeteksi jika mata orang yang mengklik selfie terbuka.
is_face_cropped boolean (wajib)
Enum: benar atau salah. Apakah wajah terpotong dalam gambar.
face_mask_detected boolean (wajib)
Enum: benar atau salah. Apakah masker wajah terdeteksi pada gambar
multiple_faces_detected boolean (wajib)
Enum: benar atau salah. "benar" ketika banyak wajah menonjol ditemukan di selfie.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Dokumen Bisnis OCR

Endpoint: Membaca detail dokumen bisnis

POST https://api.iluma.ai/v1/identity/document_ocr_requests

Contoh Dokumen Bisnis OCR Request

curl --location --request POST 'localhost:8002/identity/v1/document_ocr_requests' \
    --form 'image=@"SK Menkeh .pdf"' \
    --form 'reference_id="foo123"' \
    --form 'type="BUSINESS_REGISTRATION"' \
    --form 'country="ID"' \
    --form 'document_name="SK_MENKEH"'

Endpoint OCR Dokumen Bisnis hadir untuk membantu Anda mengambil teks dan gambar dari foto atau file Dokumen Bisnis yang diterbitkan oleh bank secara resmi. Kami merekomendasikan untuk mengunakan foto-foto dengan orientasi landscape yang standar, tepat menghadap ke kamera dan terfokus jelas untuk efektivitas yang maksimal. Kami akan membersihkan dan memproses gambar apapun yang Anda sediakan namun metode terbaik untuk memastikan akurasi hasil OCR adalah apabila Anda dapat mengatur kualitas pengambilan gambar mentah tersebut.

Dokumen Bisnis OCR Request

Requests should be of type multi-part/form with the following content

Parameter Deskripsi
reference_id string (required)
ID referensi yang diinputkan oleh pengguna
type string (required)
Tipe dokumen bisnis yang ingin sistem kami ekstrak
Kami saat ini mensupport BUSINESS_REGISTRATION
image file (required)
File dokumen bisnis dengan mime type image/png, image/pdf, image/jpeg, image/jpg. Besar file maksimum adalah 500MB
country string (required)
Negara penerbit dokumen bisnis.
Kami saat ini mensupport ID
document_name string (required)
Nama dokumen dari dokumen bisnis yang anda ingin ekstrak.
Kami saat ini mensupport SK_MENKEH

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Dokumen Bisnis OCR Response

Contoh Respons Dokumen Bisnis OCR - Pending

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-2ec00c2e-04a6-4836-871e-68185df17915",
    "created": "2022-02-25T06:56:20.808Z",
    "updated": "2022-02-25T06:56:20.808Z",
    "status": "PENDING",
    "result": {}
}

Contoh Respons Dokumen Bisnis OCR - Completed
Dokumen Bisnis Contoh

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-32e6e523-6046-4db9-99ea-35a4f852ee86",
    "created": "2022-02-25T06:55:31.029Z",
    "updated": "2022-02-25T06:55:31.029Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": [
                    {
                        "value": "MATTHEW DAVID ROSA",
                        "confidence_level": 99.80309041341145
                    },
                    {
                        "value": "TIKA OSBOND SIRAIT",
                        "confidence_level": 99.58164469401042
                    },
                    {
                        "value": "SIVA SAJAN BHUPATHI RAJU",
                        "confidence_level": 99.03042030334473
                    }
                ]
            },
            {
                "name": "commisioner_names",
                "values": [
                    {
                        "value": "PANG SU KONG",
                        "confidence_level": 99.1666997273763
                    },
                    {
                        "value": "ANTHONY RICARD CATINELLA",
                        "confidence_level": 99.64801025390625
                    }
                ]
            },
            {
                "name": "shareholder_names",
                "values": [
                    {
                        "value": "METIS CONSULTANCY LIMITED",
                        "confidence_level": 99.80023193359375
                    },
                    {
                        "value": "WASPMOBILE SERVICES PRIVATE LIMITED",
                        "confidence_level": 99.5948486328125
                    }
                ]
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": "AHU-0049135.AH.01.01.TAHUN 2016",
                    "confidence_level": 79.09121704101562
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": "PT DIGITAL VISION PUBLISHING",
                    "confidence_level": 98.27043151855469
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "document_date",
                "values": {
                    "value": "03 November 2016",
                    "confidence_level": 99.49999237060547
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": "02",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": "BAHDER DJOHAN RAZAK,SH",
                    "confidence_level": 97.16451263427734
                }
            },
            {
                "name": "place_of_registration",
                "values": {
                    "value": "KOTA ADMINISTRASI JAKARTA SELATAN",
                    "confidence_level": 99.05745697021484
                }
            }
        ]
    }
}

Contoh Respons Dokumen Bisnis OCR - Completed dengan Dokumen Bisnis Data yang tidak dapat dibaca

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-98dd66b2-79e8-47f4-ae5a-3e7073a90f52",
    "created": "2022-02-25T06:55:56.085Z",
    "updated": "2022-02-25T06:55:56.085Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": []
            },
            {
                "name": "commisioner_names",
                "values": []
            },
            {
                "name": "shareholder_names",
                "values": []
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "establishment_place",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ]
    }
}

Contoh Respons Dokumen Bisnis OCR - FAILED

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

You will receive a JSON response with a reference id on submitting the POST request. Because it may take a few seconds to upload and process the image file, all results are returned to you in a callback. Be sure to have a callback URL configured for Dokumen Bisnis OCR in your account (Set it with type: BUSINESS_DOCUMENT_OCR_REQUEST). Please refer to Callback section for further details.

Dokumen Bisnis OCR Schema

Parameter Deskripsi
id string (required)
Nomor Identifikasi unik yang akan anda gunakan untuk memanggil API kami
reference_id string (optional)
ID referensi yang diinputkan oleh pengguna
type string (required)
Tipe dokumen bisnis yang ingin sistem kami ekstrak
Kami saat ini mensupport BUSINESS_REGISTRATION
image file (required)
File dokumen bisnis dengan mime type image/png, image/pdf, image/jpeg, image/jpg. Besar file maksimum adalah 500MB
country string (required)
Negara penerbit dokumen bisnis.
Kami saat ini mensupport ID
document_name string (required)
Nama dokumen dari dokumen bisnis yang anda ingin ekstrak.
Kami saat ini mensupport SK_MENKEH
failure_reason string (optional)
Alasan kegagalan
result json (required)
Konten dari dokumen bisnis yang kami ekstrak
status string (required)
Status dari request yang anda kirimkan
created string (required)
Tanggal terbuat. ISO8601 timestamp
updated string (required)
Tanggal terupdate. ISO8601 timestamp

Result OCR Schema

Parameter Deskripsi
pages integer (required)
Jumlah Halaman dari Dokumen Bisnis yang kami ekstrak
data array (required)
Data dokumen bisnis yang kami ekstrak

Dokumen Bisnis OCR Errors

Kode Error Deskripsi
API_VALIDATION_ERROR
400		 Validasi input gagal. Field errors dalam response akan merincikan fields yang melanggar validasi.
FILE_TOO_LARGE
413		 Ukuran file lebih besar dari 500 Megabyte dan melebihi batas ukuran. Kecilkan payload sebelum mencoba kembali.
UNSUPPORTED_CONTENT_TYPE
415		 Format file tidak didukung. Lihat kembali tipe file sebelum mencoba lagi.
Hanya PNG, JPG, JPEG, PDF yang didukung.

Dokumen Bisnis OCR: Get by id

Endpoint: Mendapatkan Data

GET https://api.iluma.ai/v1/identity/document_ocr_requests/:id

Contoh Dokumen Bisnis OCR: Get by id Request

curl https://api.iluma.ai/v1/identity/document_ocr_requests/qwertyuiop1234567890 
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan OCR Dokumen Bisnis. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Dokumen Bisnis OCR: Get by id Request

Parameter Deskripsi
id string (required)
ID dari request pembuatan OCR Dokumen Bisnis. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan OCR Dokumen Bisnis.

Contoh Respons Dokumen Bisnis OCR - Pending

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-2ec00c2e-04a6-4836-871e-68185df17915",
    "created": "2022-02-25T06:56:20.808Z",
    "updated": "2022-02-25T06:56:20.808Z",
    "status": "PENDING",
    "result": {}
}

Contoh Respons Dokumen Bisnis OCR - Completed
Dokumen Bisnis Contoh

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-32e6e523-6046-4db9-99ea-35a4f852ee86",
    "created": "2022-02-25T06:55:31.029Z",
    "updated": "2022-02-25T06:55:31.029Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": [
                    {
                        "value": "MATTHEW DAVID ROSA",
                        "confidence_level": 99.80309041341145
                    },
                    {
                        "value": "TIKA OSBOND SIRAIT",
                        "confidence_level": 99.58164469401042
                    },
                    {
                        "value": "SIVA SAJAN BHUPATHI RAJU",
                        "confidence_level": 99.03042030334473
                    }
                ]
            },
            {
                "name": "commisioner_names",
                "values": [
                    {
                        "value": "PANG SU KONG",
                        "confidence_level": 99.1666997273763
                    },
                    {
                        "value": "ANTHONY RICARD CATINELLA",
                        "confidence_level": 99.64801025390625
                    }
                ]
            },
            {
                "name": "shareholder_names",
                "values": [
                    {
                        "value": "METIS CONSULTANCY LIMITED",
                        "confidence_level": 99.80023193359375
                    },
                    {
                        "value": "WASPMOBILE SERVICES PRIVATE LIMITED",
                        "confidence_level": 99.5948486328125
                    }
                ]
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": "AHU-0049135.AH.01.01.TAHUN 2016",
                    "confidence_level": 79.09121704101562
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": "PT DIGITAL VISION PUBLISHING",
                    "confidence_level": 98.27043151855469
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "document_date",
                "values": {
                    "value": "03 November 2016",
                    "confidence_level": 99.49999237060547
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": "02",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": "BAHDER DJOHAN RAZAK,SH",
                    "confidence_level": 97.16451263427734
                }
            },
            {
                "name": "place_of_registration",
                "values": {
                    "value": "KOTA ADMINISTRASI JAKARTA SELATAN",
                    "confidence_level": 99.05745697021484
                }
            }
        ]
    }
}

Contoh Respons Dokumen Bisnis OCR - Completed with Unreadable Dokumen Bisnis Data

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-98dd66b2-79e8-47f4-ae5a-3e7073a90f52",
    "created": "2022-02-25T06:55:56.085Z",
    "updated": "2022-02-25T06:55:56.085Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": []
            },
            {
                "name": "commisioner_names",
                "values": []
            },
            {
                "name": "shareholder_names",
                "values": []
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "establishment_place",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ]
    }
}

Contoh Respons Dokumen Bisnis OCR - FAILED

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Dokumen Bisnis OCR: Get by Reference id

Endpoint: Get data request status

GET https://api.iluma.ai/v1/identity/document_ocr_requests?reference_id=:reference_id&after_id=:after_id&limit=:limit

Contoh Dokumen Bisnis OCR: Get by id Request

curl --location --request GET 'https://api.iluma.ai/v1/identity/document_ocr_requests?reference_id=foo123&after_id=ocr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20'

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID dan ID Referensi yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan OCR Dokumen Bisnis. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Dokumen Bisnis OCR: Get by Reference id Request

Parameter Deskripsi
id string (required)
ID dari request pembuatan OCR Dokumen Bisnis. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan OCR Dokumen Bisnis.
reference_id string (required)
Referensi ID dari request pembuatan OCR Dokumen Bisnis. Referensi ID adalah ID Referensi yand diinput oleh user.
limit integer (required)
Jumlah request yang akan diambil dari database.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Contoh Respons Dokumen Bisnis OCR - Pending

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-2ec00c2e-04a6-4836-871e-68185df17915",
    "created": "2022-02-25T06:56:20.808Z",
    "updated": "2022-02-25T06:56:20.808Z",
    "status": "PENDING",
    "result": {}
}

Contoh Respons Dokumen Bisnis OCR - Completed
Dokumen Bisnis Contoh

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-32e6e523-6046-4db9-99ea-35a4f852ee86",
    "created": "2022-02-25T06:55:31.029Z",
    "updated": "2022-02-25T06:55:31.029Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": [
                    {
                        "value": "MATTHEW DAVID ROSA",
                        "confidence_level": 99.80309041341145
                    },
                    {
                        "value": "TIKA OSBOND SIRAIT",
                        "confidence_level": 99.58164469401042
                    },
                    {
                        "value": "SIVA SAJAN BHUPATHI RAJU",
                        "confidence_level": 99.03042030334473
                    }
                ]
            },
            {
                "name": "commisioner_names",
                "values": [
                    {
                        "value": "PANG SU KONG",
                        "confidence_level": 99.1666997273763
                    },
                    {
                        "value": "ANTHONY RICARD CATINELLA",
                        "confidence_level": 99.64801025390625
                    }
                ]
            },
            {
                "name": "shareholder_names",
                "values": [
                    {
                        "value": "METIS CONSULTANCY LIMITED",
                        "confidence_level": 99.80023193359375
                    },
                    {
                        "value": "WASPMOBILE SERVICES PRIVATE LIMITED",
                        "confidence_level": 99.5948486328125
                    }
                ]
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": "AHU-0049135.AH.01.01.TAHUN 2016",
                    "confidence_level": 79.09121704101562
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": "PT DIGITAL VISION PUBLISHING",
                    "confidence_level": 98.27043151855469
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": "07 Oktober 2016",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "document_date",
                "values": {
                    "value": "03 November 2016",
                    "confidence_level": 99.49999237060547
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": "02",
                    "confidence_level": 99.31755828857422
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": "BAHDER DJOHAN RAZAK,SH",
                    "confidence_level": 97.16451263427734
                }
            },
            {
                "name": "place_of_registration",
                "values": {
                    "value": "KOTA ADMINISTRASI JAKARTA SELATAN",
                    "confidence_level": 99.05745697021484
                }
            }
        ]
    }
}

Contoh Respons Dokumen Bisnis OCR - Completed with Unreadable Dokumen Bisnis Data

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-98dd66b2-79e8-47f4-ae5a-3e7073a90f52",
    "created": "2022-02-25T06:55:56.085Z",
    "updated": "2022-02-25T06:55:56.085Z",
    "status": "COMPLETED",
    "result": {
        "pages": 1,
        "data": [
            {
                "name": "director_names",
                "values": []
            },
            {
                "name": "commisioner_names",
                "values": []
            },
            {
                "name": "shareholder_names",
                "values": []
            },
            {
                "name": "sk_menkeh_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "akta_number",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "legal_entity_name",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "date_of_registration",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "notary",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            },
            {
                "name": "establishment_place",
                "values": {
                    "value": null,
                    "confidence_level": 0
                }
            }
        ]
    }
}

Contoh Respons Dokumen Bisnis OCR - FAILED

{
    "reference_id": "foo123",
    "type": "BUSINESS_REGISTRATION",
    "country": "ID",
    "document_name": "SK_MENKEH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Dokumen OCR Capture

Endpoint: Mendapatkan capture link untuk Document OCR

POST https://api.iluma.ai/v1/identity/document_ocr_captures

Contoh Request Penangkapan Document OCR

curl https://api.iluma.ai/v1/identity/document_ocr_captures \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
       "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
        "country": "PH",
        "reference_id": "1234",
    }'

iServis ini memungkinkan Anda untuk me-request link GUI unik (hanya satu kali pakai) dimana Anda dapat upload dokumen KYC (kartu identitas, Selfie, dan Dokumen Pendaftaran Bisnis). Kami akan melakukan ekstraksi OCR pada dokumen-dokumen yang disediakan, liveness check untuk selfie, dan perbandingan wajah antara kartu identitas dan selfie, dan mengembalikan semua hasil ini dalam callback payload Anda.


Negara yang didukung: 🇵🇭


Workflow lengkap dapat dilihat dalam diagram, merinci titik-titik interaksi yang perlu Anda integrasikan, dan penjelasan lebih lanjut dari endpoint-endpoint yang disediakan.

Request Penangkapan Document OCR

Parameter Description
types array (required)
Tipe Dokumen OCR, Nilai yang dapat diinput adalah IDENTITY_CARD, BUSINESS_REGISTRATION, SELFIE
country string (optional)
Negara asal dokumen yang dapat diproses. Nilai yang dapat diinput adalah PH (default). Format ISO3166-2 country code
reference_id string (optional)
Unique ID referensi yang diinput untuk request ini

Respons Dokumen OCR Capture

Contoh Response Penangkapan dokumen OCR - PENDING

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "PENDING",
    "capture_link": "www.iluma.ai"
}

Contoh Response Penangkapan dokumen OCR - IN_PROGRESS

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "IN_PROGRESS",
    "capture_link": "www.iluma.ai"
}

Contoh Response Penangkapan dokumen OCR - COMPLETED_REVIEW_REQUIRED 

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "COMPLETED_REVIEW_REQUIRED",
    "capture_link": "www.iluma.ai",
    "result": {
        "id_card_ocr": {
            "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
            "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
            "gender": "M",
            "address": "Street 17",
            "country": "PH",
            "surname": "Test",
            "given_name": "Test name",
            "is_tampered": false,
            "date_of_birth": "1985-02-03",
            "date_of_issue": "2018-06-20",
            "document_name": "Driver’s Licence",
            "date_of_expiry": "2027-06-19",
            "id_card_number": "P1111111A",
            "place_of_birth": "SASMUAN PAMPANGA"
        },
        "selfie": {
            "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
            "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
            "are_eyes_open": true,
            "face_mask_detected": false,
            "is_face_cropped": false,
            "multiple_faces_detected": false,
            "is_live": true,
            "confidence": 99,
            "document_name": "Selfie"
        },
        "face_match_percentage": {
            "is_a_match": false,
            "match_score": 0.38
        },
        "business_registration_ocr": {
            "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
            "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
            "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
            "is_tampered": false,
            "business_name": "Testcompany LLC",
            "date_of_issue": "2018-05-03",
            "document_name": "Any Document",
            "date_of_expiry": "2028-05-03",
            "business_owner_name": "John Bold",
            "registration_number": "1111111",
            "date_of_registration": "2018-05-03"
        }
    }
}

Contoh Response Penangkapan dokumen OCR - COMPLETED 

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "COMPLETED",
    "capture_link": "www.iluma.ai",
    "result": {
        "id_card_ocr": {
            "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
            "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
            "gender": "M",
            "address": "Street 17",
            "country": "PH",
            "surname": "Test",
            "given_name": "Test name",
            "is_tampered": false,
            "date_of_birth": "1985-02-03",
            "date_of_issue": "2018-06-20",
            "document_name": "Driver’s Licence",
            "date_of_expiry": "2027-06-19",
            "id_card_number": "P1111111A",
            "place_of_birth": "SASMUAN PAMPANGA"
        },
        "selfie": {
            "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
            "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
            "are_eyes_open": true,
            "face_mask_detected": false,
            "is_face_cropped": false,
            "multiple_faces_detected": false,
            "is_live": true,
            "confidence": 99,
            "document_name": "Selfie"
        },
        "face_match_percentage": {
            "is_a_match": false,
            "match_score": 0.38
        },
        "business_registration_ocr": {
            "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
            "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
            "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
            "is_tampered": false,
            "business_name": "Testcompany LLC",
            "date_of_issue": "2018-05-03",
            "document_name": "Any Document",
            "date_of_expiry": "2028-05-03",
            "business_owner_name": "John Bold",
            "registration_number": "1111111",
            "date_of_registration": "2018-05-03"
        }
    }
}

Contoh Response Penangkapan dokumen OCR - FAILED

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-d49d6f9f-b419-4875-aa24-57888c2e9854",
    "created": "2022-02-25T06:56:09.479Z",
    "updated": "2022-02-25T06:56:09.479Z",
    "status": "FAILED",
    "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Anda akan mendapatkan respons dalam bentuk JSON dengan sebuah reference id ketika melakukan rekues. Karena membutuhkan waktu beberapa detik untuk memproses data, respons akan dikembalikan dalam bentuk callback. Cek kembali apakah anda sudah membuat callback url di sistem kami (type: DOCUMENT_OCR_CAPTURE_REQUEST). Anda dapat membaca seksi Callback untuk lebih detailnya.

Dokumen OCR Capture Skema

Parameter Deskripsi
id string (required)
Nomor Identifikasi unik yang akan anda gunakan untuk memanggil API kami
reference_id string (optional)
ID referensi yang diinputkan oleh pengguna
result json (optional)
Hasil ekstraksi dokumen anda
status string (required)
Status dari request yang anda kirimkan
created string (required)
Tanggal terupdate. ISO8601 timestamp
updated string (required)
Tanggal terupdate. ISO8601 timestamp
types array (required)
Tipe dokumen ingin sistem kami ekstrak. Kami saat ini mensupport BUSINESS_REGISTRATION, SELFIE, IDENTITY_CARD, BUSINESS_REGISTRATION
country string (required)
Negara penerbit dokumen bisnis. Kami saat ini mensupport PH
failure_reason string (optional)
Alasan kegagalan
capture_link string (required)
URL untuk melakukan capture UI

id_card_ocr Skema

Parameter Deskripsi
id string (required)
Unique ID
document_name string (required)
Nama dokumen
link string (required)
link dari dokumen yang di capture
id_card_number string (required)
Nomor ID card
given_name string (required)
Nama depan
surname string (optional)
Nama Belakang
date_of_birth string (required)
Tanggal Lahir. Format YYYY-MM-DD
gender string (required)
Gender. Jenis Kelamin (M / F)
date_of_expiry string (optional)
Tanggal Expired
address string (optional)
Alamat
country string (required)
Negara yang menerbitkan dokumen anda. ISO3166-2 country code.
date_of_issue string (required)
Tanggal penerbitan
place_of_birth string (required)
Tempat Lahir
is_tampered boolean (required)
Keaslian Dokumen

Objek Persentase Kecocokan Wajah

Payload jika tipe adalah IDENTITY_CARD & SELFIE

Parameter Description
is_a_match boolean (required)
Apakah selfie cocok dengan identitas dari dokumen yang diberikan
match_score number (required)
Skor persentase dari kecocokan identitas

Objek Selfie

Payload jika salah satu tipe adalah IDENTITY_CARD

Parameter Deskripsi
id string (required)
Rekues ID
document_name string (required)
Selfie
link string (required)
link dari dokumen yang di capture
are_eyes_open boolean (required)
Mendeteksi apakah mata terbuka atau tidak dalam gambar selfie.
is_face_cropped boolean (required)
Mendeteksi apakah wajah dipotong dalam gambar selfie.
face_mask_detected boolean (required)
Mendeteksi apakah wajah sedang menggunakan masker.
multiple_faces_detected boolean (required)
Mendeteksi apakah terdapat beberapa wajah dalam gambar selfie.
is_live boolean (required)
Hasil pengecekan liveness
confidence string (required)
Tingkat Akurasi

business_registration_ocr Skema

Parameter Deskripsi
id string (required)
Rekues ID anda
document_name string (required)
Nama dokumen anda
link string (required)
Alamat tautan dokumen anda
registration_number string (required)
Nomor Registrasi Bisnis
business_name string (required)
Nama Bisnis
date_of_registration string (required)
Tanggal Registrasi. Format YYYY-MM-DD
date_of_expiry string (optional)
Tanggal Expired
address string (optional)
Alamat
country string (required)
Negara yang menerbitkan dokumen ini. ISO3166-2 country code.
date_of_issue string (required)
Tanggal Penerbitan
business_owner_name string (required)
Nama Pemilik Bisnis
is_tampered boolean (required)
Keaslian Dokumen

Penangkapan Dokumen OCR Errors

Error Code Deskripsi
API_VALIDATION_ERROR
400		 Terdapat Request yang hilang atau tidak sesuai dengan standard kami
SERVER_ERROR
500		 Service ini sedang error

Penangkapan Dokumen OCR: Get by id

Endpoint: Mendapatkan Status rekues data

GET https://api.iluma.ai/v1/identity/document_ocr_captures/:id

Contoh penangkapan dokumen OCR: Request Get by Id

curl https://api.iluma.ai/v1/identity/document_ocr_captures/ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f
    -X GET \
    -u iluma_development_O46JfOtygef9kMNsK+ZPGT+ZZ9b3ooF4w3Dn+R1k+2fT/7GlCAN3jg==:

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID dan ID Referensi yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan OCR Dokumen Bisnis. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Penangkapan Dokumen OCR: Get by id Request

Parameter Deskripsi
id string (required)
Nomor Identifikasi unik yang akan anda gunakan untuk memanggil API kami

Contoh Dokumen OCR Capture Response 

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "COMPLETED",
    "capture_link": "www.iluma.ai",
    "result": {
        "id_card_ocr": {
            "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
            "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
            "gender": "M",
            "address": "Street 17",
            "country": "PH",
            "surname": "Test",
            "given_name": "Test name",
            "is_tampered": false,
            "date_of_birth": "1985-02-03",
            "date_of_issue": "2018-06-20",
            "document_name": "Driver’s Licence",
            "date_of_expiry": "2027-06-19",
            "id_card_number": "P1111111A",
            "place_of_birth": "SASMUAN PAMPANGA"
        },
        "selfie": {
            "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
            "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
            "are_eyes_open": true,
            "face_mask_detected": false,
            "is_face_cropped": false,
            "multiple_faces_detected": false,
            "is_live": true,
            "confidence": 99,
            "document_name": "Selfie"
        },
        "face_match_percentage": {
            "is_a_match": false,
            "match_score": 0.38
        },
        "business_registration_ocr": {
            "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
            "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
            "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
            "is_tampered": false,
            "business_name": "Testcompany LLC",
            "date_of_issue": "2018-05-03",
            "document_name": "Any Document",
            "date_of_expiry": "2028-05-03",
            "business_owner_name": "John Bold",
            "registration_number": "1111111",
            "date_of_registration": "2018-05-03"
        }
    }
}

Penangkapan dokumen OCR: Get by id - Errors

Error Code Deskripsi
DATA_NOT_FOUND
404		 Data tidak ditemukan
SERVER_ERROR
500		 Sedang down atau error lainnya

Penangkapan dokumen OCR: Get by Reference id

Endpoint: Mendapatkan Status rekues data

GET https://api.iluma.ai/v1/identity/document_ocr_captures?reference_id=:reference_id&after_id=:after_id&limit=:limit

Contoh Penangkapan dokumen OCR: Get by id Request

curl --location --request GET 'https://api.iluma.ai/v1/identity/document_ocr_captures?reference_id=1234&after_id=ocr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20'

Anda dapat meminta keterangan status dari sebuah request yang sudah pernah dibuat sebelumnya dengan cara melakukan request GET menggunakan ID dan ID Referensi yang dikembalikan kepada Anda pada saat Anda melakukan request pembuatan OCR Dokumen Bisnis. Anda akan mendapatkan response dengan format yang sama dengan skema response diatas.

Penangkapan dokumen OCR: Get by Reference id Request

Parameter Deskripsi
reference_id string (required)
Referensi ID dari request pembuatan OCR Dokumen. Referensi ID adalah ID Referensi yand diinput oleh user.
limit integer (optional)
Jumlah request yang akan diambil dari database
after_id string (optional)
ID dari request pembuatan OCR Dokumen. ID ini harus sesuai dengan ID yang tertera pada response pada saat request pembuatan OCR Dokumen.

Contoh Penangkapan dokumen OCR Response

{
    "data": [
        {
            "reference_id": "1234",
            "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
            "country": "PH",
            "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
            "created": "2022-04-06T07:33:32.106Z",
            "updated": "2022-04-06T07:33:32.106Z",
            "status": "COMPLETED",
            "capture_link": "www.iluma.ai",
            "result": {
                "id_card_ocr": {
                    "id": "fc8e83a9-cd47-4094-9ecd-37f1988233fd",
                    "link": "a70daa99-f031-4d43-903e-81226c41761a.jpeg",
                    "gender": "M",
                    "address": "Street 17",
                    "country": "PH",
                    "surname": "Test",
                    "given_name": "Test name",
                    "is_tampered": false,
                    "date_of_birth": "1985-02-03",
                    "date_of_issue": "2018-06-20",
                    "document_name": "Driver’s Licence",
                    "date_of_expiry": "2027-06-19",
                    "id_card_number": "P1111111A",
                    "place_of_birth": "SASMUAN PAMPANGA"
                },
                "selfie": {
                    "id": "e07193c3-8660-4ddf-91ed-addf86ea17f5",
                    "link": "86b5d614-70bd-4e25-827f-da55eaa17963.jpeg",
                    "are_eyes_open": true,
                    "face_mask_detected": false,
                    "is_face_cropped": false,
                    "multiple_faces_detected": false,
                    "is_live": true,
                    "confidence": 99,
                    "document_name": "Selfie"
                },
                "face_match_percentage": {
                    "is_a_match": false,
                    "match_score": 0.38
                },
                "business_registration_ocr": {
                    "id": "8cd03b5b-5cf5-458e-a499-62543395e89d",
                    "link": "571603d3-2b42-4cbe-a73a-ae36a49ec065.pdf",
                    "address": "TANONG, MARIKINA CITY, NCR,SECOND DISTRICT,NATIONAL CAPITAL REGION (NCR)",
                    "is_tampered": false,
                    "business_name": "Testcompany LLC",
                    "date_of_issue": "2018-05-03",
                    "document_name": "Any Document",
                    "date_of_expiry": "2028-05-03",
                    "business_owner_name": "John Bold",
                    "registration_number": "1111111",
                    "date_of_registration": "2018-05-03"
                }
            }
        },
        {
            "id": "ocr-ecef7986-b9d6-4e50-8168-8b3d0b110262",
            "capture_link": "www.iluma.ai",
            "reference_id": "1234",
            "country": "PH",
            "types": [
                "IDENTITY_CARD"
            ],
            "status": "PENDING",
            "created": "2022-04-05T12:14:23.908Z",
            "updated": "2022-04-05T12:14:23.908Z"
        },
        {
            "id": "ocr-22bad02a-bbe9-4844-8959-6c50da197e60",
            "capture_link": "www.iluma.ai",
            "reference_id": "1234",
            "country": "PH",
            "types": [
                "IDENTITY_CARD"
            ],
            "status": "PENDING",
            "created": "2022-04-05T12:17:05.638Z",
            "updated": "2022-04-05T12:17:05.638Z"
        }
    ],
    "has_more": false,
    "links": [
        {
            "href": "/v1/document_ocr_captures?reference_id=1234",
            "rel": "first",
            "method": "GET"
        },
        {
            "href": "/v1/document_ocr_captures?reference_id=1234",
            "rel": "self",
            "method": "GET"
        }
    ]
}

Dokumen OCR Capture: Recapture Flow by id (Flow Penangkapan gambar berdasarkan ID)

Endpoint: Mendapatkan Status rekues data

GET https://api.iluma.ai/v1/identity/document_ocr_captures/:id/recapture

Contoh Penangkapan dokumen OCR: Recapture Flow by id

curl https://api.iluma.ai/v1/identity/document_ocr_captures/ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f/recapture
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
       "types": ["IDENTITY_CARD"]
    }'

Endpoint ini akan membiarkan anda untuk melakukan proses penangkapan kembali dosumen bisnis

Dokumen OCR Recapture:

Path parameters Deskripsi
id string (required)
Nomor Identifikasi unik yang akan anda gunakan untuk memanggil API kami
Body Deskripsi
types array (required)
Tipe Dokumen OCR, Nilai yang dapat diinput adalah IDENTITY_CARD, BUSINESS_REGISTRATION, SELFIE

Contoh Dokumen OCR Capture Response 

{
    "reference_id": "foo123",
    "types": ["IDENTITY_CARD", "BUSINESS_REGISTRATION"],
    "country": "PH",
    "id": "ocr-98cdecb2-84b0-477b-b0e6-c5aa2bbdba4f",
    "created": "2022-04-06T07:33:32.106Z",
    "updated": "2022-04-06T07:33:32.106Z",
    "status": "RECAPTURE_PENDING",
    "capture_link": "www.iluma.ai"
}

Dokumen OCR Recapture Errors

Error Code Deskripsi
DATA_NOT_FOUND
404		 Data tidak ditemukan
API_VALIDATION_ERROR
400		 Terdapat Request yang hilang atau tidak sesuai dengan standard kami
SERVER_ERROR
500		 Sedang down atau error lainnya
Path parameters Deskripsi
id string (required)
Nomor Identifikasi unik yang akan anda gunakan untuk memanggil API kami
link string (required)
Link untuk dokumen Capture

Endpoint: Unduh dokumen Capture menggunakan link

GET https://api.iluma.ai/v1/identity/captures/:id/results/:link/download
Error Code Deskripsi
DATA_NOT_FOUND
404		 Data tidak ditemukan
API_VALIDATION_ERROR
400		 Terdapat Request yang hilang atau tidak sesuai dengan standard kami
SERVER_ERROR
500		 Sedang down atau error lainnya

Verifikasi Dokumen Bisnis

Endpoint: Lakukan Verifikasi Dokumen Bisnis

POST https://api.iluma.ai/v0/identity/business_document_verifications

Contoh Permintaan Verifikasi Dokumen Bisnis

curl https://api.iluma.ai/v0/identity/business_document_verifications \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
          "document_id": "ABC Shop",
          "document_id_type": "Business Name",
          "type": "DTI",
          "country": "PH",
          "reference_id": "test",
          "match_parameters": {
            "certificate_number": "1234567",
            "owner_name": "John Doe",
            "registration_date": "2022-01-01",
            "business_legal_name": "Shop ABC"
          }
        }'

Endpoint Verifikasi Dokumen Bisnis memungkinkan validasi dokumen pendaftaran bisnis DTI terhadap database resmi pemerintah. Harap diperhatikan bahwa Endpoint ini hanya berlaku untuk bisnis di Filipina.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Permintaan Verifikasi Dokumen Bisnis

Parameter Description
document_id string (wajib)
Pengenal unik dokumen disediakan
match_parameters objek (wajib) MatchParameters
Parameter yang akan dicocokkan dengan database resmi
document_id_type string
Jenis id dokumen yang disediakan.
Enum: Nama Bisnis(Default), Kode Referensi, TRN, PBN
type string
Jenis dokumen negara yang sedang divalidasi.
Enum: DTI(Default)
country string
Negara penerbit dokumen.
Enum: PH(Default)
reference_id string
Pengidentifikasi pelanggan untuk permintaan ini

Cocokkan Parameter

Parameter Description
certificate_number string
Nomor sertifikat per sertifikat DTI / BNN
business_legal_name string
Nama resmi bisnis per sertifikat DTI (jika ini tidak digunakan sebagai pengidentifikasi dokumen)
owner_name string
Nama pemilik bisnis per sertifikat DTI.
registration_date string (tanggal YYYY-MM-DD)
Tanggal pendaftaran / tanggal berlakunya sertifikat DTI.

Tanggapan Verifikasi Dokumen Bisnis

Karena mungkin perlu beberapa detik untuk memvalidasi dokumen pendaftaran bisnis dengan basis data resmi pemerintah, semua hasil dikembalikan kepada Anda melalui panggilan balik. Pastikan untuk mengonfigurasi URL panggilan balik di akun Anda (Tetapkan dengan jenis: DTI_VALIDATION). Lihat bagian Callback untuk detail lebih lanjut.

Contoh Tanggapan Verifikasi Dokumen Bisnis

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-a02c4549-69f6-4319-94fb-4c90c0d14082",
  "created": "2022-07-26T07:13:04.972Z",
  "updated": "2022-07-26T07:13:04.972Z",
  "status": "PENDING"
}

Tanggapan Verifikasi Dokumen

Parameter Description
id string (wajib)(bdvr-)
Pengidentifikasi unik dari permintaan untuk digunakan dalam panggilan API selanjutnya
created string (wajib)(tanggal-waktu ISO8601)
Tanggal penerimaan permintaan. Stempel waktu ISO8601 dalam UTC
updated string (wajib)(tanggal-waktu ISO8601)
Tanggal permintaan terakhir yang diperbarui. Stempel waktu ISO8601 dalam UTC
type string (wajib)
Status permintaan.
Enum: PENDING, COMPLETED, FAILED
document_id string (wajib)
Pengenal unik dokumen disediakan
document_id_type string (wajib)
Jenis id dokumen disediakan
ketik string (wajib)
Jenis dokumen yang sedang divalidasi
country string (wajib)
Negara penerbit dokumen
reference_id string
Pengidentifikasi pelanggan untuk permintaan ini
match_parameters objek (wajib) MatchParameters
Parameter yang akan dicocokkan dengan database resmi
is_found boolean
Diberikan jika status='SELESAI', apakah dokumen ditemukan di database resmi
result objek MatchParametersResult
Hasil validasi, ditampilkan jika status='COMPLETED' dan is_found=true

Cocokkan Hasil Parameter

Parameter Description
is_certificate_number_match boolean
Apakah nomor sertifikat sama persis
is_registration_date_match boolean
Apakah tanggal pendaftaran sama persis
business_legal_name_score angka
Apakah nama resmi bisnis cocok dengan catatan untuk sertifikat DTI ini
owner_name_score angka
Apakah nama pemilik cocok dengan catatan sertifikat DTI ini

Kesalahan Permintaan Verifikasi Dokumen Bisnis

Error Code Description
API_VALIDATION_ERROR
400		 Muatan permintaan tidak sesuai dengan yang ditentukan. Kolom formulir yang hilang disediakan di payload respons.
REQUEST_FORBIDDEN_ERROR
403		 Kunci API tidak memiliki izin untuk Endpoint ini

Verifikasi Dokumen Bisnis : Get by id

Endpoint: Dapatkan Verifikasi Dokumen Bisnis dengan id permintaan

GET https://api.iluma.ai/v0/identity/business_document_verifications/:id

Contoh Verifikasi Dokumen Bisnis: Dapatkan berdasarkan permintaan id

curl https://api.iluma.ai/v0/identity/business_document_verifications/qwertyuiop1234567890 \
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Anda dapat menanyakan status permintaan yang ada dengan membuat permintaan GET ke sumber daya menggunakan id yang dikembalikan kepada Anda saat membuat sumber daya permintaan. Anda akan menerima tanggapan dengan format yang sama seperti yang ditampilkan di DocumentVerificationResponse.

Verifikasi Dokumen Bisnis: Dapatkan berdasarkan permintaan id

Parameter Description
id string
ID permintaan unik sedang diambil

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Dapatkan Respons Verifikasi Dokumen Bisnis

Pending

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-a02c4549-69f6-4319-94fb-4c90c0d14082",
  "created": "2022-07-26T07:13:04.972Z",
  "updated": "2022-07-26T07:13:04.972Z",
  "status": "PENDING"
}

Completed (Found)

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-5a822398-904b-4bac-aae7-5275fa732d45",
  "created": "2022-07-26T07:12:54.932Z",
  "updated": "2022-07-26T07:12:54.932Z",
  "status": "COMPLETED",
  "is_found": true,
  "result": {
    "is_certificate_number_match": true,
    "is_registration_date_match": true,
    "owner_name_score": 100,
    "business_legal_name_score": 78
  }
}

Completed (Not Found)

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-54959185-9d32-43d3-9ef6-58ce7ea89487",
  "created": "2022-07-26T07:12:43.603Z",
  "updated": "2022-07-26T07:12:43.603Z",
  "status": "COMPLETED",
  "is_found": false
}

Failed

{
  "document_id": "ABC Shop",
  "document_id_type": "Business Name",
  "type": "DTI",
  "country": "PH",
  "reference_id": "test",
  "match_parameters": {
    "certificate_number": "1234567",
    "owner_name": "John Doe",
    "registration_date": "2022-01-01",
    "business_legal_name": "Shop ABC"
  },
  "id": "bdvr-231cc051-7ced-453c-9349-7b3489c8e04f",
  "created": "2022-07-26T07:12:01.190Z",
  "updated": "2022-07-26T07:12:01.190Z",
  "status": "FAILED",
  "failure_reason": "TEMPORARY_NETWORK_ERROR"
}

Dapatkan Verifikasi Dokumen Bisnis dengan Kesalahan ID

Error Code Description
API_VALIDATION_ERROR
400		 Muatan permintaan tidak sesuai dengan yang ditentukan. Kolom formulir yang hilang disediakan di payload respons.
DATA_NOT_FOUND
404		 ID permintaan yang diminta tidak ada
REQUEST_FORBIDDEN_ERROR
403		 Kunci API tidak memiliki izin untuk Endpoint ini

Verifikasi Dokumen Bisnis : Dapatkan dengan referensi id

Endpoint: Dapatkan Verifikasi Dokumen Bisnis dengan id referensi

GET https://api.iluma.ai/v0/identity/business_document_verifications?reference_id=:reference_id&after_id=:after_id&limit=:limit

Contoh Verifikasi Dokumen Bisnis: Dapatkan dengan referensi id

curl https://api.iluma.ai/v0/identity/business_document_verifications?reference_id=foo123&after_id=bdvr-eeb78403-38c7-43d2-8de8-444a5fbaf653&limit=20\
    -X GET \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw:

Anda dapat menanyakan status permintaan yang ada dengan membuat permintaan GET ke sumber daya menggunakan id referensi yang diberikan saat membuat sumber daya permintaan. Anda akan menerima larik DocumentVerificationResponse.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Verifikasi Dokumen Bisnis: Dapatkan dengan referensi id

Parameter Description
reference_id string
ID referensi klien sedang diambil
limit angka
Jumlah hasil yang akan dikembalikan dalam satu halaman. Default ke 10
after_id string
kursor untuk memulai halaman. Ini mengacu pada request_id dari permintaan terakhir yang dikembalikan di halaman sebelumnya

Dapatkan Verifikasi Dokumen Bisnis dengan Respon ID Referensi

{
  "data": [
    {
      "document_id": "ABC Shop",
      "document_id_type": "Business Name",
      "type": "DTI",
      "country": "PH",
      "reference_id": "test",
      "match_parameters": {
        "certificate_number": "1234567",
        "owner_name": "John Doe",
        "registration_date": "2022-01-01",
        "business_legal_name": "Shop ABC"
      },
      "id": "bdvr-5a822398-904b-4bac-aae7-5275fa732d45",
      "created": "2022-07-26T07:12:54.932Z",
      "updated": "2022-07-26T07:12:54.932Z",
      "status": "COMPLETED",
      "is_found": true,
      "result": {
        "is_certificate_number_match": true,
        "is_registration_date_match": true,
        "owner_name_score": 100,
        "business_legal_name_score": 78
      }
    }
  ],
  "has_more": true,
  "links": [
    {
      "href": "/v0/identity/business_document_verifications/",
      "rel": "first",
      "method": "GET"
    },
    {
      "href": "/v0/identity/business_document_verifications/?limit=10",
      "rel": "self",
      "method": "GET"
    },
    {
      "rel": "next",
      "href": "/v0/identity/business_document_verifications/?limit=10&after_id=653941f5-95d9-42d6-a40c-51c21e85b8d6",
      "method": "GET"
    }
  ]
}

Dapatkan Verifikasi Dokumen Bisnis dengan Respon ID Referensi

Parameter Description
data larik DocumentVerificationResponse
Larik permintaan yang dibuat sebelumnya ditemukan oleh reference_id yang disediakan. Akan mengembalikan array kosong jika tidak ada sumber daya yang ditemukan.
link array LinkSchema
Implementasi HATEOAS di after_id
has_more boolean
True jika ada halaman tambahan di hasil

Parameter Description
href string
Target URI yang harus berisi target ke Internationalized Resource Identifiers (IRI)
rel string
Tipe relasi tautan menjelaskan bagaimana konteks (sumber) saat ini terkait dengan target
method string
Atribut metode HTTP untuk target IRI

Dapatkan Verifikasi Dokumen Bisnis dengan Kesalahan ID Referensi

Error Code Description
API_VALIDATION_ERROR
400		 Muatan permintaan tidak sesuai dengan yang ditentukan. Kolom formulir yang hilang disediakan di payload respons.
REQUEST_FORBIDDEN_ERROR
403		 Kunci API tidak memiliki izin untuk Endpoint ini

Anti-Money Laundering

Produk AML Iluma (Anti Money-Laundering) dapat membantu Anda untuk memeriksa resiko seorang individu ketika dia sedang berinteraksi dengan Anda. Kami membantu Anda mengidentifikasi individu atau entitas tercantum dalam daftar sanksi internasional atau orang yang terpapar politik (PEP). Hubungi kami jika Anda tertarik untuk mengetahui lebih lanjut.

CFT Individual

Endpoint CFT (Combating the Financing of Terrorism) Individual dapat digunakan untuk memeriksa di database apabila seorang individu terhubung dengan kegiatan terorisme atau pendanaan senjata oemusnah massal. Kami men-support query kepada:

Skema Request CFT - Individual

Endpoint: Meng-query individu yang berpotensi terdaftar dalam database cft.

POST https://api.iluma.ai/v2/identity/cft/individual_data_requests

Contoh Format Request CFT - Individu

curl https://api.iluma.ai/v2/identity/cft/individual_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "given_name": "Kim Kyong",
        "surname": "Ok",
        "publishers": ["PPATK", "UNSCR"],
        "score_threshold": 50
    }'

Kami menggunakan algoritma fuzzy-match di data yang anda sediakan untuk memberikan peringkat kepada profil-profil di daftar cft kami. Dibutuhkan setidaknya field given_name untuk melakukan pengecekan tetapi tingkat konfidensi kecocokan bisa lebih baik bila anda menyediakan lebih banyak data untuk menambah akurasi pencarian.

Parameter Deskripsi
publishers array (optional)
Himpunan nama-nama penerbit yang anda ingin masukkan dalam pencarian. Nama penerbit yang kami perbolehkan adalah UNSCR, OFAC, PPATK, MAS dan EC. Bila field ini tidak ada, kami akan mencari dari semua penerbit.
score_threshold integer (required)
Nilai minimum untuk menyaring hasil pencarian. Minimal 30.
given_name string (required)
Nama awal dari seorang individu untuk melakukan pencarian.
middle_name string (optional)
Nama tengah dari seorang individu untuk melakukan pencarian. Bila disediakan, dapat membantu menambah akurasi pencarian.
surname string (optional)
Nama akhir dari seorang individu untuk melakukan pencarian. Bila disediakan, dapat membantu menambah akurasi pencarian.
nationality string (optional)
Negara tempat lahir atau negara kebangsaan seorang individu. Dalam format ISO-3166-2.
addresses array (optional)
Alamat (kantor atau rumah) yang diketahui dari seorang individu. Objek alamat akan memiliki ketentuan berikut:
country Kode negara dalam ISO 3166-2
street_line1 Baris pertama dari nama jalan, nama gedung, maupun nomor apartemen.
street_line2 Baris kedua dari nama jalan, nama gedung, maupun nomor apartemen.
city Kota
province Provinsi
state Negara Bagian
postal_code Kode Pos
category Tipe Alamat HOME, WORK atau PROVINCIAL. Kami memperbolehkan rumah Provincial untuk kasus dimana seorang individu bertempat tinggal di sebuah kota atau tempat tertentu untuk bekerja di hari biasa dan pulang ke rumahnya atau rumah keluarganya di kota lain ketika akhir minggu.
date_of_birth string (optional)
Tanggal lahir dalam format YYYY-MM-DD.
phone_number string (optional)
Nomor telepon seorang individu dalam format E.164
email string (optional)
Alamat email dari seorang individu.

Contoh Format Response CFT - Individual

{
    "id": "2ccdb5ff-1a2f-4cc3-9434-5fb8d3b1d11b",
    "given_name": "Kim Kyong",
    "surname": "Ok",
    "publishers": ["PPATK"],
    "results": [
        {
            "list": "LDP",
            "names": [
                "Kim Kyong Ok",
                "KIM KYONG OK"
            ],
            "score": 70,
            "publisher": "PPATK",
            "nationalities": [
                "KP"
            ],
            "record_data": {
                "pid": "north_korean_individual_33",
                "name": "KIM KYONG OK",
                "type": "INDIVIDUAL",
                "origin": "Proliferasi WMD",
                "aliases": [
                    "Kim Kyong Ok"
                ],
                "reference": "DPRKi.033",
                "nationality": "Democratic People's Republic of Korea",
                "country_code": "KP",
                "date_of_birth": "a) tahun 1937 \nb) tahun 1938",
                "place_of_birth": ""
            },
            "dates_of_birth": [
                {
                    "d": 0,
                    "m": 0,
                    "y": 1937
                },
                {
                    "d": 0,
                    "m": 0,
                    "y": 1938
                }
            ]
        }
    ]
}

Skema Response CFT - Individu

Sebuah skor akan dikembalikan beserta hasil pencarian anda untuk membantu dalam pengecekan anda. Perlu diketahui bahwa kita tidak menyediakan rekomendasi kelayakan skor kecocokan tertentu. API ini dapat digunakan sebagai salah satu alat bantu anda dalam melakukan pengecekan dan bukan sebagai pegangan anda satu-satunya dalam melakukan investigasi. Penggunaan API ini tidak membatasi pertanggungjawaban kriminal maupun legal terhadap aksi-aksi yang dilakukan, atau berdasarkan, penggunaan tersebut.

Parameter Deskripsi
id string (required)
ID dari response API.
given_name string (required)
Nama awalan dari individu yang disediakan ke pencarian.
middle_name string (optional)
Nama tengah dari individu yang disediakan ke pencarian.
surname string (optional)
Nama akhir dari individu yang disediakan ke pencarian.
nationality string (optional)
The country of birth or citizenship of the individual submitted to the search.
addresses array (optional)
Alamat individu yang disediakan ke pencarian.
date_of_birth string (optional)
Tanggal lahir individu yang disediakan ke pencarian.
phone_number string (optional)
Nomor telepon individu yang disediakan ke pencarian.
email string (optional)
Email address individu yang disediakan ke pencarian.
results array (required)
Himpunan objek-objek hasil dari profil yang ditemukan. Bisa pula kosong.

Skema Objek Result - Individu

Parameter Deskripsi
dates_of_birth array (optional)
Himpunan objek tanggal lahir menurut daftar. Setiap objek akan memiliki format sebagai berikut:
y (required) 4 digit tahun
m (required) 1-2 digit bulan
d (required) 1-2 digit hari
Untuk tanggal yg tidak diketahui, nilainya adalah 0.
list string (required)
Sub-tipe dari daftar sebuah penerbit. (contoh: SDN vs Non-SDN untuk OFAC).
names array (required)
Himpunan nama dan samaran seorang individu.
nationalities array (optional)
Himpunan kode negara dalam format ISO 3166-2 untuk meng-identifikasi kebangsaan seorang individu.
publisher string (required)
Nama penerbit dari daftar pantauan. (contoh; OFAC)
record_data object (required)
Catatan asli dari sumber data kami dalam objek JSON. Perlu diketahui bahwa kami tidak menjamin konsistensi dari skema dalam objek catatan ini.
score integer (required)
Skor yang meng-indikasikan tingkat kecocokan nama.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

CFT Entity

Endpoint CFT (Combating the Financing of Terrorism) Entity dapat digunakan untuk memeriksa di database apabila sebuah institusi terhubung dengan kegiatan terorisme atau pendanaan senjata pemusnah massal. Kami men-support query kepada:

Skema Request CFT - Entitas

Endpoint: Meng-query entitas yang berpotensi terdaftar dalam database cft.

POST https://api.iluma.ai/v2/identity/cft/entity_data_requests

Contoh Format Request CFT - Entitas

curl https://api.iluma.ai/v2/identity/cft/entity_data_requests \
    -X POST \
    -u iluma_development_FX4f0M5sxDgk5qFyZnk60ZengAfA9o31x3ecd29vihjc4VhyJ8FclZhHjjw: \
    -H 'Content-Type: application/json' \
    -d '{
        "business_name": "Yuk Tung Energy",
        "business_domicile": "SG",
        "publishers": ["PPATK", "UNSCR"],
        "score_threshold": 50
    }'

Kami menggunakan algoritma fuzzy-match yang mirip dengan pencarian individu tapi kami mem-prioritaskan identitas bisnis atau institusi. Dibutuhkan setidaknya field business_name untuk melakukan pengecekan tetapi tingkat konfidensi kecocokan bisa lebih baik bila anda menyediakan lebih banyak data untuk menambah akurasi pencarian.

Parameter Deskripsi
publishers array (optional)
Himpunan nama-nama penerbit yang anda ingin masukkan dalam pencarian. Nama penerbit yang kami perbolehkan adalah UNSCR, OFAC, PPATK, MAS dan EC. Bila field ini tidak ada, kami akan mencari dari semua penerbit.
score_threshold integer (required)
Nilai minimum untuk menyaring hasil pencarian. Minimal 30.
business_name string (required)
Nama institusi untuk melakukan pencarian.
business_domicile string (optional)
Negara tempat institusi tersebut ber-operasi. Dalam format ISO-3166-2.
addresses array (optional)
Alamat (kantor atau rumah) yang diketahui dari sebuah entitas bisnis. Objek alamat akan memiliki ketentuan berikut:
country Kode negara dalam ISO 3166-2
street_line1 Baris pertama dari nama jalan, nama gedung, maupun nomor apartemen.
street_line2 Baris kedua dari nama jalan, nama gedung, maupun nomor apartemen.
city Kota
province Provinsi
state Negara Bagian
postal_code Kode Pos
category Tipe Alamat REGISTERED atau TRADING.
date_of_registration string (optional)
Tanggal pendaftaran institusi dalam format YYYY-MM-DD.
phone_number string (optional)
Nomor telepon sebuah entitas bisnis dalam format E.164
email string (optional)
Alamat email dari sebuah entitas bisnis.

Contoh Format Response CFT - Entitas

{
    "id": "8ca9d4d4-b131-4ec3-92c0-7e9c124b919e",
    "business_name": "Yuk Tung Energy",
    "business_domicile": "SG",
    "publishers": ["UNSCR"],
    "results": [
        {
            "list": "UNSCR",
            "names": [
                "YUK TUNG ENERGY PTE LTD"
            ],
            "score": 80,
            "publisher": "UNSCR",
            "record_data": {
                "dataid": "6908689",
                "sort_key": "",
                "comments1": "Ship manager and commercial manager of the YUK TUNG, which conducted ship-to-ship transfer of refined petroleum product.",
                "list_type": {
                    "value": [
                        "UN List"
                    ]
                },
                "listed_on": "2018-03-30",
                "first_name": "YUK TUNG ENERGY PTE LTD",
                "versionnum": "1",
                "entity_alias": [
                    {
                        "quality": "",
                        "alias_name": ""
                    }
                ],
                "un_list_type": "DPRK",
                "entity_address": [
                    {
                        "city": "Singapore",
                        "street": "80 Raffles Place, #17-22 UOB Plaza",
                        "country": "Singapore",
                        "zip_code": "048624"
                    }
                ],
                "last_day_updated": {
                    "value": [
                        "2020-05-11"
                    ]
                },
                "reference_number": "KPe.075",
                "sort_key_last_mod": ""
            },
            "business_domiciles": [],
            "dates_of_registration": [
                {
                    "d": 0,
                    "m": 0,
                    "y": 0
                }
            ]
        }
    ]
}

Skema Response CFT - Entitas

Sebuah skor akan dikembalikan beserta hasil pencarian anda untuk membantu dalam pengecekan anda. Perlu diketahui bahwa kita tidak menyediakan rekomendasi kelayakan skor kecocokan tertentu. API ini dapat digunakan sebagai salah satu alat bantu anda dalam melakukan pengecekan dan bukan sebagai pegangan anda satu-satunya dalam melakukan investigasi. Penggunaan API ini tidak membatasi pertanggungjawaban kriminal maupun legal terhadap aksi-aksi yang dilakukan, atau berdasarkan, penggunaan tersebut.

Parameter Deskripsi
business_name string (required)
Nama dari entitas atau institusi yang disediakan ke pencarian.
business_domicile string (optional)
Negara domisili dari entitas atau institusi yang disediakan ke pencarian.
addresses array (optional)
Alamat dari entitas atau institusi yang disediakan ke pencarian.
date_of_registration string (optional)
Tanggal pendaftaran dari entitas atau institusi yang disediakan ke pencarian.
phone_number string (optional)
Nomor telepon dari entitas atau institusi yang disediakan ke pencarian.
email string (optional)
Alamat email dari entitas atau institusi yang disediakan ke pencarian.
id string (required)
ID dari Response API.
results array (required)
Himpunan objek-objek hasil dari profil yang ditemukan. Bisa pula kosong.

Skema Objek Result - Entitas

Parameter Deskripsi
business_domiciles array (optional)
Kode negara ISO 3166-2 country code dari institusi yang terdaftar.
dates_of_registration array (optional)
Tanggal pendaftaran bila ada dalam daftar. Setiap objek akan memiliki format sebagai berikut:
y (required) 4 digit tahun
m (required) 1-2 digit bulan
d (required) 1-2 digit hari
Untuk tanggal yg tidak diketahui, nilainya adalah 0.
list string (required)
Sub-tipe dari daftar sebuah penerbit. (contoh: SDN vs Non-SDN untuk OFAC).
names array (required)
Himpunan nama dan samaran dari sebuah entitas atau institusi.
publisher string (required)
Nama penerbit dari daftar pantauan. (contoh; OFAC).
record_data object (required)
Catatan asli dari sumber data kami dalam objek JSON. Perlu diketahui bahwa kami tidak menjamin konsistensi dari skema dalam objek catatan ini.
score integer (required)
Skor yang meng-indikasikan tingkat kecocokan nama.

Endpoint: API Flow

The flow of the API for this endpoint are available here.

Errors

Berikut adalah beberapa error yang paling umum di semua endpoint kami. Penjelasan spesifik tentang error tertentu terletak di dalam setiap endpoint tersebut. Jika Anda memiliki pertanyaan, silakan hubungi kami.

Kode Error Penjelasan
400 Bad Request, contoh: kesalahan validasi, payload salah bentuk
401 Akses tidak terotorisasi, contoh: API key salah
403 Akses tidak diperbolehkan, contoh: API key tidak dapat memiliki izin untuk endpoint ini
404 Halaman atau endpoint tidak ditemukan
413 Ukuran file terlalu besar. Silahkan merujuk ke dokumen API untuk endpoint atau halaman yang mau dituju untuk melihat batasan.
415 Format file tidak didukung. Silahkan merujuk ke dokumen API untuk endpoint atau halaman yang mau dituju untuk melihat batasan.
429 Kuota API terlampaui. Agar anda tidak lagi menerima status kesalahan ini, Anda harus menunggu beberapa saat untuk dapat mencoba lagi permintaan anda.
500 Error tidak tertangani - hubungi kami saat ini terjadi.
bash