Buat profil hanya sekali
Permintaan ini membuat profil registrasi lokal beserta catatan identitas dan alamat di operator. Mulailah dengan negara registrasi, jenis nomor dan persyaratan yang berlaku saat ini. Persyaratan bergantung pada negara dan jenis nomor yang ingin Anda daftarkan.
Respons pembuatan yang berhasil bukanlah persetujuan regulasi atau aktivasi nomor. Simpan UUID dokumen, ID identitas, dan ID alamat secara terpisah: ketiganya memiliki tujuan yang berbeda. Permintaan ini mengubah data akun dan bukan operasi validasi saja.
Permintaan pembuatan
Lakukan autentikasi dengan akun MultiTEL API Anda yang telah diaktifkan beserta alamat IP yang diizinkan. Contoh-contoh ini menggunakan kredensial HTTP Basic yang disimpan dalam variabel lingkungan. Periksa respons HTTP dan JSON status.code; respons HTTP 200 saja tidak membuktikan keberhasilan. Semua nilai contoh bersifat fiktif.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @registration-profile.json \
https://api.multitel.net/v3/create_document{
"identity_type": "Personal",
"first_name": "Example",
"last_name": "Person",
"phone_number": "12025550123",
"email": "end-user@example.com",
"city": "Example City",
"postal_code": "00000",
"country": "US",
"address": "1 Example Street",
"nationality": "US",
"signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}JSON tersebut adalah profil Personal ilustratif, bukan identitas nyata yang siap dikirim. Ganti detail dan tanda tangannya dengan informasi pengguna akhir yang diwajibkan oleh aturan registrasi yang dipilih. Input form-encoded juga didukung.
| Kolom | Keharusan dan format |
|---|---|
identity_type | Wajib. Gunakan nilai persis Personal atau Business; validasi bersyarat bergantung pada penggunaan huruf besar/kecil. |
first_name, last_name | Wajib, masing-masing maksimal 64 karakter. Untuk bisnis, berikan detail perwakilan yang diwajibkan oleh negara yang dipilih. |
phone_number | Nilai telepon numerik wajib, minimal delapan karakter. Nomor internasional yang hanya berisi digit termasuk kode negaranya cocok untuk validasi ini; ini adalah nomor kontak, bukan pembelian nomor. |
city, postal_code, address | Wajib, masing-masing maksimal 64 karakter. |
country | Kode ISO negara alamat yang wajib diisi dari katalog registrasi. Layanan akan memetakannya ke catatan negara operator. |
signature | Data tanda tangan wajib. Portal saat ini mengirimkan byte gambar PNG Base64 tanpa prefiks data:image/png;base64,. Dapatkan tanda tangan pengguna akhir melalui alur kerja resmi Anda; placeholder yang tidak kosong bukanlah tanda tangan yang bermakna. |
nationality | Wajib untuk Personal, berupa kode ISO negara. Jangan menggantinya dengan UUID negara. |
company_name, incorporation_country | Wajib untuk Business. Nama perusahaan maksimal 64 karakter; incorporation_country adalah kode ISO negara. |
email | Email kontak pengguna akhir yang bersifat opsional, maksimal 254 karakter. Email yang dihilangkan atau kosong tidak mewarisi email akun dasar. |
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description | Opsional dalam handler ini, tetapi negara/operator yang dipilih mungkin mewajibkan sebagian di antaranya. Berikan format yang diwajibkan untuk registrasi tersebut. Panggilan API langsung tidak secara otomatis menerapkan setiap normalisasi yang dilakukan oleh portal. |
Handler v3 langsung ini mewajibkan kolom alamat dan membuat sebuah alamat. Jangan berasumsi bahwa opsi penundaan alamat di portal tersedia melalui handler ini.
Simpan ketiga pengenal
Berikut ini ditampilkan sebagian kolom respons; respons sebenarnya juga berisi informasi profil yang dikirim dan data tanda tangan. Perlakukan seluruh respons sebagai data privat.
{
"status": {
"code": 200,
"msg": "Success Create Registration Detail."
},
"response": {
"uuid": "11111111111111111111111111111111",
"identity_id": "22222222222222222222222222222222",
"address_id": "33333333333333333333333333333333",
"country_iso": "US",
"email": "end-user@example.com"
}
}response.uuidmengidentifikasi profil lokal. Gunakan bersama get_document. Dalam respons documents dan get_document, pengenal profil yang sama diberi namaid.response.identity_idmengidentifikasi identitas untuk bukti identitas dan dokumen pendukung di kemudian hari.response.address_idmengidentifikasi alamat yang dibuat. Simpan secara terpisah; UUID profil lokal bukanlah ID alamat. Kompatibilitas lampiran bukti alamat di kemudian hari untuk profil yang baru dibuat masih dalam peninjauan.
Kedua endpoint pembacaan ulang profil tidak mengembalikan identity_id atau address_id, jadi simpan respons pembuatan asli yang berhasil. Jika hilang, gunakan tampilan dokumen di portal atau hubungi dukungan sebelum membuat penggantinya.
Lanjutan: melampirkan bukti yang telah diunggah sebelumnya saat pembuatan
Anda dapat mengirimkan identity_encryptfiles dan address_encryptfiles sebagai array ID yang dikembalikan oleh create_encrypt_files. Unggah menggunakan jenis bukti untuk kategori entitas yang sesuai, lalu kirim sebelum referensi file kedaluwarsa dalam waktu sekitar 20 menit. Handler pembuatan memeriksa akun, kategori, dan masa berlaku setiap referensi yang dikirimkan.
Kolom-kolom ini memiliki nama yang berbeda dari encrypted_file_ids pada endpoint pelampiran di kemudian hari. Saat pembuatan, setiap file dikirim sebagai permintaan bukti terpisah, bahkan ketika beberapa file memiliki satu jenis bukti yang sama. Untuk bukti identitas yang harus memuat beberapa file sekaligus, gunakan permintaan create_proof di kemudian hari dengan satu array. Keberhasilan pembuatan profil saja tidak memberikan hasil persetujuan untuk masing-masing bukti.
Jika bukti alamat yang dikirim kemudian ditolak untuk alamat yang baru dibuat, jangan menggunakan UUID profil sebagai pengganti atau membuat ulang identitas berulang kali. Berhenti dan periksa profil di portal atau bersama dukungan. Jalur pembacaan ulang/pencarian bukti alamat masih menjadi keterbatasan peninjauan.
Kegagalan dan pembuatan parsial
Kode API 400 mencakup validasi kolom, kegagalan pembuatan di operator, dan kegagalan penyimpanan lokal. Kesalahan validasi dapat muncul sebagai entri berkunci kolom dalam response. Kode 500 digunakan untuk negara registrasi yang tidak tersedia/tidak valid, dan kode 404 untuk referensi yang telah diunggah sebelumnya namun hilang atau kedaluwarsa. Baca status.msg selain kodenya.
Profil lokal dan operasi operator di hulu bukanlah satu transaksi atomik. Permintaan yang gagal dapat meninggalkan status di hulu meskipun tidak ada profil lokal yang tercantum. Tidak ada kunci idempotensi klien yang tersedia. Setelah waktu habis atau kegagalan yang tidak pasti, periksa profil yang ada dan hubungi dukungan sebelum mengulangi pembuatan; daftar documents yang kosong bukanlah bukti bahwa tidak ada yang dibuat di hulu.