Schemas

1. `Borrower`

Devedor da operação. Usado em POST /loan.

Campo	Tipo	Obrigatório	Descrição
`document_number`	string	sim	CPF (PF) ou CNPJ (PJ) — apenas dígitos
`document_type`	enum	sim	`CPF` ou `CNPJ`
`name`	string	sim	Nome civil ou razão social
`birth_date`	date	condicional	Obrigatório para PF (ISO 8601)
`gender`	enum	não	`MALE`, `FEMALE`, `OTHER`
`email`	string	sim	E-mail principal
`phone`	string	sim	Telefone no formato E.164 (`+5511999990000`)
`address`	Address	sim	Endereço completo

{
  "document_number": "12345678909",
  "document_type": "CPF",
  "name": "Maria Silva",
  "birth_date": "1985-04-12",
  "email": "[email protected]",
  "phone": "+5511999990000",
  "address": { }
}

2. `Address`

Campo	Tipo	Obrigatório	Descrição
`zip_code`	string	sim	CEP — apenas dígitos (8 caracteres)
`street`	string	sim	Logradouro
`number`	string	sim	Número
`complement`	string	não	Complemento (apto, bloco)
`neighborhood`	string	sim	Bairro
`city`	string	sim	Cidade
`state`	string	sim	UF (2 caracteres)

3. `Installment`

Parcela de uma operação. Array em POST /loan.

Campo	Tipo	Obrigatório	Descrição
`code`	string	sim	Identificador único da parcela dentro da operação. Use como chave em `POST /installment/settle`
`due_date`	date	sim	Vencimento (ISO 8601). Parcelas devem ser mensais consecutivas
`face_value`	decimal	sim	Valor de face — quanto o devedor paga
`nosso_numero`	string	não	Identificador bancário, se o integrador já emite seus boletos

{
  "code": "1",
  "due_date": "2026-06-01",
  "face_value": 850.00
}

4. `BackingDocument`

Identifica um arquivo de lastro anexado no multipart. Array em POST /loan.

Campo	Tipo	Obrigatório	Descrição
`type`	enum	sim	`ccb`, `duplicate`, `fiscal_note`, `prepaid_contract`, `borrower_doc`, `collateral`
`value`	string	sim	Identificador único do documento. O PDF anexado deve ter o nome `{value}.pdf`

[
  { "type": "ccb",         "value": "CCB-001234" },
  { "type": "fiscal_note", "value": "NF-9876" }
]

5. `EventEnvelope`

Envelope comum de todo webhook.

Campo	Tipo	Descrição
`event`	string	Nome do evento — ver Catálogo
`event_id`	string	UUID único — use para deduplicação
`originator_proposal_code`	string	Código da operação relacionada (quando aplicável)
`fund_id`	UUID	Fundo onde a operação está
`timestamp`	datetime	Quando o evento ocorreu (ISO 8601 UTC)
`data`	object	Payload específico do evento

6. `ErrorResponse`

Resposta padrão para qualquer erro HTTP 4xx ou 5xx.

Campo	Tipo	Descrição
`error_code`	string	Código canônico do erro — ver Códigos de erro
`message`	string	Mensagem humana descrevendo o erro
`field`	string	Campo que causou o erro (em erros de validação)
`request_id`	string	ID da requisição — inclua ao abrir chamado

{
  "error_code": "field_missing",
  "message": "Field 'fund_id' is required",
  "field": "fund_id",
  "request_id": "req_8a3f2c1b9d4e"
}

7. Próximos passos

Continuar — Códigos de erro

Tabela canônica.

Download — OpenAPI

Schemas máquina-legíveis para gerar clientes.

1. Borrower

2. Address

3. Installment

4. BackingDocument

5. EventEnvelope

6. ErrorResponse