PayZu OnboardingDocumentos e análise
Documentos
Leia os documentos que o cliente enviou na jornada, com o andamento de cada um, e baixe os arquivos aceitos por um link com prazo.
Veja o andamento
documents[] de Consultar uma proposta traz o type e o status de cada documento enviado e, quando ele é recusado, o motivo em rejectionReasonCode.
| Status | O que quer dizer |
|---|---|
AWAITING_UPLOAD | O cliente começou o envio, e o arquivo ainda não chegou. |
AVAILABLE | Arquivo conferido e aceito. |
REJECTED | Arquivo recusado, com o motivo em rejectionReasonCode. |
O motivo da recusa é um código do catálogo de motivos de reprovação. O cliente envia outro arquivo na própria jornada, quando a etapa de documentos é reaberta.
Não há callback por documento.
A decisão sobre eles chega em proposal.decided ou proposal.waiting_data, descritos em Callbacks.
Baixe os arquivos
A lista traz só os documentos AVAILABLE, de quem preencheu, dos sócios e da empresa.
bash
curl --url 'https://api.sandbox.payzu.dev/v1/proposals/cmvb8kz7q0001s60a4hzf6j2t/files' \
--header 'Authorization: Bearer SEU_TOKEN'json
{
"proposalId": "cmvb8kz7q0001s60a4hzf6j2t",
"files": [
{
"id": "cmvb8m2c10002s60a5j1k8x3p",
"type": "SOCIAL_CONTRACT",
"source": "UPLOAD",
"owner": {
"taxId": "12345678000195",
"name": "EMPRESA EXEMPLO LTDA"
},
"mimeType": "application/pdf",
"sizeBytes": 482113,
"sha256": "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9",
"createdAt": "2026-10-16T18:51:03.000Z",
"url": "https://storage.payzu.com.br/abertura/arquivo.pdf?assinatura=exemplo",
"expiresAt": "2026-10-16T19:07:41.000Z"
}
]
}Referência: Listar os arquivos de uma proposta
| Campo | O que traz |
|---|---|
owner | De quem é o documento. |
source | UPLOAD para o arquivo enviado na jornada e PROVIDER para o que veio da captura de documento e selfie. |
url | O link de leitura assinado. |
expiresAt | Quando o link vence. Depois disso, liste de novo. |
Erros desta operação
| Código | HTTP | Mensagem |
|---|---|---|
proposal_not_found | 404 | Proposta não encontrada. |
Autenticação e validação estão no Catálogo de erros.