> ## 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. # Carregar documentos KYB através da API > Carregue documentos societários numa sessão de Verificação de empresas a partir do seu servidor, com o OCR e as verificações da Didit. ## OpenAPI ````yaml pt/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: Carregar documentos de KYB para uma sessão description: >- Carregue um ou mais documentos societários (estatutos sociais, registo de acionistas, certidão de constituição, ...) para o passo KYB Documents de uma sessão de Verificação de empresas, a partir do seu próprio servidor em vez da página alojada. A Didit executa o pipeline alojado: 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 obrigatórios são cumpridos. O passo custa uma taxa fixa única, independentemente de quantos ficheiros enviar. A sessão tem de estar aberta e no passo KYB Documents, e a empresa escolhida no passo do registo tem de 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). Tem de 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 do passo de KYB. Apenas necessário quando o fluxo tem mais de um nó de KYB; por predefinição, a Didit utiliza o nó próprio 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: >- Ficheiros a carregar: JPG, JPEG, PNG, TIFF, WEBP, PDF ou ficheiros ZIP que os contenham. Ficheiros PDF até 50 MB, fotos até 6 MB antes da compressão. document_passwords: type: array items: type: string description: >- Uma entrada por ficheiro em `documents`, na mesma ordem: a palavra-passe de um PDF protegido, vazia para qualquer outro ficheiro. document_group: type: string enum: - LEGAL_PRESENCE - COMPANY_DETAILS - OWNERSHIP_STRUCTURE - REPRESENTATIVES_AUTHORIZATION description: >- Grupo de documentos obrigatório ao qual este carregamento responde. locale: type: string maxLength: 10 description: >- Localidade utilizada para traduzir a resposta do próximo passo. responses: '200': description: >- Documentos processados. Quando todos os grupos obrigatórios são cumpridos, a sessão avança e `next_step` indica o passo seguinte; caso contrário, permanece no passo Documentos e `document_groups` e `document_answer` indicam o que ainda está em falta. content: application/json: schema: type: object properties: valid: type: boolean next_step: type: string nullable: true description: Passo em que a sessão se encontra após o carregamento. kyb_status: type: string description: Estado da verificação da empresa. document_answer: type: object additionalProperties: true description: >- Resultado por documento carregado e os carregamentos restantes. additionalProperties: true example: valid: true next_step: KYB_KEY_PEOPLE kyb_status: In Progress '400': description: >- Um documento foi rejeitado (adulteração, ilegível ou não suportado) ou a sessão ainda não tem uma empresa de KYB associada. Tente novamente com outro ficheiro enquanto restarem tentativas. 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 âmbito expirou. Este é o único caso que devolve `401`: uma chave em falta, inválida ou revogada devolve `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 já não tem crédito para o passo 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 em falta devolve `403`, assim como uma chave de outra aplicação, uma chave com âmbito restrito sem a permissão que este endpoint requer e um pedido proveniente de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada devolve `401`. Distinga-as através de `detail`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Missing or invalid credentials: summary: Sem cabeçalho x-api-key ou a chave falhou a 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 sessão value: detail: You do not have permission to perform this action. Scoped key without decisions write: summary: 'Chave com âmbito não tem decisions: write' value: detail: This API key has no write access to decisions. IP not allowed: summary: >- Pedido proveniente de fora da lista de permissões de IP da chave value: detail: This API key can't be used from this IP address. '404': description: >- A sessão não existe, foi eliminada, pertence a outra aplicação ou está fora dos limites de uma chave com âmbito restrito; nenhum detalhe os distingue. 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 está finalizada (`kyb_session_not_writable`) ou não está no passo KYB Documents (`kyb_step_mismatch`, com `next_step` a indicar o passo em que se encontra). 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 pedidos excedido: 300 pedidos 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 o orçamento. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Rate limited: summary: Orçamento esgotado para o minuto atual value: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. headers: Retry-After: description: Segundos a aguardar antes de tentar novamente. schema: type: integer minimum: 1 example: 30 '503': $ref: '#/components/responses/DocumentProcessingBusy' 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: responses: DocumentProcessingBusy: description: >- Estão a ser processados demasiados documentos neste momento, pelo que este carregamento não foi processado: nada foi armazenado e nenhuma tentativa foi utilizada. Envie o mesmo ficheiro novamente após o número de segundos em `Retry-After`. Ramifique com base no `code`, não no texto da mensagem. headers: Retry-After: description: Segundos a aguardar antes de enviar o mesmo pedido novamente. schema: type: integer example: 10 content: application/json: schema: type: object required: - detail - code properties: detail: type: string code: type: string enum: - document_processing_busy example: detail: We are busy processing documents. Please try again in a moment. code: document_processing_busy securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.