PayZu OnboardingDocumentos e análise

Documentos


Nesta páginaVeja o andamentoBaixe os arquivosErros desta operação

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.

StatusO que quer dizer
AWAITING_UPLOADO cliente começou o envio, e o arquivo ainda não chegou.
AVAILABLEArquivo conferido e aceito.
REJECTEDArquivo 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'

Referência: Listar os arquivos de uma proposta

CampoO que traz
ownerDe quem é o documento.
sourceUPLOAD para o arquivo enviado na jornada e PROVIDER para o que veio da captura de documento e selfie.
urlO link de leitura assinado.
expiresAtQuando o link vence. Depois disso, liste de novo.

Erros desta operação

CódigoHTTPMensagem
proposal_not_found404Proposta não encontrada.

Autenticação e validação estão no Catálogo de erros.