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.

Documentação:
https://developers.celcoin.com.br/reference/post_banking-originator-persons


Solicitação da CCB

Neste etapa, obtendo o retorno positivo do KYC do tomador, é necessário realizar a chamada no endpoint para emissão da CCB.


POST: https://platform.flowfinance.com.br/dashboard/proxy/originator/applications


{
  "borrower": {
    "id": "a9e586b6-671d-43e7-a372-d046add4e841"
  },
  "product": {
    "id": "88ae6579-cfb7-49fe-a0cf-be7c48a43cde"
  },
  "funding": {
    "id": "b31aed64-da82-4c2e-b5e3-dfd1f808bb55"
  },
  "balance_check_id": "1ef0ca70-2fed-46ae-b5cd-9ee932c2a611",
  "simulation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "signature_authentication_options": {
    "mode": "FACIAL_BIOMETRICS"
  },
  "signature_collect_method": "LINK",
  "signature_provider": "ZAPSIGN",  
  "signature_collect_options": {
    "require_self_photo": true,
    "require_selfie_validation": false
  }
}

Parâmetros da requisição

CampoDescriçãoTipo
borrower.idID ú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.idID da fonte de recursos da operação.string
balance_check_idID retornado na consulta de margem do tomador.string
simulation_idID retornado na simulação da operação de crédito.string
signature_authentication_options.modeMétodo de autenticação da assinatura digital (ex.: FACIAL_BIOMETRICS).string
signature_collect_methodMétodo de coleta da assinatura (ex.: LINK, IN_PERSON).string
signature_providerProvedor de assinatura eletrônica (ex.: ZAPSIGN).string
signature_collect_options.require_self_photoDefine se é obrigatória a foto do signatário no processo.boolean
signature_collect_options.require_selfie_validationDefine se a selfie enviada precisa passar por validação biométrica.boolean


