> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Vendor Data Linking: Hubungkan ID ke Entitas

> Identifier vendor_data menghubungkan sistem Anda ke Didit, mengikat sesi, transaksi, dan entitas User/Business menjadi satu profil. Bayar per panggilan.

Prompt Penautan Vendor Data
Salin prompt ke papan klip

<pre>
  \`\`\`\`# Goal — link every session, transaction, and entity together using `vendor_data`

  `vendor_data` is the string identifier you choose and pass on every API call to bind it to a persistent [User](https://docs.didit.me/entities/users/overview.md) or [Business](https://docs.didit.me/entities/businesses/overview.md) entity. Get this right once and you never have to re-key history afterwards.

  ## Rules

  * `vendor_data` is **opaque** to Didit. Use your stable internal customer id.
  * Choose one canonical id per entity and never change it. Changing it orphans history under a new entity.
  * Prefix by entity type when convenient (`user_...`, `biz_...`) to avoid collisions in your own code.
  * Keep it under 128 chars, case-sensitive stable. Hard limit is 2000 bytes (UTF-8 encoded) - anything over that is rejected with a 400 rather than accepted.
  * **Never put raw PII in it** — it surfaces in webhooks, logs, and API responses.
  * Uniqueness is per application × entity type. User `user-42` and Business `user-42` are different entities (but don't do this).

  ## Where it goes

  | API | Field |
  | - | - |
  | `POST /v3/session/` | top-level `vendor_data` (KYC and KYB) |
  | `POST /v3/transactions/` | top-level `vendor_data` and `applicant.vendor_data` / `counterparty.vendor_data` |
  | `POST /v3/users/create/` / `POST /v3/businesses/create/` | `vendor_data` |
  | `GET /v3/sessions?vendor_data=...` | query param to retrieve history |
  | `GET /v3/users/{vendor_data}/` / `GET /v3/businesses/{vendor_data}/` | path param |

  ## Pattern — pre-create the entity, then run a session

  ```bash
  # 1) Seed the entity with metadata before any session
  curl -X POST https://verification.didit.me/v3/users/create/ \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "vendor_data": "user-42",
  "display_name": "Jane Doe",
  "metadata": {"tier": "premium", "signup_date": "2026-04-01"}
  }'

  # 2) Run a KYC session linked to the same entity
  curl -X POST https://verification.didit.me/v3/session/ \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "workflow_id": "$WORKFLOW_ID",
  "vendor_data": "user-42",
  "callback": "https://myapp.com/return"
  }'

  # 3) Later, retrieve every session for the entity
  curl -G https://verification.didit.me/v3/sessions/ \
  -H "x-api-key: $DIDIT_API_KEY" \
  --data-urlencode "vendor_data=user-42"
  ```

  ## Auto-create semantics

  If you create a session with a new `vendor_data` and no entity exists, Didit creates the entity automatically with `status: ACTIVE` and links the session.

  ## Failure modes

  * Missing `vendor_data` on session create → session is orphaned, won't appear in any entity profile, cannot be filtered by `vendor_data` later (only by `session_id`).
  * Different case (`User-42` vs `user-42`) → two separate entities. Pick a casing convention and stick to it.
  * Same `vendor_data` across staging and prod apps → no collision; `vendor_data` is scoped per application.

  ## Sources of truth

  * /entities/users/operations — full User CRUD
  * /entities/businesses/operations — full Business CRUD
  * /sessions-api/create-session — session body shape
  * /integration/integration-prompt — canonical end-to-end prompt\`\`\`\`
</pre>

Tempel ke

`vendor_data` adalah pengenal yang Anda berikan pada setiap sesi dan transaksi untuk menautkannya ke entitas [Pengguna](https://docs.didit.me/id/entities/users/overview.md) atau [Bisnis](https://docs.didit.me/id/entities/businesses/overview.md). Ini adalah kolom terpenting untuk agregasi entitas. Jika diisi dengan benar, setiap fitur lanjutan (riwayat profil, pemantauan transaksi, penegakan daftar blokir, dan AML berkelanjutan) akan berfungsi dengan lancar.

## Apa itu

`vendor_data` adalah **string** yang Anda pilih sendiri. Didit memperlakukannya sebagai pengenal opak dan tidak menafsirkan isinya. Contoh nilai yang umum:

| Sistem Anda | Contoh nilai `vendor_data` yang baik |
| - | - |
| Database pengguna internal | `user_1234`, `uuid-v4` milik pengguna |
| ID yang terlihat oleh pelanggan | `CUST-2026-00042`, hash dari email |
| SaaS multi-tenant | `tenant_acme:user_1234` |
| Platform B2B | `company-hq-global`, `tax-id-US-123456789` |

> [!WARNING]
>
> Jangan **pernah** memasukkan PII (email, nomor telepon, ID pajak mentah) langsung ke `vendor_data`. Lakukan hash atau beri awalan pada data tersebut. `vendor_data` muncul di payload webhook dan disimpan tanpa batas waktu selama entitas masih ada.

## Cara mengikat semuanya

```mermaid theme={null}
flowchart TD
    subgraph YourSystem["Your system"]
      Customer["Customer record: user-42"]
    end
    subgraph Didit["Didit platform"]
      Entity["User entity (vendor_data = user-42)"]
      S1[Session #1]
      S2[Session #2]
      T1[Transaction #1]
      T2[Transaction #2]
      F[Face biometric]
    end
    Customer -.vendor_data.-> Entity
    S1 --> Entity
    S2 --> Entity
    T1 --> Entity
    T2 --> Entity
    F --> Entity
```

Ketika Anda mengirim sesi atau transaksi dengan nilai `vendor_data`:

1. Didit mencari entitas di aplikasi Anda dengan `vendor_data` tersebut.
2. Jika entitas itu ada, objek baru ditautkan ke entitas tersebut.
3. Jika entitas itu tidak ada, Didit membuat entitas (dengan `status: ACTIVE`) dan menautkan objek baru.

Hal ini berlaku untuk:

* `POST /v3/session/`: sesi KYC dan Verifikasi Bisnis (KYB)
* `POST /v3/transactions/`: transaksi (untuk pemohon dan pihak lawan)
* Kolom `applicant.vendor_data` / `counterparty.vendor_data` di dalam payload transaksi

## Keunikan dan cakupan

`vendor_data` **unik per aplikasi**, bukan secara global di seluruh Didit:

| Cakupan | Jaminan keunikan |
| - | - |
| Dalam satu aplikasi | `vendor_data` unik per jenis entitas (Pengguna dan Bisnis adalah ruang nama terpisah) |
| Lintas aplikasi dalam organisasi Anda | `vendor_data` **tidak** dibagikan. Nilai yang sama di dua aplikasi merujuk pada dua entitas yang berbeda |
| Lintas organisasi | Tidak dibagikan. Setiap organisasi memiliki tabel entitasnya sendiri |

Artinya, Anda dapat menggunakan `vendor_data` yang sama di aplikasi staging dan aplikasi produksi tanpa konflik. Anda juga dapat memiliki Pengguna `user-42` dan Bisnis `user-42` tanpa konflik, meskipun hal ini tidak disarankan demi kejelasan.

## Apa yang terjadi jika Anda tidak menyertakan `vendor_data`

Anda dapat membuat sesi tanpa `vendor_data`. Dalam kasus itu:

* Tidak ada entitas yang dibuat untuk sesi tersebut.
* Sesi menjadi tidak tertaut ke entitas mana pun. Sesi tidak akan muncul di profil Pengguna atau Bisnis mana pun.
* Anda tidak dapat mencari sesi berdasarkan `vendor_data` di kemudian hari. Pencarian hanya dapat dilakukan berdasarkan `session_id`.

Gunakan pola ini hanya untuk verifikasi anonim atau sekali pakai yang tidak memerlukan agregasi entitas. Untuk setiap integrasi yang melibatkan verifikasi ulang, transaksi, atau pemantauan berkelanjutan, selalu sertakan `vendor_data`.

## Contoh: buat entitas terlebih dahulu, lalu jalankan sesi

```bash theme={null}
# 1. Pre-create the User with initial metadata
curl -X POST https://verification.didit.me/v3/users/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "user-42",
    "display_name": "Jane Doe",
    "metadata": { "tier": "premium", "signup_date": "2026-04-01" }
  }'

# 2. Create a User Verification (KYC) session for the same user
curl -X POST https://verification.didit.me/v3/session/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "wf_kyc_standard",
    "vendor_data": "user-42"
  }'

# 3. Later, submit a transaction tied to the same user
curl -X POST https://verification.didit.me/v3/transactions/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "txn_id": "tx-0001",
    "direction": "OUTBOUND",
    "amount": "500.00",
    "currency": "EUR",
    "applicant": { "vendor_data": "user-42" },
    "counterparty": { "name": "Acme Corp" }
  }'
```

Ketiga panggilan tersebut ditautkan ke entitas Pengguna yang sama. Saat nanti Anda memanggil `GET /v3/users/user-42/`, Anda akan melihat jumlah sesi, penghitung persetujuan dan penolakan, transaksi yang ditautkan, serta data profil terbaru.

## Memigrasikan ID eksternal

Jika Anda beralih ke Didit setelah menggunakan vendor KYC lain, teruskan ID pengguna stabil yang sudah ada sebagai `vendor_data` sejak hari pertama. Cara ini memudahkan Anda untuk:

* Mencocokkan data Didit dengan database internal Anda.
* Memuat massal pengguna historis melalui impor CSV di konsol sebelum menjalankan sesi apa pun.
* Mempertahankan relasi saat Anda kemudian bermigrasi ke Didit untuk pemantauan transaksi.

## Aturan, konvensi, dan praktik terbaik

| Aturan | Alasan |
| - | - |
| Pilih satu pengenal kanonik per entitas dan jangan pernah mengubahnya | Perubahan akan membuat entitas baru dan membuat riwayat menjadi terisolasi |
| Beri awalan pada nilai `vendor_data` sesuai jenis entitas (`user_...`, `biz_...`) | Mencegah konflik yang tidak disengaja antar-ruang nama dalam kode Anda sendiri |
| Jaga agar `vendor_data` peka huruf besar-kecil dan tetap stabil | Didit tidak menormalkan huruf besar-kecil |
| Jaga panjang `vendor_data` di bawah 128 karakter | Cocok untuk indeks database |
| Jangan pernah menampilkan PII mentah | `vendor_data` muncul di webhook, log audit, dan respons API |

## Langkah selanjutnya

> [card] [Ikhtisar Pengguna](https://docs.didit.me/id/entities/users/overview.md)
>
> Pembahasan mendalam tentang entitas Pengguna dan operasinya.

> [card] [Ikhtisar Bisnis](https://docs.didit.me/id/entities/businesses/overview.md)
>
> Pembahasan mendalam tentang entitas Bisnis dan operasinya.

> [card] [Buat sesi](https://docs.didit.me/id/sessions-api/create-session.md)
>
> Mulai verifikasi untuk sebuah vendor\_data.

> [card] [Buat transaksi](https://docs.didit.me/id/management-api/transactions/create.md)
>
> Kirim transaksi yang ditautkan ke entitas.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.