Documentos podem ser anexados ao cadastro de um tomador para fins de análise, compliance e KYC. Cada documento é associado a um person_id e identificado por um type.
Enviar documento
POST /banking/originator/persons/{person_id}/documentsO envio é feito via multipart/form-data. O arquivo deve estar no formato PDF.
Headers
| Header | Obrigatório | Descrição |
|---|---|---|
Authorization | Sim | Bearer <token> |
Content-Type | Sim | multipart/form-data |
Path parameter
| Parâmetro | Tipo | Descrição |
|---|---|---|
person_id | UUID | Identificador do tomador |
Form fields
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file | file | Sim | Arquivo do documento. Deve ser um PDF. |
type | string | Sim | Tipo do documento (ver enums abaixo) |
description | string | Não | Descrição ou observação sobre o documento |
Tipos de documento (type)
type)| Valor | Descrição |
|---|---|
NATIONAL_ID | Documento de identidade (RG, CNH, etc.) |
PROOF_OF_INCOME | Comprovante de renda |
SCR_AUTHORIZATION | Autorização de consulta ao SCR (Banco Central) |
OTHER | Outros documentos |
Exemplo
curl --request POST \
'https://sandbox.platform.flowfinance.com.br/banking/originator/persons/4d456c37-c5fb-4890-8d2b-0157c6ae2b00/documents' \
--header 'Authorization: Bearer <seu_token>' \
--form 'type=NATIONAL_ID' \
--form 'file=@/caminho/para/documento.pdf' \
--form 'description=Documento de identidade do tomador'Resposta (HTTP 201)
{
"id": "1335e206-fe95-415e-8c23-765e55974015",
"entity_id": "4d456c37-c5fb-4890-8d2b-0157c6ae2b00",
"type": "NATIONAL_ID",
"file_name": "documento.pdf",
"file_extension": "pdf",
"status": "OK",
"observations": null,
"version": 0,
"created_at": "2026-04-17T21:04:38.629542Z"
}Listar documentos
GET /banking/originator/persons/{person_id}/documentsRetorna todos os documentos vinculados ao tomador.
Exemplo
curl --request GET \
'https://sandbox.platform.flowfinance.com.br/banking/originator/persons/4d456c37-c5fb-4890-8d2b-0157c6ae2b00/documents' \
--header 'Authorization: Bearer <seu_token>'Resposta (HTTP 200)
[
{
"id": "1335e206-fe95-415e-8c23-765e55974015",
"entity_id": "4d456c37-c5fb-4890-8d2b-0157c6ae2b00",
"type": "NATIONAL_ID",
"file_name": "documento.pdf",
"file_extension": "pdf",
"status": "OK",
"observations": null,
"version": 0,
"created_at": "2026-04-17T21:04:38.629542Z"
}
]Baixar documento
GET /banking/originator/persons/{person_id}/documents/{document_id}/fileRetorna o arquivo binário do documento para download.
Path parameters
| Parâmetro | Tipo | Descrição |
|---|---|---|
person_id | UUID | Identificador do tomador |
document_id | UUID | Identificador do documento |
Exemplo
curl --request GET \
'https://sandbox.platform.flowfinance.com.br/banking/originator/persons/4d456c37-c5fb-4890-8d2b-0157c6ae2b00/documents/1335e206-fe95-415e-8c23-765e55974015/file' \
--header 'Authorization: Bearer <seu_token>' \
--output documento.pdfAtualizar documento
PUT /banking/originator/persons/{person_id}/documents/{document_id}Substitui o arquivo ou atualiza os dados de um documento existente. O envio também é feito via multipart/form-data.
Exemplo
curl --request PUT \
'https://sandbox.platform.flowfinance.com.br/banking/originator/persons/4d456c37-c5fb-4890-8d2b-0157c6ae2b00/documents/1335e206-fe95-415e-8c23-765e55974015' \
--header 'Authorization: Bearer <seu_token>' \
--form 'type=NATIONAL_ID' \
--form 'file=@/caminho/para/novo-documento.pdf' \
--form 'description=Documento atualizado'Resposta (HTTP 200)
Retorna o objeto do documento com os dados atualizados e o campo version incrementado.
Deletar documento
DELETE /banking/originator/persons/{person_id}/documents/{document_id}Remove um documento vinculado ao tomador.
Exemplo
curl --request DELETE \
'https://sandbox.platform.flowfinance.com.br/banking/originator/persons/4d456c37-c5fb-4890-8d2b-0157c6ae2b00/documents/1335e206-fe95-415e-8c23-765e55974015' \
--header 'Authorization: Bearer <seu_token>'Resposta (HTTP 204)
Sem corpo de resposta.
Status do documento
| Status | Descrição |
|---|---|
OK | Documento recebido e validado com sucesso |
PENDING | Documento em avaliação assíncrona |
REJECTED | Documento reprovado |
Caso um documento permaneça em
PENDINGpor mais de 5 minutos, entre em contato com seu Gerente de Conta Celcoin.