> ## 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.

# Ligação de vendor_data: associar IDs a entidades

> O vendor_data liga o seu sistema à Didit, unindo sessões, transações e entidades num único perfil. Pagamento por chamada.

Prompt de ligação de vendor\_data
Copiar o prompt para a área de transferência

<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>

Colar em

`vendor_data` é o identificador que fornece em cada sessão e transação para as ligar a uma entidade [Utilizador](https://docs.didit.me/pt/entities/users/overview.md) ou [Empresa](https://docs.didit.me/pt/entities/businesses/overview.md). É o campo mais importante para a agregação de entidades: se estiver correto, todas as funcionalidades a jusante (histórico do perfil, monitorização de transações, aplicação de listas de bloqueio, monitorização AML contínua) funcionam sem falhas.

## O que é

`vendor_data` é uma **string** que escolhe. A Didit trata-o como um identificador opaco e não interpreta o seu conteúdo. Valores típicos:

| O seu sistema | Bons valores de `vendor_data` |
| - | - |
| Base de dados interna de utilizadores | `user_1234`, `uuid-v4` do utilizador |
| ID voltado para o cliente | `CUST-2026-00042`, e-mail com hash |
| SaaS multi-inquilino | `tenant_acme:user_1234` |
| Plataforma B2B | `company-hq-global`, `tax-id-US-123456789` |

> [!WARNING]
>
> **Não** coloque dados pessoais (e-mails, números de telefone, números de identificação fiscal em bruto) diretamente em `vendor_data`. Aplique-lhes hash ou adicione-lhes um prefixo. O `vendor_data` aparece nos payloads dos webhooks e fica armazenado indefinidamente enquanto a entidade existir.

## Como liga as coisas entre si

```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
```

Quando submete uma sessão ou transação com um valor de `vendor_data`:

1. A Didit procura na sua aplicação a entidade com esse `vendor_data`.
2. Se existir, o novo objeto fica ligado a essa entidade.
3. Se não existir, a Didit cria a entidade (com `status: ACTIVE`) e liga o novo objeto.

Isto aplica-se a:

* `POST /v3/session/` — sessões de KYC e de verificação de empresas (KYB)
* `POST /v3/transactions/` — transações (para o requerente e para a contraparte)
* Os campos `applicant.vendor_data` / `counterparty.vendor_data` dentro dos payloads de transação

## Unicidade e âmbito

`vendor_data` é **único por aplicação**, e não globalmente na Didit:

| Âmbito | Garantia de unicidade |
| - | - |
| Dentro de uma aplicação | `vendor_data` é único por tipo de entidade (Utilizador e Empresa são espaços de nomes separados) |
| Entre aplicações da sua organização | `vendor_data` **não** é partilhado: o mesmo valor em duas aplicações refere-se a duas entidades diferentes |
| Entre organizações | Não é partilhado: cada organização tem as suas próprias tabelas de entidades |

Isto significa que pode usar o mesmo `vendor_data` numa aplicação de testes e numa aplicação de produção sem colisões, e pode ter um Utilizador `user-42` e uma Empresa `user-42` sem colisão (embora isso seja desaconselhado por clareza).

## O que acontece se omitir `vendor_data`

Pode criar uma sessão sem `vendor_data`. Nesse caso:

* Não é criada nenhuma entidade para a sessão.
* A sessão fica órfã: não aparece no perfil de nenhum Utilizador ou Empresa.
* Não é possível procurar a sessão mais tarde por `vendor_data`, apenas por `session_id`.

Use este padrão apenas para verificações anónimas ou pontuais em que não seja necessária agregação de entidades. Em qualquer integração que envolva reverificação, transações ou monitorização contínua, forneça sempre `vendor_data`.

## Exemplo: pré-criar uma entidade e depois executar sessões

```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" }
  }'
```

As três chamadas ficam ligadas à mesma entidade Utilizador. Quando depois fizer `GET /v3/users/user-42/`, verá a contagem de sessões, os contadores de aprovações e recusas, as transações ligadas e os dados de perfil mais recentes.

## Migrar IDs externos

Se estiver a adotar a Didit depois de um fornecedor de KYC existente, passe os seus IDs de utilizador estáveis como `vendor_data` desde o primeiro dia. Isto facilita:

* Reconciliar os dados da Didit com a sua base de dados interna.
* Carregar em massa utilizadores históricos através da importação por CSV na consola, antes de executar quaisquer sessões.
* Preservar as relações quando mais tarde migrar para a Didit para monitorização de transações.

## Regras, convenções e boas práticas

| Regra | Motivo |
| - | - |
| Escolha um identificador canónico por entidade e nunca o altere | As alterações criam uma nova entidade e deixam o histórico órfão |
| Prefixe os valores de `vendor_data` pelo tipo de entidade (`user_...`, `biz_...`) | Evita colisões acidentais entre espaços de nomes no seu próprio código |
| Mantenha o `vendor_data` estável e sensível a maiúsculas e minúsculas | A Didit não normaliza maiúsculas e minúsculas |
| Mantenha os valores de `vendor_data` com menos de 128 caracteres | Cabem confortavelmente nos índices da base de dados |
| Nunca exponha dados pessoais em bruto | O `vendor_data` aparece em webhooks, registos de auditoria e respostas da API |

## Próximos passos

> [card] [Visão geral dos utilizadores](https://docs.didit.me/pt/entities/users/overview.md)
>
> Análise detalhada das entidades Utilizador e das suas operações.

> [card] [Visão geral das empresas](https://docs.didit.me/pt/entities/businesses/overview.md)
>
> Análise detalhada das entidades Empresa e das suas operações.

> [card] [Criar sessão](https://docs.didit.me/pt/sessions-api/create-session.md)
>
> Inicie uma verificação para um vendor\_data.

> [card] [Criar transação](https://docs.didit.me/pt/management-api/transactions/create.md)
>
> Submeta uma transação ligada a uma entidade.


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