Criação do tomador, Solicitação & Cancelamento
Criação do Tomador
O próximo passo é a análise e criação do tomador no sistema.
Nesta etapa, é executado o fluxo de KYC (Know Your Customer), que pode seguir dois caminhos:
- Fluxo padrão da plataforma de crédito, com validações automatizadas e integradas;
- Fluxo personalizado do cliente, quando houver configurações específicas previamente definidas.
Esse processo é essencial para validar a identidade e elegibilidade do tomador, garantindo segurança e conformidade regulatória.
1. Criar uma Pessoa
- Referência da rota: Criar uma pessoa
curl --request POST \
--url https://sandbox.platform.flowfinance.com.br/banking/originator/persons \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"phone": {
"country_code": "55",
"area_code": "11",
"number": "971118467"
},
"address": {
"street_name": "Nome da Rua",
"street_number": "12",
"postal_code": "03273500",
"district": "Bairro",
"city": "Cidade",
"state_code": "SP",
"country_code": "BRA"
},
"pix": {
"key_type": "EMAIL",
"key": "[email protected]"
},
"full_name": "Nome completo",
"taxpayer_id": "65371068260",
"nationality": "Brasileiro",
"email_address": "[email protected]",
"occupation": "Analista",
"pep": false,
"sex": "MALE",
"birth_date": "AAAA-MM-DD"
}
'
Response 200
200{
"id": "ed99844d-20a1-4410-b941-400d81877950",
"taxpayer_id": "78771521089",
"nationality": "Brasileiro",
"pep": false,
"full_name": "João da Silva",
"phone": {
"country_code": "+55",
"area_code": "11",
"number": "971117272",
"formatted_number": "+5511971117272"
},
"occupation": "Profissão",
"birth_date": "1998-03-26",
"marital_status": null,
"email_address": "[email protected]",
"mothers_name": null,
"marital_property_system": null,
"id_document": null,
"sex": "MALE",
"address": {
"street_name": "Minha Rua",
"street_number": 6,
"postal_code": "05514000",
"district": "Meu Bairro",
"city": "Cidade",
"state_code": "SP",
"country_code": "+55",
"extra_info": null
},
"pix": {
"key": "4ca519ef-0ccc-4c41-b58b-c88f1f47d8ab",
"key_type": "ALEATORY_KEY"
},
"external_bank_account": null,
"custom_variables": {},
"spouse_full_name": null,
"originator": {
"id": "21eb1a5c-9324-4e69-8752-1e6326691b55",
"legal_name": "TESTA EM PROD SECURITIZADORA"
},
"employer": null,
"created_at": "2025-08-05T15:21:53.792385Z",
"version": 0,
"spouse_taxpayer_id": null,
"spouse_date_of_birth": null,
"birthplace": null,
"monthly_income": null,
"income_range": null,
"has_scr_evidence": false,
"scr_evidence_provider": null,
"scr_evidence_type": null
}
2. Criação da Operação (CCB)
Neste etapa, obtendo o retorno positivo do KYC do tomador, é necessário realizar a chamada no endpoint para emissão da CCB.
- Referência da rota: Criar uma nova Solicitação
Parâmetros da requisição
| Campo | Descrição | Tipo |
|---|---|---|
| borrower.id | ID único do tomador, obtido na etapa de criação do tomador. | string |
| product.id | .ID do produto de crédito a ser contratado. | string |
| funding.id | ID da fonte de recursos da operação. | string |
| balance_check_id | ID retornado na consulta de margem do tomador. | string |
| simulation_id | ID retornado na simulação da operação de crédito. | string |
| signature_authentication_options.mode | Método de autenticação da assinatura digital (ex.: FACIAL_BIOMETRICS). | string |
| signature_collect_method | Método de coleta da assinatura (ex.: LINK, IN_PERSON). | string |
| signature_provider | Provedor de assinatura eletrônica (ex.: ZAPSIGN). | string |
cURL
curl --location 'https://sandbox.platform.flowfinance.com.br/banking/originator/applications' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '{
"borrower": {
"id": "{{PERSON_ID}}"
},
"product": {
"id": "{{PRODUCT_ID}}"
},
"funding": {
"id": "{{FUNDING_ID}}"
},
"balance_check_id": "fb717aae-1ba0-4896-bd48-9c14f4913b8b", // Retornado na Step de Consulta de Margem
"simulation_id": "9a5d195c-e64d-40ce-8b6d-5693b995008a", // Retornado na Step de Simulação da CCB
"signature_collect_method": "NONE",
"signature_provider": "CELCOIN"
}'
Response 200
200{
"id": "e01a2246-4ec0-40f3-89e1-651ce1585248",
"product": {
"id": "{{PRODUCT_ID}}"
},
"borrower": {
"id": "{{PERSON_ID}}"
},
"requested_amount": 45.68,
"interest_rate": 7.87E-4,
"interest_pre_type": "BASE_365",
"annual_interest_rate": 0.009489,
"tac_amount": 0.1,
"finance_fee": 0.00,
"num_payments": 1,
"first_payment_date": "2025-10-24",
"disbursement_date": "2025-09-24",
"allow_disbursement_on_sign": null,
"issue_date": "2025-09-24",
"status": "AGREEMENT_RENDERING",
"cession_status": "NOT_CEDED",
"status_description": null,
"loan_details": {
"total_processing_cost": 1.24,
"annual_interest_rate": 0.120000,
"interest_rate": 0.009489,
"annual_effective_interest_rate": 0.164760,
"monthly_effective_interest_rate": 0.012791,
"total_amount_owed": 50.71,
"disbursement_amount": 45.68,
"discount_amount": 0,
"discount_rate": 0.0,
"financed_amount": 45.78,
"iof_daily_rate": 0.000082,
"iof_amount": 1.14,
"iof_base_rate": 0.0038,
"payment_amount": 50.71,
"issue_date": "2025-09-24",
"schedule": [
{
"payment": 50.71,
"iof": 1.14,
"balance": 0.00,
"interest": 3.79,
"principal": 46.92,
"additional_value": 0.00,
"present_value": null,
"status": null,
"period": 1,
"running_day": 250,
"late_day": null,
"paid_value": null,
"payment_date": "2026-06-01"
}
],
"last_payment_date": "2026-06-01",
"reference_rate": null,
"interest_pre_type": "BASE_365",
"interest_rate_frequency": "ANNUALLY",
"amortization_type": null,
"interest_type": null,
"grace_period_interest": null,
"grace_period_amortizations": null,
"amortization_frequency": null
},
"custom_variables": {},
"canceled_at": null,
"sequential_id": 2352737,
"funding": {
"id": "836acb37-5d45-4963-930c-ba506aa78114",
"legal_name": "NOME DO ORIGINADOR",
"alias": null,
"metadata": {
"cod_backoffice": {
"value": "",
"sensitive": false
}
}
},
"payment_method": "BOLETO",
"backoffice_import_status": "NONE",
"guarantors": [],
"co_signers": [],
"investors": [],
"co_debtors": [],
"collateral_providers": [],
"representatives": [],
"sureties": [],
"signature_collect_method": "LINK",
"signature_provider": "ZAPSIGN",
"issuer_disbursement_type": "BENEFICIARY",
"signature_collect_options": {
"require_self_photo": false,
"require_document_photo": false,
"require_selfie_validation": false
},
"base_premium_amount": 0.46,
"additional_premium_amount": 0,
"loan": null,
"borrower_employer": null,
"disbursement": null,
"beneficiary_account": {
"registered_account_id": null,
"holder": {
"name": "NOME DO TOMADOR",
"taxpayer_id": "9999999999"
},
"external_bank_account": null,
"pix": {
"key": "CHAVE_PIX",
"key_type": "TIPO_DE_CHAVE"
},
"baas": {
"account_number": null
}
},
"created_at": "2025-09-24T14:03:49.090422Z",
"version": 0,
"cession_value": 47.38,
"issue_value": 47.38,
"issuer_migrated": true,
"custodian": null,
"signature_authentication_options": {
"mode": "FACIAL_BIOMETRICS"
},
"managed_account_for_issuer_disbursement": {
"product_configuration": null,
"baas": null
},
"disbursement_attempts": [],
"payment_orders": [
{
"id": "3a0edfbb-d0a3-490d-addb-0e042a4d47d9",
"amount": 45.68,
"type": "PIX_OUT",
"status": "READY_FOR_PROCESSING",
"beneficiary_account": {
"registered_account_id": null,
"holder": {
"name": "NOME DO TOMADOR",
"taxpayer_id": "CPF_DO_TOMADOR"
},
"external_bank_account": null,
"pix": {
"key": "NOME DO TOMADOR",
"key_type": "CPF_DO_TOMADOR"
},
"baas": {
"account_number": null
}
},
"beneficiary_type": "CONSIGNED",
"billet_info": null,
"allow_failure": null,
"qrcode_info": null,
"principal": null,
"is_partial_disbursement": null,
"pay_application_id": null
}
],
"ipoc_number": "8863275402031484511128462352732",
"additional_installment_fee": null,
"additional_installment_description": null,
"external_ccb_number": null,
"annotation_id": null,
"split_beneficiary_account": null,
"entry_payment_info": null,
"consignment": null,
"contracts_to_purchase": [],
"bundle_item_name": null
}
Demais processos
- Geração do contrato;
- Coleta das assinaturas digitais do tomador e, se aplicável, da instituição financeira;
- Averbação junto ao órgão responsável.
Averbação
A etapa de averbação consiste na formalização do crédito junto à Caixa Econômica Federal (CEF), garantindo que a operação de antecipação do Saque-Aniversário FGTS esteja registrada e autorizada oficialmente.
O retorno desse processo pode ocorrer de duas formas:
- Resposta síncrona via API: quando o sistema da CEF está disponível, a confirmação da averbação é recebida imediatamente na mesma requisição.
- Resposta assíncrona via webhook: utilizada quando o sistema da CEF está indisponível no momento da solicitação; nesse caso, o status da averbação será enviado posteriormente para URL cadastrada.
Somente após a conclusão dessas etapas que a CCB segue para o desembolso do crédito e, se previsto, a cessão da operação.
Cancelamento da CCB
O crédito consignado pode ser cancelado (desaverbado) em casos específicos, conforme as regras e prazos estabelecidos pelo sistema. As situações que permitem o cancelamento incluem:
- Desistência pelo tomador: Solicitação de cancelamento dentro do prazo permitido;
- Cancelamento da CCB: Anulação formal do contrato, quando aplicável;
Documentação:
https://developers.celcoin.com.br/reference/post_banking-originator-applications-application-id-cancel
Updated 19 days ago