Consulta de Margem & Simulação de Crédito

{
 "authorization_validity_date": "string",
 "authorization_token": "string",
 "status": "AUTHORIZED"
}

{
 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
 "status": "WAITING_SIGNATURE"
}

{
 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
 "status": "NOT_AUTHORIZED"
}

{
  "message": "Erro na requisição",
  "detail": {
    "authorization_file": [
      "Arquivo inválido ou ausente"
    ],
    "taxpayer_id": [
      "CPF inválido"
    ],
    "product_id": [
      "ID do produto não encontrado"
    ]
  }
}

{
  "links": [
    {
      "employer": {
        "code": "123456", 
        "document": "95818221485", 
        "name": "Empresa Exemplo LTDA"
      },
      "employee": {
        "code": "1564882125",
        "document": "90110651669", 
        "name": "João da Silva"
      },
      "config": {
        "agency": "3a7e1beb-c64f-4936-8555-b9edb42c3328",
        "consignee": "468f5087-d35f-45dd-96db-3cf71a83fe08"
      },
      "products": [
        {
          "balance_check_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "authorization": {
            "details": [
              {
                "type_product": "LOAN",
                "authorized": true,
                "validity": "2025-12-31"
              }
            ],
            "portability": [
              {
                "authorized": false,
                "available_balance": 0,
                "type_product": "LOAN",
                "validity": "2025-12-31",
                "contract_port": {
                  "contract_id": "PORT123",
                  "document": "12345678900",
                  "name_consignee": "BANCO XYZ"
                }
              }
            ]
          },
          "rubric": {
            "code": "RUB001",
            "description": "Rubrica de Empréstimo"
          },
          "agreement": "AG001",
          "available_balance": 5000.75
        }
      ],
      "meta_data": {
        "nationality_country": {
          "description": "Brasil",
          "code": "BR"
        },
        "termination_reason_code": "TRC001",
        "birth_date": "1985-08-06",
        "worker_category_code": "101",
        "termination_date": "2025-06-01",
        "prior_notice_date": "2025-05-15",
        "prior_notice_end_date": "2025-06-15",
        "gender": {
          "description": "Masculino",
          "code": 1
        },
        "job_code": {
          "description": "Analista de Sistemas",
          "code": "21240"
        },
        "economic_activity_code": {
          "description": "Atividades de tecnologia",
          "code": "6201-5/01"
        },
        "politically_exposed_person": {
          "description": "Não",
          "code": 0
        },
        "unauthorization_reason": {
          "description": "Nenhum",
          "code": 0
        },
        "base_margin_value": "3000.00",
        "alerts": [
          {
            "absence_reason_code": "A001",
            "alert_type": {
              "description": "Licença Médica",
              "code": 1
            },
            "absence_date": "2025-01-10",
            "absence_end_date": "2025-01-25",
            "reference_date": "2025-01",
            "event_id": "EVT123",
            "termination_reason_code": "TRC001"
          }
        ],
        "amount_loans_assets_suspended": "1500.00",
        "admission_date": "2010-03-15",
        "total_earnings": "8500.00",
        "legacy_loans": [
          {
            "financial_institution_code": 123,
            "contract": "CON123456789",
            "contract_start_date": "2021-01-01",
            "contract_end_date": "2026-01-01",
            "installment_amount": 350.25,
            "loan_amount": 10000.00,
            "net_amount": 9500.00,
            "update_date_time": "2025-08-01T10:00:00Z",
            "interest_tax": 1.85,
            "monthly_cet": 2.1,
            "installment_quantity": 60,
            "paid_installments_quantity": 30,
            "debtor_balance_amount": 5000.00,
            "contract_type": {
              "description": "Crédito Consignado",
              "code": 1
            }
          }
        ],
        "employer_activity_start_date": "2005-01-01",
        "mother_name": "Maria de Lourdes"
      },
      "balance_check_date": "2025-08-05"
    }
  ],
  "message": "Verificação de margem realizada com sucesso"
}

{
  "message": "Erro na requisição",
  "detail": {
    "authorization_file": [
      "Arquivo inválido ou ausente"
    ],
    "taxpayer_id": [
      "CPF inválido"
    ],
    "product_id": [
      "ID do produto não encontrado"
    ]
  }
}

{
    "message": "Request accepted for asynchronous processing"
}

{
  "event": "GuaranteeBalanceUpdate",
  "payload": {
    "links": [
      {
        "employer": {
          "code": "1",
          "document": "38645962000170",
          "name": "EMPREGADOR TESTE"
        },
        "employee": {
          "code": "MATR8289",
          "document": "79017995017",
          "name": "TESTE HELLEN"
        },
        "config": {
          "agency": "3a7e1beb-c64f-4936-8555-b9edb42c3328",
          "consignee": "3b9be0e7-3af9-4ca4-ad31-26233a58486a"
        },
        "products": [
          {
            "balanceCheckId": "ef45bbfe-9f9e-403d-91c3-0e8b6d5f01aa",
            "authorization": {
              "details": [
                {
                  "typeProduct": "LOAN",
                  "authorized": true
                }
              ]
            },
            "availableBalance": 449.34
          }
        ],
        "metaData": {
          "nationalityCountry": {
            "description": "TURQUIA",
            "code": "792"
          },
          "terminationReasonCode": "0",
          "birthDate": "1990-01-01",
          "workerCategoryCode": "101",
          "gender": {
            "description": "Masculino",
            "code": 1
          },
          "jobCode": {
            "description": "AGENTE DE VIAGEM",
            "code": "354815"
          },
          "politicallyExposedPerson": {
            "description": "Pessoa Não Exposta Politicamente",
            "code": 0
          },
          "baseMarginValue": "1500",
          "amountLoansAssetsSuspended": "2",
          "admissionDate": "2020-01-01",
          "totalEarnings": "5000"
        }
      }
    ]
  }
}

{
  "requested_amount": 100,
  "interest_rate": 0.01,
  "tac_amount": 0,
  "finance_fee": 0,
  "financed_iof": 1,
  "num_payments": 10,
  "first_payment_date": "2025-06-16",
  "disbursement_date": "2025-05-16",
  "balance_check_id": "{{balanceCheckId}}",
  "borrower": {
    "id": "df32c4f4-f1ea-47e1-ae45-7a6b0b2d92f3"
  },
  "product": {
    "id": "027b863d-8b5e-481d-af61-30e41772b777"
  },
  "signature_collect_method": "LINK",
  "signature_provider": "ZAPSIGN",
  "billets_info": null,
  "qrcode_info": null,
  "additional_installment_description": null,
  "additional_installment_fee": null,
  "funding": {
    "id": "9773c5fb-cbd7-41fa-b6b1-e9c76295259f"
  },
  "custom_variables": {
    "values": {}
  },
  "signature_authentication_options": {
    "mode": "FACIAL_BIOMETRICS"
  },
  "signature_collect_options": {
    "require_self_photo": false,
    "require_selfie_validation": false
  }
}