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

# Enviar comprovante

Envia o arquivo que comprova um documento declarado (imagem de um documento de identidade, PDF de um comprovante de endereço, contrato social). A prova é criada em verificationStatus: PENDING e armazenada de forma criptografada; a Localpayment a revisa. Quando todos os arquivos forem enviados, chame Request Verification.

* Arquivos por documento. Um documento comporta quantas provas forem necessárias: frente, verso e selfie de um documento de identidade, as páginas de um contrato, um recibo. Não há limite para o número de arquivos por id de documento.
* Substituição. FRONT, BACK e SELFIE têm um arquivo atual cada: enviar o mesmo tipo novamente substitui o anterior, que passa a ser SUPERSEDED. DOCUMENT e OTHER são cumulativos: cada envio adiciona um arquivo (páginas de um contrato, vários recibos).
* Arquivos aprovados são mantidos. Substituir um FRONT, BACK ou SELFIE APPROVED retorna 409 PROOF\_APPROVED.
* Durante uma revisão. Enquanto a entidade estiver IN\_REVIEW, nenhum arquivo pode ser enviado, substituído ou excluído (409 ENTITY\_IN\_REVIEW).
* Verifique sizeBytes > 0 na resposta: uma solicitação multipart sem a parte de arquivo armazena uma prova vazia.
* Os arquivos nunca são retornados inline; baixe-os por meio de Get a Proof ou Download a Proof File.

