> ## 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. # API para enviar documentos KYB > Envie documentos corporativos a uma sessão de verificação de empresa do Didit pelo seu servidor, com OCR e verificações do fluxo hospedado. ## OpenAPI ````yaml pt-br/openapi-25.json POST /v3/session/{sessionId}/kyb/documents/ 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/documents/: post: tags: - Sessions summary: Enviar documentos KYB para uma sessão description: >- Envie um ou mais documentos societários (contrato social, livro de registro de acionistas, certidão de constituição, ...) para a etapa KYB Documents de uma sessão de Verificação de empresas, a partir do seu próprio servidor em vez da página hospedada. A Didit executa o mesmo pipeline da página hospedada: compressão, OCR, verificações de adulteração e entre documentos, agrupamento de documentos, e avança a sessão quando os grupos de documentos exigidos são atendidos. A etapa tem uma tarifa fixa única, independentemente de quantos arquivos você enviar. A sessão deve estar aberta e na etapa KYB Documents, e a empresa escolhida na etapa de registro deve existir. Consulte as pessoas mencionadas nos documentos com `GET /v3/session/{sessionId}/kyb/extracted-parties/`. Requer `write:businesses`. operationId: post_v3_session_kyb_documents 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: 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: multipart/form-data: schema: type: object required: - documents properties: documents: type: array items: type: string format: binary description: >- Arquivos a enviar: JPG, JPEG, PNG, TIFF, WEBP, PDF ou arquivos ZIP contendo esses formatos. PDFs de até 50 MB, fotos de até 6 MB antes da compressão. document_passwords: type: array items: type: string description: >- Uma entrada por arquivo em `documents`, na mesma ordem: a senha de um PDF protegido, vazia para qualquer outro arquivo. document_group: type: string enum: - LEGAL_PRESENCE - COMPANY_DETAILS - OWNERSHIP_STRUCTURE - REPRESENTATIVES_AUTHORIZATION description: Grupo de documentos obrigatório ao qual este envio responde. locale: type: string maxLength: 10 description: Localidade usada para traduzir a resposta da próxima etapa. responses: '200': description: >- Documentos processados. Quando todos os grupos obrigatórios são atendidos, a sessão avança e `next_step` indica a próxima etapa; caso contrário, ela permanece na etapa Documentos e `document_groups` e `document_answer` informam o que ainda falta. content: application/json: schema: type: object properties: valid: type: boolean next_step: type: string nullable: true description: Etapa em que a sessão está após o upload. kyb_status: type: string description: Status da verificação da empresa. document_answer: type: object additionalProperties: true description: Resultado por documento enviado e os envios restantes. additionalProperties: true example: valid: true next_step: KYB_KEY_PEOPLE kyb_status: In Progress '400': description: >- Um documento foi rejeitado (adulterado, ilegível ou não suportado) ou a sessão ainda não tem uma empresa de KYB. Tente novamente com outro arquivo enquanto houver tentativas restantes. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. example: message: No KYB company found. Submit company data first. '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. '402': description: A organização não tem mais crédito para a etapa de documentos. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. example: detail: Insufficient credits. '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 não existe, foi excluída, pertence a outra aplicação ou está fora dos limites de uma chave com escopo; nenhum detalhe diferencia esses casos. 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`) ou não está na etapa KYB Documents (`kyb_step_mismatch`, com `next_step` indicando a etapa em que ela está). content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. code: type: string next_step: type: string example: detail: The session is not on the step this operation completes. code: kyb_step_mismatch next_step: KYB_REGISTRY '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.upload_kyb_documents( "33333333-4444-5555-6666-777777777777", documents=[open("document.pdf", "rb")], ) print(result) - lang: javascript label: Node.js source: >- import Didit, { fileFromPath } from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.sessions.uploadKybDocuments("33333333-4444-5555-6666-777777777777", { documents: [await fileFromPath("document.pdf")], }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UploadKYBDocuments(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsUploadKYBDocumentsParams{\n\tDocuments: []didit.File{didit.FileFromPath(\"document.pdf\")},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.nio.file.Path; import java.util.List; import me.didit.Didit; import me.didit.types.SessionsUploadKybDocumentsParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.sessions().uploadKybDocuments("33333333-4444-5555-6666-777777777777", SessionsUploadKybDocumentsParams.builder() .documents(List.of(Path.of("document.pdf"))) .build()); System.out.println(result); - lang: php label: PHP source: >- sessions->uploadKybDocuments('33333333-4444-5555-6666-777777777777', [ 'documents' => [File::fromPath('document.pdf')], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.sessions.upload_kyb_documents( "33333333-4444-5555-6666-777777777777", documents: [Pathname("document.pdf")] ) 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.UploadKybDocumentsAsync("33333333-4444-5555-6666-777777777777", new SessionsUploadKybDocumentsParams { Documents = new FileUpload[] { FileUpload.FromPath("document.pdf") }, }); 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.