Skip to main content
POST
Enviar documento de participante
Envia um documento do comprador, do vendedor ou da loja, em Base64. Aceito quando a etapa ativa do participante for ENVIO_DOCUMENTOS (com a proposta aprovada) ou CORRECAO_DOCUMENTOS (só para tipos com status INVALIDO). Retorna 204 No Content. Exemplo:
O header Idempotency-Key é obrigatório. Use a mesma chave nas retentativas do mesmo envio.
PDF, JPG/JPEG ou PNG, até 10 MiB decodificado, Base64 puro (sem prefixo data:).

Guia de envio de documentos

Tipos por participante, exemplo completo e o fluxo de correção.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Headers

Idempotency-Key
string
required

Chave única por envio (1 a 200 caracteres). Com a mesma chave e o mesmo conteúdo, um envio bem-sucedido nas últimas 24 horas não é processado de novo.

Example:

"doc-7f3c2a10-comprador-cnh"

Path Parameters

propostaId
string<uuid>
required

Identificador único da proposta (UUID) retornado na criação da proposta

Example:

"bea8d060-f93d-48eb-b6c4-45f64483cdd9"

Body

application/json
participante
enum<string>
required

Participante dono do documento.

Available options:
COMPRADOR,
VENDEDOR,
LOJA
Example:

"COMPRADOR"

tipoDocumento
integer<int32>
required

Código do tipo de documento. Tipos aceitos por participante:

  • COMPRADOR: 1, 4, 5, 6, 7, 9, 57
  • VENDEDOR: 1, 2, 3, 5, 6, 7, 8, 9, 11
  • LOJA: 6, 8

Códigos: 1 = CNH, 2 = CPF, 3 = RG, 4 = Comprovante de renda, 5 = Comprovante de residência, 6 = Documento do veículo, 7 = CNH digital, 8 = Laudo ECV, 9 = Laudo de vistoria, 11 = Cartão CNPJ, 57 = ATPV.

Example:

1

nomeArquivo
string
required

Nome do arquivo com extensão .pdf, .jpg, .jpeg ou .png, sem caminho. A extensão precisa corresponder ao conteúdo real do arquivo.

Maximum string length: 255
Example:

"cnh-comprador.pdf"

conteudoBase64
string
required

Conteúdo do arquivo em Base64 puro (sem prefixo data:), até 10 MiB depois de decodificado.

Example:

"JVBERi0xLjcKJcOkw7zDtsOfCjIgMCBvYmoK..."

Response

Documento recebido. A resposta não tem corpo.

Resposta sem corpo