Os erros usam `application/problem+json` com um `code` estável. Catálogo completo: [Statuses de Entidade e Códigos de Erro](https://docs.localpayment.com/pt-br/reference/entity-statuses-and-error-codes.md).


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/entity/v1/documents/{docId}/proofs
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/entity/v1/documents/{docId}/proofs:
    post:
      summary: Enviar comprovante
      operationId: upload-proof
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token). Sua conta
            de comerciante e o usuário que realiza a ação são identificados a
            partir dele.
          required: true
          schema:
            type: string
            examples:
              - Bearer <your_access_token>
        - name: X-Correlation-ID
          in: header
          description: >-
            Identificador de rastreamento (UUID). Exibido na resposta; gerado
            pelo Localpayment se ausente.
          required: false
          schema:
            type: string
            examples:
              - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
        - name: docId
          in: path
          description: ID do documento ao qual o arquivo pertence.
          required: true
          schema:
            type: string
            format: uuid
            examples:
              - e0ea9515-442e-4bc5-bc82-b8d278255c37
        - name: proofType
          in: query
          description: FRONT, BACK, SELFIE, DOCUMENT, OTHER.
          required: true
          schema:
            type: string
            examples:
              - FRONT
            enum:
              - FRONT
              - BACK
              - SELFIE
              - DOCUMENT
              - OTHER
        - name: metadata
          in: query
          description: >-
            Objeto JSON codificado em URL com metadados de formato livre, por
            exemplo %7B%22issuer%22%3A%22utility%22%7D.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    JPG, PNG ou PDF com até 10 MB. Arquivo multipartes com nome
                    definido.
                  examples:
                    - id_front.jpg
      responses:
        '201':
          description: Criado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    examples:
                      - 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                    description: Identificador da prova (proofId).
                  documentId:
                    type: string
                    examples:
                      - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                    format: uuid
                    description: Documento que o arquivo comprova.
                  proofType:
                    type: string
                    examples:
                      - FRONT
                    enum:
                      - FRONT
                      - BACK
                      - SELFIE
                      - DOCUMENT
                      - OTHER
                    description: FRONT, BACK, SELFIE, DOCUMENT, OTHER.
                  fileName:
                    type: string
                    examples:
                      - id_front.jpg
                    description: >-
                      Metadados do arquivo conforme carregado. Verifique o
                      tamanho em bytes. > 0 após o upload.
                  mimeType:
                    type: string
                    examples:
                      - image/jpeg
                    description: >-
                      Metadados do arquivo conforme carregado. Verifique o
                      tamanho em bytes. > 0 após o upload.
                  sizeBytes:
                    type: integer
                    examples:
                      - 102400
                    description: >-
                      Metadados do arquivo conforme carregado. Verifique o
                      tamanho em bytes. > 0 após o upload.
                  verificationStatus:
                    type: string
                    examples:
                      - PENDING
                    enum:
                      - PENDING
                      - IN_REVIEW
                      - APPROVED
                      - REJECTED
                    description: >-
                      PENDING, IN_REVIEW, APPROVED, REJECTED. Definido pela
                      Localpayment Compliance.
                  verifiedBy:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Resultado da verificação. verificationReason é preenchido
                      em caso de rejeição.
                  verifiedAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: >-
                      Resultado da verificação. verificationReason é preenchido
                      em caso de rejeição.
                  verificationReason:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Resultado da verificação. verificationReason é preenchido
                      em caso de rejeição.
                  uploadedBy:
                    type: string
                    examples:
                      - '12345'
                    description: >-
                      Usuário da sua conta que carregou o arquivo (a partir do
                      token de acesso) e horário do upload.
                  uploadedAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:13Z'
                    format: date-time
                    description: >-
                      Usuário da sua conta que carregou o arquivo (a partir do
                      token de acesso) e horário do upload.
                  status:
                    type: string
                    examples:
                      - CURRENT
                    enum:
                      - CURRENT
                      - SUPERSEDED
                      - DELETED
                    description: >-
                      Ciclo de vida da prova: CURRENT (ativa), SUPERSEDED
                      (substituída por um upload mais recente do mesmo
                      proofType) ou DELETED. Independente de verificationStatus.
                  supersededAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Definido quando a prova foi substituída.
                  supersededBy:
                    type:
                      - string
                      - 'null'
                    description: Definido quando a prova foi substituída.
                  replacedByProofId:
                    type:
                      - string
                      - 'null'
                    format: uuid
                    description: Definido quando a prova foi substituída.
                  deletedAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Definido quando a prova foi excluída.
                  deletedBy:
                    type:
                      - string
                      - 'null'
                    description: Definido quando a prova foi excluída.
                  inVerification:
                    type: boolean
                    examples:
                      - false
                    description: >-
                      Verdadeiro enquanto a prova estiver em revisão (entidade
                      IN_REVIEW); ela não pode ser substituída ou excluída nesse
                      período.
              examples:
                Example 1:
                  value:
                    id: 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                    documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                    proofType: FRONT
                    fileName: id_front.jpg
                    mimeType: image/jpeg
                    sizeBytes: 102400
                    verificationStatus: PENDING
                    verifiedBy: null
                    verifiedAt: null
                    verificationReason: null
                    uploadedBy: '12345'
                    uploadedAt: '2024-01-15T17:03:13Z'
                    status: CURRENT
                    supersededAt: null
                    supersededBy: null
                    replacedByProofId: null
                    deletedAt: null
                    deletedBy: null
                    inVerification: false
                Example 2 - PDF upload with metadata:
                  value:
                    id: 20d6aa56-73ce-4a52-95e2-903bc9971d08
                    documentId: 396809f2-f4b1-486a-a636-7cd7ad16073c
                    proofType: DOCUMENT
                    fileName: proof_of_address.pdf
                    mimeType: application/pdf
                    sizeBytes: 51200
                    verificationStatus: PENDING
                    verifiedBy: null
                    verifiedAt: null
                    verificationReason: null
                    uploadedBy: '12345'
                    uploadedAt: '2024-01-15T17:19:44Z'
                    status: CURRENT
                    supersededAt: null
                    supersededBy: null
                    replacedByProofId: null
                    deletedAt: null
                    deletedBy: null
                    inVerification: false
        '400':
          description: >-
            Solicitação inválida. VALIDATION_ERROR: Um campo, cabeçalho, caminho
            ou parâmetro de consulta está ausente, é desconhecido ou inválido.
            details[] lista o campo e o problema.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - VALIDATION_ERROR:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      A field, header, path or query parameter is missing,
                      unknown or invalid. details[] lists field and issue.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: VALIDATION_ERROR
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: externalId
                        issue: REQUIRED
        '401':
          description: 'Não autorizado. UNAUTHORIZED: Token de acesso ausente ou inválido.'
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNAUTHORIZED:
                  value:
                    type: about:blank
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid access token.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '404':
          description: >-
            Não encontrado. DOCUMENT_NOT_FOUND: O documento não existe, foi
            excluído ou pertence a outro comerciante.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - DOCUMENT_NOT_FOUND:
                  value:
                    type: about:blank
                    title: Not found
                    status: 404
                    detail: >-
                      The document does not exist, was deleted, or belongs to
                      another merchant.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: DOCUMENT_NOT_FOUND
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '409':
          description: >-
            Conflito. ENTITY_IN_REVIEW: A entidade está IN_REVIEW: seus dados,
            documentos, arquivos e vínculos de UBO estão congelados até que o
            Compliance da Localpayment a resolva. PROOF_APPROVED: A prova está
            APPROVED: não pode ser substituída nem excluída.
            ENTITY_NOT_EDITABLE: A entidade está REJECTED, BLOCKED ou CLOSED, ou
            a operação removeria o documento principal ou o único documento.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - ENTITY_IN_REVIEW:
                  value:
                    type: about:blank
                    title: Conflict
                    status: 409
                    detail: >-
                      The entity is IN_REVIEW: its data, documents, files and
                      UBO links are frozen until Localpayment Compliance
                      resolves it.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: ENTITY_IN_REVIEW
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
                Example 2 - PROOF_APPROVED:
                  value:
                    type: about:blank
                    title: Conflict
                    status: 409
                    detail: 'The proof is APPROVED: it cannot be replaced or deleted.'
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: PROOF_APPROVED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
                Example 3 - ENTITY_NOT_EDITABLE:
                  value:
                    type: about:blank
                    title: Conflict
                    status: 409
                    detail: >-
                      The entity is REJECTED, BLOCKED or CLOSED, or the
                      operation would remove the primary document or the only
                      document.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: ENTITY_NOT_EDITABLE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '413':
          description: >-
            Carga útil muito grande. FILE_TOO_LARGE: o arquivo enviado excede 10
            MB.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - FILE_TOO_LARGE:
                  value:
                    type: about:blank
                    title: Payload too large
                    status: 413
                    detail: The uploaded file exceeds 10 MB.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: FILE_TOO_LARGE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '415':
          description: >-
            Tipo de mídia não suportado. UNSUPPORTED_FILE_TYPE: O arquivo
            enviado não é JPG, PNG ou PDF.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNSUPPORTED_FILE_TYPE:
                  value:
                    type: about:blank
                    title: Unsupported media type
                    status: 415
                    detail: The uploaded file is not a JPG, PNG or PDF.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: UNSUPPORTED_FILE_TYPE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '502':
          description: >-
            Gateway inválido. STORAGE_WRITE_FAILED: O arquivo não pôde ser
            armazenado. Tente o upload novamente.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - STORAGE_WRITE_FAILED:
                  value:
                    type: about:blank
                    title: Bad gateway
                    status: 502
                    detail: The file could not be stored. Retry the upload.
                    instance: >-
                      /api/entity/v1/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37/proofs
                    code: STORAGE_WRITE_FAILED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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