{
    "id": "9fe0f464-da5e-4a05-b292-4c84adce2d9d",
    "product": {
        "id": "bee766b3-e7e3-4e2d-94fe-7ab58d995e1a"
    },
    "borrower": {
        "id": "026abc58-c96f-4e1e-a94e-75e27a247af1"
    },
    "requested_amount": 4878.93,
    "interest_rate": 0.049,
    "interest_pre_type": "BASE_360",
    "annual_interest_rate": 0.775439,
    "tac_amount": 0.0,
    "finance_fee": 0.0,
    "num_payments": 2,
    "first_payment_date": "2025-10-21",
    "disbursement_date": "2025-07-24",
    "allow_disbursement_on_sign": null,
    "issue_date": "2025-07-24",
    "status": "ISSUED",
    "cession_status": "NOT_CEDED",
    "status_description": null,
    "loan_details": {
        "total_processing_cost": 163.11,
        "annual_interest_rate": 0.7754394,
        "interest_rate": 0.049,
        "annual_effective_interest_rate": 0.8490124,
        "monthly_effective_interest_rate": 0.0525555,
        "total_amount_owed": 9600.0,
        "disbursement_amount": 4878.93,
        "discount_amount": 0.0,
        "discount_rate": 0.0,
        "financed_amount": 5042.04,
        "iof_daily_rate": 0.000082,
        "iof_amount": 163.11,
        "iof_base_rate": 0.0038,
        "payment_amount": 400.0,
        "issue_date": "2025-07-24",
        "schedule": [
            {
                "payment": 400.0,
                "iof": 0.0,
                "balance": 400.0,
                "interest": 400.0,
                "principal": 368.82,
                "additional_value": null,
                "present_value": null,
                "status": null,
                "period": 1,
                "running_day": 89,
                "late_day": null,
                "paid_value": null,
                "payment_date": "2025-10-21"
            },
            {
                "payment": 400.0,
                "iof": 0.0,
                "balance": 400.0,
                "interest": 400.0,
                "principal": 243.01,
                "additional_value": null,
                "present_value": null,
                "status": null,
                "period": 2,
                "running_day": 120,
                "late_day": null,
                "paid_value": null,
                "payment_date": "2025-11-21"
            },
            {
                "payment": 400.0,
                "iof": 0.0,
                "balance": 400.0,
                "interest": 400.0,
                "principal": 101.98,
                "additional_value": null,
                "present_value": null,
                "status": null,
                "period": 3,
                "running_day": 150,
                "late_day": null,
                "paid_value": null,
                "payment_date": "2025-12-21"
            }
        ],
        "last_payment_date": "2027-09-21",
        "reference_rate": "PREFIXADO",
        "interest_pre_type": "BASE_360",
        "interest_rate_frequency": "MONTHLY",
        "amortization_type": "PRICE",
        "interest_type": "PRE",
        "grace_period_interest": 0,
        "grace_period_amortizations": [],
        "amortization_frequency": "MONTHLY"
    },
    "custom_variables": {},
    "canceled_at": null,
    "sequential_id": 169039,
    "funding": {
        "id": "67c1c6f2-adb0-4667-97ad-ab3c59377b7e",
        "legal_name": "VALORA BYX WAREHOUSE FUNDO DE INVESTIMENTO DIR CRED RESP LTDA",
        "alias": null,
        "metadata": {
            "cod_backoffice": {
                "value": "",
                "sensitive": false
            }
        }
    },
    "payment_method": "BOLETO",
    "backoffice_import_status": "PROCESSING",
    "guarantors": [],
    "co_signers": [],
    "investors": [],
    "co_debtors": [],
    "collateral_providers": [],
    "representatives": [],
    "sureties": [],
    "signature_collect_method": "LINK",
    "signature_provider": "CLICKSIGN",
    "issuer_disbursement_type": "BENEFICIARY",
    "signature_collect_options": {
        "require_self_photo": false,
        "require_document_photo": false,
        "require_selfie_validation": false
    },
    "base_premium_amount": 0,
    "additional_premium_amount": 0,
    "loan": null,
    "borrower_employer": null,
    "disbursement": {
        "requested_at": "2025-07-24T19:52:50.340435",
        "processed_at": "2025-07-24T19:53:49.617",
        "receipt": "\n    COMPROVANTE TRANSFERENCIA PIX\n             24/07/2025 16:53             \n            TERM 11 AGENTE 999            \n                CONTROLE                 \n    E13935893202507241953sF07Bf2YHQd     \n---------------------------------------- \n                PAGADOR                  \n    \nFACILICRED SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR LTDA\nAG:0001 CC:30054137218\nCPF/CNPJ:04849745000180\n---------------------------------------- \n                RECEBEDOR                 \n    \nJurema da Silva\n13935893 AG:0001 CC:30054137224101\nCPF/CNPJ:47061982594\n   \n---------------------------------------- \n    DATA DO PAGAMENTO 24/07/2025 16:53    \n    \n            VALOR R$4.878,93            \n----------------------------------------"
    },
    "beneficiary_account": {
        "registered_account_id": null,
        "holder": {
            "name": "Jurema da Silva",
            "taxpayer_id": "47061982594"
        },
        "external_bank_account": {
            "bank_code": "509",
            "bank_account": "3005413722410",
            "bank_account_digit": "1",
            "bank_branch": "0001",
            "bank_account_type": "CACC",
            "ispb_code": "13935893"
        },
        "pix": null,
        "baas": {
            "account_number": null
        }
    },
    "created_at": "2025-07-24T19:45:40.484572Z",
    "updated_at": "2025-07-24T19:55:32.650106Z",
    "version": 15,
    "cession_value": 5042.04,
    "issue_value": 5042.04,
    "issuer_migrated": false,
    "custodian": null,
    "signature_authentication_options": {
        "mode": "FACIAL_BIOMETRICS"
    },
    "managed_account_for_issuer_disbursement": {
        "product_configuration": null,
        "baas": null
    },
    "disbursement_attempts": [
        {
            "id": "2bd97f46-ce71-47a1-b765-cb9b19d21085",
            "status": "SUCCESS",
            "status_description": null,
            "payment_orders": [
                {
                    "id": "a1afa512-c788-4331-889f-5cede2da9b0a",
                    "amount": 4878.93,
                    "type": "PIX_OUT",
                    "status": "SUCCESS",
                    "beneficiary_account": {
                        "registered_account_id": null,
                        "holder": {
                            "name": "Jurema da Silva",
                            "taxpayer_id": "47061982594"
                        },
                        "external_bank_account": {
                            "bank_code": "509",
                            "bank_account": "3005413722410",
                            "bank_account_digit": "1",
                            "bank_branch": "0001",
                            "bank_account_type": "CACC",
                            "ispb_code": "13935893"
                        },
                        "pix": null,
                        "baas": {
                            "account_number": null
                        }
                    },
                    "beneficiary_type": "CONSIGNED",
                    "billet_info": null,
                    "qrcode_info": null
                }
            ],
            "requested_at": "2025-07-24T19:52:50.332231",
            "processed_at": "2025-07-24T19:53:49.617",
            "application_managed_account_for_issuer_disbursement": {
                "product_configuration": null,
                "baas": null
            },
            "created_at": "2025-07-24T19:52:50.337311Z",
            "updated_at": "2025-07-24T19:53:52.68703Z",
            "version": 1
        }
    ],
    "payment_orders": [
        {
            "id": "a1afa512-c788-4331-889f-5cede2da9b0a",
            "amount": 4878.93,
            "type": "PIX_OUT",
            "status": "SUCCESS",
            "beneficiary_account": {
                "registered_account_id": null,
                "holder": {
                    "name": "Jurema da Silva",
                    "taxpayer_id": "47061982594"
                },
                "external_bank_account": {
                    "bank_code": "509",
                    "bank_account": "3005413722410",
                    "bank_account_digit": "1",
                    "bank_branch": "0001",
                    "bank_account_type": "CACC",
                    "ispb_code": "13935893"
                },
                "pix": null,
                "baas": {
                    "account_number": null
                }
            },
            "beneficiary_type": "CONSIGNED",
            "billet_info": null,
            "allow_failure": null,
            "qrcode_info": null,
            "principal": null,
            "is_partial_disbursement": null
        }
    ],
    "ipoc_number": "486327540203147061982594169039",
    "additional_installment_fee": null,
    "additional_installment_description": null,
    "external_ccb_number": null,
    "annotation_id": "8e5e0d10-de03-4629-8b8c-f8225ba7c46e",
    "split_beneficiary_account": null,
    "entry_payment_info": 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