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

# Editar rascunho de parte KYB via API

> Altere os campos de um único rascunho de pessoa-chave em uma sessão KYB da Didit; a parte mesclada é validada como um todo.



## OpenAPI

````yaml pt-br/openapi-25.json PATCH /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/:
    patch:
      tags:
        - Sessions
      summary: Editar o rascunho de uma parte KYB
      description: >-
        Altera campos do rascunho de uma parte. A edição é mesclada ao rascunho
        armazenado e a parte resultante é validada como um todo, então uma
        edição que deixaria a parte incompleta é rejeitada. Alterar `first_name`
        ou `last_name` substitui o nome completo armazenado. Requer
        `write:businesses`.
      operationId: patch_v3_session_kyb_party_draft
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            UUID da sessão de Verificação de empresas (KYB). Ela deve pertencer
            à aplicação da chave de API.
          schema:
            type: string
            format: uuid
            example: 33333333-4444-5555-6666-777777777777
        - name: draftId
          in: path
          required: true
          description: >-
            UUID do rascunho da parte (`draft_id` retornado quando ele foi
            criado).
          schema:
            type: string
            format: uuid
            example: 5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d
        - name: node_id
          in: query
          required: false
          description: >-
            Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem
            mais de um nó de KYB; por padrão, a Didit usa o próprio nó da
            sessão.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Qualquer subconjunto dos campos da parte. A edição é mesclada ao
                rascunho armazenado e a parte resultante é validada como um
                todo, de modo que um rascunho que podia ser enviado antes de uma
                edição continua podendo ser enviado depois dela.
              properties:
                entity_type:
                  type: string
                  enum:
                    - person
                    - company
                  description: Se a parte é uma pessoa física ou uma empresa.
                full_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Nome completo de uma pessoa. Envie este campo ou
                    `first_name` e `last_name`.
                first_name:
                  type: string
                  maxLength: 128
                last_name:
                  type: string
                  maxLength: 128
                role:
                  type: string
                  enum:
                    - director
                    - non_executive_director
                    - secretary
                    - chairman
                    - ubo
                    - shareholder
                    - representative
                    - founder
                    - legal_advisor
                    - authorized_signatory
                    - trustee
                    - beneficiary
                    - settlor
                    - protector
                    - company_officer
                    - investor
                    - other
                  description: >-
                    Função exercida pela parte. Intercambiável com `roles`;
                    quando ambos são enviados, eles são mesclados.
                roles:
                  type: array
                  items:
                    type: string
                    enum:
                      - director
                      - non_executive_director
                      - secretary
                      - chairman
                      - ubo
                      - shareholder
                      - representative
                      - founder
                      - legal_advisor
                      - authorized_signatory
                      - trustee
                      - beneficiary
                      - settlor
                      - protector
                      - company_officer
                      - investor
                      - other
                  description: >-
                    Todas as funções que a parte exerce. Uma pessoa precisa de
                    pelo menos uma função (aqui ou em `role`).
                position:
                  type: string
                  maxLength: 128
                  description: Cargo de uma pessoa.
                date_of_birth:
                  type: string
                  format: date
                  nullable: true
                company_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Nome de uma parte do tipo empresa. Obrigatório quando
                    `entity_type` é `company`.
                registration_number:
                  type: string
                  maxLength: 100
                  description: Número de registro de uma parte que é empresa.
                email:
                  type: string
                  format: email
                  description: >-
                    Para onde o link de verificação é enviado. Obrigatório
                    quando a parte precisa concluir a verificação, o que depende
                    das configurações de função e dos limiares de propriedade do
                    fluxo de verificação (workflow).
                ownership_percent:
                  type: number
                  nullable: true
                  description: Participação na empresa detida pela parte.
                nationality:
                  type: string
                  maxLength: 100
                  description: >-
                    Nacionalidade de uma pessoa ou país de constituição de uma
                    empresa. Obrigatório para todas as partes.
                phone_number:
                  type: string
                  maxLength: 32
                custom_fields:
                  type: object
                  additionalProperties: true
                  description: Campos extras definidos pelo fluxo.
                skip_verification:
                  type: boolean
                  default: false
                  description: >-
                    Solicite que a verificação desta parte seja pulada. Atendido
                    apenas quando a função da parte permite pular a verificação
                    nas configurações de Pessoas-chave do fluxo.
            example:
              ownership_percent: 55
      responses:
        '200':
          description: Rascunho atualizado.
          content:
            application/json:
              schema:
                type: object
                required:
                  - draft_id
                  - created_at
                  - updated_at
                  - party
                properties:
                  draft_id:
                    type: string
                    format: uuid
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  party:
                    type: object
                    required:
                      - entity_type
                      - nationality
                    properties:
                      entity_type:
                        type: string
                        enum:
                          - person
                          - company
                        description: Se a parte é uma pessoa física ou uma empresa.
                      full_name:
                        type: string
                        maxLength: 255
                        description: >-
                          Nome completo de uma pessoa. Envie este campo ou
                          `first_name` e `last_name`.
                      first_name:
                        type: string
                        maxLength: 128
                      last_name:
                        type: string
                        maxLength: 128
                      role:
                        type: string
                        enum:
                          - director
                          - non_executive_director
                          - secretary
                          - chairman
                          - ubo
                          - shareholder
                          - representative
                          - founder
                          - legal_advisor
                          - authorized_signatory
                          - trustee
                          - beneficiary
                          - settlor
                          - protector
                          - company_officer
                          - investor
                          - other
                        description: >-
                          Função exercida pela parte. Intercambiável com
                          `roles`; quando ambos são enviados, eles são
                          mesclados.
                      roles:
                        type: array
                        items:
                          type: string
                          enum:
                            - director
                            - non_executive_director
                            - secretary
                            - chairman
                            - ubo
                            - shareholder
                            - representative
                            - founder
                            - legal_advisor
                            - authorized_signatory
                            - trustee
                            - beneficiary
                            - settlor
                            - protector
                            - company_officer
                            - investor
                            - other
                        description: >-
                          Todas as funções que a parte exerce. Uma pessoa
                          precisa de pelo menos uma função (aqui ou em `role`).
                      position:
                        type: string
                        maxLength: 128
                        description: Cargo de uma pessoa.
                      date_of_birth:
                        type: string
                        format: date
                        nullable: true
                      company_name:
                        type: string
                        maxLength: 255
                        description: >-
                          Nome de uma parte do tipo empresa. Obrigatório quando
                          `entity_type` é `company`.
                      registration_number:
                        type: string
                        maxLength: 100
                        description: Número de registro de uma parte que é empresa.
                      email:
                        type: string
                        format: email
                        description: >-
                          Para onde o link de verificação é enviado. Obrigatório
                          quando a parte precisa concluir a verificação, o que
                          depende das configurações de função e dos limiares de
                          propriedade do fluxo de verificação (workflow).
                      ownership_percent:
                        type: number
                        nullable: true
                        description: Participação na empresa detida pela parte.
                      nationality:
                        type: string
                        maxLength: 100
                        description: >-
                          Nacionalidade de uma pessoa ou país de constituição de
                          uma empresa. Obrigatório para todas as partes.
                      phone_number:
                        type: string
                        maxLength: 32
                      custom_fields:
                        type: object
                        additionalProperties: true
                        description: Campos extras definidos pelo fluxo.
                      skip_verification:
                        type: boolean
                        default: false
                        description: >-
                          Solicite que a verificação desta parte seja pulada.
                          Atendido apenas quando a função da parte permite pular
                          a verificação nas configurações de Pessoas-chave do
                          fluxo.
              example:
                draft_id: 5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d
                created_at: '2026-10-31T10:00:00Z'
                updated_at: '2026-10-31T10:00:00Z'
                party:
                  entity_type: person
                  first_name: Ana
                  last_name: Lopez
                  roles:
                    - ubo
                    - director
                  ownership_percent: 55
                  nationality: MEX
                  email: ana.lopez@example.com
                  date_of_birth: '1984-06-12'
        '400':
          description: A parte mesclada é inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              example:
                non_field_errors:
                  - Person parties require at least one role.
        '401':
          description: >-
            A chave de API com escopo expirou. Este é o único caso que retorna
            `401`: uma chave ausente, inválida ou revogada retorna `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Expired key:
                  summary: A data de validade da chave já passou
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falha de autenticação ou autorização. Uma chave ausente retorna
            `403`, assim como uma chave de outra aplicação, uma chave com escopo
            sem a permissão exigida por este endpoint e uma requisição de fora
            da lista de IPs permitidos da chave; uma chave incorreta, revogada
            ou expirada retorna `401`. Diferencie-as pelo `detail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Missing or invalid credentials:
                  summary: Cabeçalho x-api-key ausente, ou a chave falhou na validação
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Other application:
                  summary: >-
                    Uma chave válida que pertence a uma aplicação diferente da
                    aplicação da sessão
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without decisions write:
                  summary: 'Chave com escopo sem decisions: write'
                  value:
                    detail: This API key has no write access to decisions.
                IP not allowed:
                  summary: Requisição de fora da lista de IPs permitidos da chave
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            A sessão ou o rascunho não existe, ou a sessão está fora da
            aplicação da chave ou dos limites de uma chave com escopo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              example:
                detail: Session not found.
        '409':
          description: A sessão foi finalizada (`kyb_session_not_writable`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
                  code:
                    type: string
              example:
                detail: This verification session is no longer accepting changes.
                code: kyb_session_not_writable
        '429':
          description: >-
            Limite de requisições excedido: 300 requisições de escrita (POST,
            PATCH, DELETE) por minuto por chave de API. Aguarde `Retry-After`
            segundos antes de tentar novamente; os cabeçalhos `X-RateLimit-*`
            mostram a cota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Rate limited:
                  summary: Orçamento do minuto atual esgotado
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
          headers:
            Retry-After:
              description: Segundos de espera antes de tentar novamente.
              schema:
                type: integer
                minimum: 1
                example: 30
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.sessions.update_kyb_party_draft(
                "33333333-4444-5555-6666-777777777777",
                "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d",
                ownership_percent=55.0,
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.sessions.updateKybPartyDraft(
              "33333333-4444-5555-6666-777777777777",
              "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d",
              {
                ownership_percent: 55.0,
              },
            );
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateKYBPartyDraft(ctx, \"33333333-4444-5555-6666-777777777777\", \"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d\", didit.SessionsUpdateKYBPartyDraftParams{\n\tOwnershipPercent: didit.Float(55.0),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.SessionsUpdateKybPartyDraftParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.sessions().updateKybPartyDraft("33333333-4444-5555-6666-777777777777",
            "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d",
            SessionsUpdateKybPartyDraftParams.builder()
                    .ownershipPercent(55.0)
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->sessions->updateKybPartyDraft('33333333-4444-5555-6666-777777777777',
            '5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d', [
                'ownership_percent' => 55.0,
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.sessions.update_kyb_party_draft(
              "33333333-4444-5555-6666-777777777777",
              "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d",
              ownership_percent: 55.0
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Sessions.UpdateKybPartyDraftAsync("33333333-4444-5555-6666-777777777777",
            "5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d", new
            SessionsUpdateKybPartyDraftParams

            {
                OwnershipPercent = 55.0,
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
        a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
        uma data de validade. 401 significa que a chave está errada, revogada ou
        expirada; 403 significa que nenhuma chave foi enviada, que a chave não
        tem acesso a este recurso ou ação, ou que a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

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