Langsung ke konten utama
PATCH
curl

Ikhtisar

Memperbarui kolom yang dapat diubah pada entitas bisnis. Kolom yang diisi dari pencarian di registri perusahaan (legal_name, registration_number, country_code) menjadi hanya-baca setelah sesi Verifikasi Bisnis (KYB) pertama yang disetujui.

Kapan digunakan

  • Ubah nama: tetapkan display_name yang lebih sesuai untuk tampilan internal.
  • Perbarui metadata: pindahkan bisnis antar tingkat internal, tambahkan catatan internal, ubah tag.
  • Timpa data registri (dengan hati-hati): penimpaan diterima tetapi ditandai di log audit.

Catatan

  • vendor_data di URL tidak dapat diubah melalui endpoint ini.
  • Mengirim webhook business.data.updated dengan array changed_fields.
  • Setiap perubahan dicatat di Aktivitas perusahaan pada Business Console. Perubahan status dicatat beserta reason opsional (hingga 1000 karakter), dan perubahan pada display_name, legal_name, registration_number, country_code atau metadata dicatat sebagai pembaruan profil. Webhook business.status.updated tidak menyertakan reason.

Izin

Rahasia utama dan kunci API dengan akses penuh selalu dapat memanggil endpoint ini. Kunci dengan akses kustom memerlukan izin tulis Perusahaan (businesses). Kunci yang dibatasi pada alur kerja tertentu atau pada sesi yang disetujui tidak dapat mengakses endpoint ini. Peran dan izin Console menentukan apa yang dapat dilakukan anggota tim di Console. Keduanya tidak dievaluasi untuk permintaan kunci API.

Terkait

Otorisasi

x-api-key
string
header
wajib

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.

Parameter Path

vendor_data
string
wajib

Pengidentifikasi unik Anda untuk bisnis (string bentuk bebas, BUKAN UUID).

Body

application/json

Body pembaruan parsial. Berikan hanya kolom yang ingin Anda ubah.

display_name
string | null

Nama tampilan yang mudah dipahami yang ditampilkan di konsol (mengambil prioritas di atas legal_name untuk tampilan antarmuka).

Nama resmi menurut hukum dari registri atau entri manual.

registration_number
string | null

Nomor registrasi atau nomor pendirian perusahaan.

country_code
string | null

Negara pendirian (ISO 3166-1 alpha-2, misalnya GB, US).

status
enum<string>

Status siklus hidup bisnis. Menyetel BLOCKED secara otomatis menambahkan vendor_data ke daftar blokir sistem; beralih dari BLOCKED menghapus entri daftar blokir tersebut.

Opsi yang tersedia:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objek JSON arbitrer yang Anda lampirkan ke bisnis. Menggantikan sepenuhnya metadata yang ada saat pembaruan — gabungkan di sisi klien jika Anda hanya ingin menambahkan kunci.

reason
string | null

Alasan mengapa status berubah. Dicatat pada entri perubahan status di Activity perusahaan di Business Console, hanya jika status benar-benar berubah. Webhook tidak menyertakannya.

Maximum string length: 1000

Respons

Bisnis diperbarui. Data bisnis lengkap yang telah diperbarui dikembalikan.

Detail bisnis lengkap. Memperluas BusinessListItem dengan metadata dan updated_at.

didit_internal_id
string<uuid>

UUID internal yang stabil dari Didit untuk bisnis ini.

vendor_data
string | null

Pengidentifikasi unik Anda untuk bisnis ini (diteruskan saat membuat sesi). Nilai ini dapat berupa null jika tidak ada pengidentifikasi vendor yang diberikan.

display_name
string | null

Nama tampilan kustom yang Anda tetapkan

Nama resmi menurut hukum dari registri atau entri manual

registration_number
string | null

Nomor registrasi atau nomor pendirian perusahaan

country_code
string | null

Negara pendirian (ISO 3166-1 alpha-2, misalnya GB, US).

effective_name
string | null

Nama terbaik yang tersedia: display_name jika disetel, selain itu legal_name

status
enum<string>

Status siklus hidup rekaman bisnis (BUKAN status sesi). ACTIVE adalah default, FLAGGED menandainya untuk perhatian manual, BLOCKED mencegah sesi baru untuk vendor_data ini.

Opsi yang tersedia:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Jumlah total sesi verifikasi untuk bisnis ini

approved_count
integer

Jumlah sesi yang disetujui

declined_count
integer

Jumlah sesi yang ditolak

in_review_count
integer

Jumlah sesi dalam peninjauan

features
object

Status per-fitur agregat di semua sesi KYB bisnis ini. Saat ini satu-satunya kunci adalah KYB (status pemeriksaan perusahaan di registri). Nilai yang memungkinkan: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Data yang sama dengan features, sebagai array berurutan dari objek {feature, status}.

last_session_at
string<date-time> | null

Cap waktu sesi terbaru

first_session_at
string<date-time> | null

Cap waktu sesi pertama

last_activity_at
string<date-time> | null

Cap waktu aktivitas terbaru (perubahan status, pembaruan sesi, dll.)

tags
object[]

Tag yang ditetapkan untuk bisnis ini

created_at
string<date-time>
metadata
object

JSON metadata kustom yang Anda lampirkan ke bisnis ini. Default adalah {}.

updated_at
string<date-time>
Terakhir diubah pada 7 November 2026