curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"color_primary": "#123456", "font_family": "AR One Sans"}'{
"color_primary": "#123456",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 16,
"font_family": "AR One Sans",
"font_weight": "400",
"font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
"logo_square": null,
"logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": true,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}API Update Branding White Label
Perbarui branding White Label lewat Management API Didit: ubah warna, font, radius border, unggah logo, dan atur opsi UI alur verifikasi.
curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"color_primary": "#123456", "font_family": "AR One Sans"}'{
"color_primary": "#123456",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 16,
"font_family": "AR One Sans",
"font_weight": "400",
"font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
"logo_square": null,
"logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": true,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}Ikhtisar
Memperbarui sebagian branding White Label untuk aplikasi yang diidentifikasi dari kunci API Anda. Kirimapplication/json untuk mengubah warna, font, radius sudut, dan opsi UI, atau multipart/form-data untuk mengunggah logo. Hanya kolom yang Anda sertakan yang diubah. Kolom lainnya tidak diubah.
Kapan menggunakannya
- Terapkan tema pada alur: atur warna merek, font, dan radius sudut Anda.
- Unggah logo: atur logo persegi, logo persegi panjang beserta versi mode gelapnya, dan favicon.
- Sesuaikan pengalaman: atur nama aplikasi publik, URL kebijakan privasi, serta sakelar seperti melewati layar selamat datang atau menyembunyikan bilah progres.
Mengunggah logo
Kirim logo sebagaimultipart/form-data:
image_square: rasio aspek 1:1.image_rectangular: rasio aspek 2:1.image_rectangular_dark: rasio aspek 2:1. Logo persegi panjang untuk mode gelap, ditampilkan di latar belakang gelap.image_favicon: maksimum 500 KB.
image_square, image_rectangular dan image_rectangular_dark harus berupa gambar PNG, JPG, atau WebP, dengan sisi terpanjang minimal 512 px dan ukuran maksimum 1 MB.
File SVG ditolak.
Respons mengembalikan URL logo_square, logo_rectangular, logo_rectangular_dark, dan favicon yang dihasilkan.
Untuk menghapus logo, kirim flag delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark, atau delete_favicon yang sesuai dengan nilai true.
Setelah Anda menghapus logo mode gelap, logo_rectangular_dark bernilai null.
Jika satu permintaan mengunggah logo dan juga mengirim flag hapusnya, unggahan akan diprioritaskan.
Unggahan yang ditolak mengembalikan 400 beserta nama kolom dan alasannya, misalnya:
{"image_rectangular_dark": ["Upload a PNG, JPG or WebP image."]}{"image_rectangular": ["Image must be at least 512 px on its long side. Got 400x200 image dimensions"]}{"image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"]}{"image_square": ["File size should not exceed 1 MB"]}
Catatan
- Aplikasi diidentifikasi dari kunci API. Tidak ada parameter path.
- Warna hex menerima
#RRGGBBatau#RRGGBBAA.font_weightharus berupa ketebalan yang tersedia untukfont_familyyang dipilih. - Domain kustom dan email White Label tidak dapat dikonfigurasi di sini. Kelola keduanya di Business Console.
Izin
Kunci API harus memiliki izin untuk memperbarui kustomisasi aplikasi.Terkait
Otorisasi
Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.
Body
Body pembaruan branding parsial. Berikan hanya kolom yang ingin Anda ubah. Warna heksadesimal menerima #RRGGBB atau #RRGGBBAA. Domain kustom dan email White Label tidak diterima di sini.
Warna header / teks utama.
Warna teks paragraf / sekunder.
Warna latar belakang halaman.
Warna panel / aksen.
Warna panel pada opasitas 10%.
Warna teks bantuan pada panel.
Warna pil / lencana pada panel.
Warna teks pada latar belakang.
Warna tombol utama.
Warna tombol sekunder.
Warna teks tombol utama.
Warna teks tombol sekunder.
Warna teks untuk badge berbentuk pil, input, dan pemilih.
Radius sudut panel dalam piksel.
x >= 0Radius sudut tombol dalam piksel.
x >= 0Nama keluarga font Google (misalnya Inter, AR One Sans).
Ketebalan font yang tersedia untuk famili yang dipilih (misalnya regular, 500, 700).
Nama publik yang ditampilkan dalam alur verifikasi.
URL kebijakan privasi yang ditampilkan kepada pengguna akhir.
Lewati layar selamat datang awal.
Lanjutkan sebagai tamu daripada menampilkan layar masuk dengan Didit. Tidak dapat diubah kembali ke false saat domain kustom dikonfigurasi (400).
Sembunyikan bilah kemajuan selama alur berlangsung.
Jeda (detik) sebelum mengalihkan ke URL callback.
x >= 0Jika true, menghapus logo persegi saat ini.
Jika true, menghapus logo persegi panjang saat ini.
Jika true, menghapus logo mode gelap saat ini, dan logo_rectangular_dark kemudian bernilai null. Jika permintaan multipart yang sama juga mengunggah image_rectangular_dark, unggahan tersebut yang diprioritaskan.
Jika true, menghapus favicon saat ini.
Respons
Branding diperbarui. Objek branding LENGKAP akan dikembalikan (semua kolom, bukan hanya yang Anda ubah).
Branding White Label untuk aplikasi: warna, font, radius, URL logo, dan opsi UI/UX. URL logo hanya dapat dibaca (atur dengan mengunggah gambar). Domain kustom dan email White Label tidak disertakan.
Hanya baca. URL stylesheet Google Fonts hasil resolusi untuk keluarga font yang dipilih.
URL logo persegi bersifat hanya-baca. Unggah melalui image_square.
URL logo persegi panjang bersifat hanya-baca. Unggah melalui image_rectangular.
Hanya-baca. URL bertanda tangan sementara dari logo persegi panjang untuk mode gelap, ditampilkan pada latar belakang gelap. Bernilai null jika tidak ada logo gelap yang diatur atau logo persegi panjang tidak ditampilkan untuk akun Anda. Unggah dengan image_rectangular_dark.
URL favicon bersifat hanya-baca. Unggah melalui image_favicon.