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

# Enviar documentos da empresa

> Envia os documentos de verificação da empresa autenticada — cartão CNPJ, contrato social, comprovante de endereço e comprovante de conta bancária — cada um em base64. É o que destrava a conta quando `GET /v1/subaccount-status` acusa documento pendente. Reenviar um documento substitui o anterior; os campos omitidos ficam como estão. A resposta traz os quatro depois da gravação.



## OpenAPI

````yaml /openapi.yaml put /v1/company/documents
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/company/documents:
    put:
      tags:
        - Plataforma
      summary: Enviar documentos da empresa
      description: >-
        Envia os documentos de verificação da empresa autenticada — cartão CNPJ,
        contrato social, comprovante de endereço e comprovante de conta bancária
        — cada um em base64. É o que destrava a conta quando `GET
        /v1/subaccount-status` acusa documento pendente. Reenviar um documento
        substitui o anterior; os campos omitidos ficam como estão. A resposta
        traz os quatro depois da gravação.
      operationId: uploadCompanyDocuments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                documentUrl:
                  type: string
                  pattern: >-
                    ^data:(application\/pdf|image\/jpeg|image\/jpg|image\/png|image\/webp);base64,[A-Za-z0-9+/=\s]+$
                  description: >-
                    documentUrl em base64, como
                    `data:application/pdf;base64,...`. Até 5 MB.
                companyConstitution:
                  type: string
                  pattern: >-
                    ^data:(application\/pdf|image\/jpeg|image\/jpg|image\/png|image\/webp);base64,[A-Za-z0-9+/=\s]+$
                  description: >-
                    companyConstitution em base64, como
                    `data:application/pdf;base64,...`. Até 5 MB.
                proofOfAddress:
                  type: string
                  pattern: >-
                    ^data:(application\/pdf|image\/jpeg|image\/jpg|image\/png|image\/webp);base64,[A-Za-z0-9+/=\s]+$
                  description: >-
                    proofOfAddress em base64, como
                    `data:application/pdf;base64,...`. Até 5 MB.
                proofOfBankAccount:
                  type: string
                  pattern: >-
                    ^data:(application\/pdf|image\/jpeg|image\/jpg|image\/png|image\/webp);base64,[A-Za-z0-9+/=\s]+$
                  description: >-
                    proofOfBankAccount em base64, como
                    `data:application/pdf;base64,...`. Até 5 MB.
              additionalProperties: false
            example:
              documentUrl: >-
                data:application/pdf;base64,JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIFI+PgpzdHJlYW0K
              proofOfAddress: >-
                data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==
      responses:
        '200':
          description: Documentos da empresa depois do envio.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      documentUrl:
                        type: string
                        nullable: true
                        description: >-
                          Cartão CNPJ enviado para verificação, como URL
                          temporária de download.
                      companyConstitution:
                        type: string
                        nullable: true
                        description: Contrato social, como URL temporária de download.
                      proofOfAddress:
                        type: string
                        nullable: true
                        description: >-
                          Comprovante de endereço, como URL temporária de
                          download.
                      proofOfBankAccount:
                        type: string
                        nullable: true
                        description: >-
                          Comprovante de conta bancária, como URL temporária de
                          download.
                    required:
                      - documentUrl
                      - companyConstitution
                      - proofOfAddress
                      - proofOfBankAccount
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Documentos da empresa depois do envio.
              example:
                success: true
                data:
                  documentUrl: >-
                    https://documentos.ephra.io/companies/cmtxx1uar0001hlg1u3ajbj6o/document_cmtxx1uar0001hlg1u3ajbj6o.pdf?X-Amz-Expires=900
                  companyConstitution: null
                  proofOfAddress: >-
                    https://documentos.ephra.io/companies/cmtxx1uar0001hlg1u3ajbj6o/proof_of_address_cmtxx1uar0001hlg1u3ajbj6o.png?X-Amz-Expires=900
                  proofOfBankAccount: null
        '400':
          description: A requisição está bem formada, mas uma regra de negócio a recusou.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  A requisição está bem formada, mas uma regra de negócio a
                  recusou.
              example:
                success: false
                message: >-
                  Não foi possível concluir: uma regra de negócio recusou os
                  dados enviados.
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '404':
          description: O recurso não existe, foi excluído ou pertence a outra empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  O recurso não existe, foi excluído ou pertence a outra
                  empresa.
              example:
                success: false
                message: Recurso não encontrado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````