QI Tech

https://docs.qitech.com.br
Admin
QI Tech provides APIs for Lending as a Service, Banking as a Service, and Risk Solutions, enabling...
Tokens:2,169,197
Snippets:13,399
Trust Score:8.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET Response Body

Source: https://docs.qitech.com.br/documentation/baas/primeiros_passos/teste_de_autenticacao/baas_endpoints_de_teste

Example of a successful GET response body.

```json
{
  "test_key": "97ad0301-869c-4481-98b6-294b139e09ae",
  "success": "Congrats!"
}
```

--------------------------------

### Create Natural Person via cURL

Source: https://docs.qitech.com.br/documentation/caas/onboarding/natural_person

Command line example to trigger the onboarding process.

```bash
curl -X POST \
  'https://api.sandbox.caas.qitech.app/onboarding/natural_person?analyze=true' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -d '{
    "id": "12345678",
    "registration_date": "2026-08-07T11:37:15-03:00",
    "document_number": "111.111.111-11"
  }'  
```

--------------------------------

### Podfile Configuration (Previous Versions)

Source: https://docs.qitech.com.br/documentation/caas/face_recognition/ios/native_swift

Example configuration for SDK versions prior to 6.0.0.

```ruby
  source 'https://github.com/QITechSDKs/iOS.git'  

  source 'https://cdn.cocoapods.org/'  

  target 'ExampleApp' do  

    use_frameworks!  

    pod 'QITechIosFaceRecon', '~> 5.0.0'  

  end  

  

  post_install do |installer|  

    installer.pods_project.targets.each do |target|  

      if ['DatadogCore', 'DatadogInternal', 'DatadogCrashReporting', 'DatadogLogs'].include?(target.name)  

        target.build_configurations.each do |config|  

          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.5'  

          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'  

        end  

      end  

    end  

  end  
```

--------------------------------

### Debt Issuance Installment Response

Source: https://docs.qitech.com.br/documentation/emissao_de_divida/metadata

Example of the JSON structure returned for debt issuance installments, including principal and interest details.

```json
"installment_status": "created",  

                    "installment_type": "principal",  

                    "original_due_principal": 1007.19,  

                    "original_pre_fixed_amount": 38.24205854,  

                    "original_principal_amortization_amount": 351.17794146,  

                    "paid_amount": 0,  

                    "post_fixed_amount": 0,  

                    "original_total_amount": 389.42,  

                    "pre_fixed_amount": 38.24205854,  

                    "principal_amortization_amount": 351.17794146,  

                    "qr_code_key": null,  

                    "qr_code_url": null,  

                    "renegotiation_proposal_key": null,  

                    "tax_amount": 0.28796591,  

                    "total_accrual_amount": null,  

                    "total_amount": 389.42,  

                    "total_paid_amount": 0,  

                    "workdays": 8  

                },  

                {  

                    "accrual_reference_date": null,  

                    "advanced_paid_amount": 0,  

                    "bank_slip_key": null,  

                    "business_due_date": "2022-09-20",  

                    "due_date": "2022-09-19",  

                    "calendar_days": 32,  

                    "digitable_line": null,  

                    "due_interest": 0,  

                    "due_principal": 656.01205854,  

                    "fine_amount": null,  

                    "has_interest": true,  

                    "installment_key": "f844a3ea-bde3-4f94-ada1-607e799b9095",  

                    "installment_status": "created",  

                    "installment_type": "principal",  

                    "original_due_principal": 656.01205854,  

                    "original_pre_fixed_amount": 80.33658151,  

                    "original_principal_amortization_amount": 309.08341849,  

                    "paid_amount": 0,  

                    "post_fixed_amount": 0,  

                    "original_total_amount": 389.42,  

                    "pre_fixed_amount": 80.33658151,  

                    "principal_amortization_amount": 309.08341849,  

                    "qr_code_key": null,  

                    "qr_code_url": null,  

                    "renegotiation_proposal_key": null,  

                    "tax_amount": 1.06448329,  

                    "total_accrual_amount": null,  

                    "total_amount": 389.42,  

                    "total_paid_amount": 0,  

                    "workdays": 21  

                },  

                {  

                    "accrual_reference_date": null,  

                    "advanced_paid_amount": 0,  

                    "bank_slip_key": null,  

                    "business_due_date": "2022-10-19",  

                    "due_date": "2022-10-18",  

                    "calendar_days": 29,  

                    "digitable_line": null,  

                    "due_interest": 0,  

                    "due_principal": 346.92864005,  

                    "fine_amount": null,  

                    "has_interest": true,  

                    "installment_key": "e6d67f54-8827-40c4-ade0-1b9b8fd03689",  

                    "installment_status": "created",  

                    "installment_type": "principal",  

                    "original_due_principal": 346.92864005,  

                    "original_pre_fixed_amount": 42.49135995,  

                    "original_principal_amortization_amount": 346.92864005,  

                    "paid_amount": 0,  

                    "post_fixed_amount": 0,  

                    "original_total_amount": 389.42,  

                    "pre_fixed_amount": 42.49135995,  

                    "principal_amortization_amount": 346.92864005,  

                    "qr_code_key": null,  

                    "qr_code_url": null,  

                    "renegotiation_proposal_key": null,  

                    "tax_amount": 2.01981854,  

                    "total_accrual_amount": null,  

                    "total_amount": 389.42,  

                    "total_paid_amount": 0,  

                    "workdays": 20  

                }  

            ],  

            "interest_grace_period": 0,  

            "interest_payment_month_period": 1,  

            "interest_subsidy_amount": 0,  

            "interest_subsidy_percentage": 0,  

            "interest_type": "pre_price",  

            "iof_charge_method": "financed",  

            "ipoc_code": "3240250202021371976458320000000007/WO",  

            "issue_date": "2022-08-08",  

            "issuer_document_number": "37197645832",  

            "issuer_name": "Wilker Oliveira\u00e7o",  

            "modality": "0202",  

            "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5",  

            "payment_and_settlement_agent": "qi_scd",  

            "post_fixed_interest_rate": null,
```

--------------------------------

### Exemplos de Podfile

Source: https://docs.qitech.com.br/documentation/caas/ocr/ios/native_swift

Configurações completas do Podfile para diferentes versões do SDK, incluindo ajustes de build para Datadog.

```ruby
  source 'https://github.com/QITechSDKs/iOS.git'  

  source 'https://cdn.cocoapods.org/'  

  target 'ExampleApp' do  

    use_frameworks! :linkage => :static  

    pod 'QITechIosOCR', '~> 8.0.0'  

  end  

  

  post_install do |installer|  

    installer.pods_project.targets.each do |target|  

      if ['DatadogCore', 'DatadogInternal', 'DatadogCrashReporting', 'DatadogLogs'].include?(target.name)  

        target.build_configurations.each do |config|  

          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.5'  

          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'  

        end  

      end  

    end  

  end  
```

```ruby
  source 'https://github.com/QITechSDKs/iOS.git'  

  source 'https://cdn.cocoapods.org/'  

  target 'ExampleApp' do  

    use_frameworks!   

    pod 'QITechIosOCR', '~> 4.0.0'  

  end  

  

  post_install do |installer|  

    installer.pods_project.targets.each do |target|  

      if ['DatadogCore', 'DatadogInternal', 'DatadogCrashReporting', 'DatadogLogs'].include?(target.name)  

        target.build_configurations.each do |config|  

          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.5'  

          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'  

        end  

      end  

    end  

  end  
```

--------------------------------

### Search RentalAgreements GET Request

Source: https://docs.qitech.com.br/documentation/caas/car_rental/rental_agreement_v2

Example request URL demonstrating the use of date filters and pagination parameters.

```http
GET https://api.caas.qitech.app/car_rental/rental_agreements?initial_date=2019-10-01&final_date=2019-10-05&page_number=2&page_rows=20
```

--------------------------------

### Instalar dependências

Source: https://docs.qitech.com.br/documentation/caas/device_scan/ios/native_swift

Comando para baixar e instalar as dependências definidas no Podfile.

```bash
  pod install  
```

--------------------------------

### Security Consultation JSON Response

Source: https://docs.qitech.com.br/documentation/escrituracao/operacoes-ativas/consulta-security

Example of the JSON response body containing installment details and investment information.

```json
"investment_quantity": 100000,  

                                "amount": 20596.94,  

                                "paid_at": "2025-02-18T18:39:47.159822",  

                                "settlement_process_payment_status": "paid",  

                                "settlement_process_payment_type": "manual",  

                                "settlement_process_payment_receipt_list": [  

                                    {  

                                        "settlement_process_payment_receipt_key": "47fa434a-68cc-47d4-af8c-6a84061f38a6",  

                                        "settlement_process_payment_receipt_status": "confirmed",  

                                        "updated_at": "2025-02-18T18:39:47.153603"  

                                    }  

                                ]  

                            }  

                        ]  

                    }  

                ]  

            },  

            {  

                "installment_key": "dafc9683-a2b3-4bde-bf9a-ff4b2ea2599f",  

                "installment_status": "opened",  

                "installment_number": 2,  

                "workdays": 23,  

                "calendar_days": 35,  

                "principal_amortization_unit_price": 0.19671978,  

                "principal_amortization_amount": 19671.97807672,  

                "interest_amount": 924.96192328,  

                "interest_amount_unit_price": 0.00924962,  

                "post_fixed_interest_amount": 0.0,  

                "post_fixed_interest_amount_unit_price": 0.0,  

                "amount": 20596.94,  

                "due_principal": 80323.24361573,  

                "due_interest": 0.0,  

                "due_date": "2025-04-22",  

                "has_interest": true,  

                "current_unit_price": 0.19671978,  

                "latest_accrual_date": "2025-02-18",  

                "paid_at": null,  

                "paid_amount": 0.0,  

                "settlement_process_list": []  

            },  

            {  

                "installment_key": "aab04935-763e-4431-b0e8-d3d341d5c563",  

                "installment_status": "opened",  

                "installment_number": 3,  

                "workdays": 18,  

                "calendar_days": 27,  

                "principal_amortization_unit_price": 0.20058857,  

                "principal_amortization_amount": 20058.85739386,  

                "interest_amount": 538.08260614,  

                "interest_amount_unit_price": 0.00538083,  

                "post_fixed_interest_amount": 0.0,  

                "post_fixed_interest_amount_unit_price": 0.0,  

                "amount": 20596.94,  

                "due_principal": 60651.26553901,  

                "due_interest": 0.0,  

                "due_date": "2025-05-19",  

                "has_interest": true,  

                "current_unit_price": 0.20058857,  

                "latest_accrual_date": "2025-02-18",  

                "paid_at": null,  

                "paid_amount": 0.0,  

                "settlement_process_list": []  

            },  

            {  

                "installment_key": "6a76fd8f-631b-4b42-ac2e-daae8f87401d",  

                "installment_status": "opened",  

                "installment_number": 4,  

                "workdays": 22,  

                "calendar_days": 30,  

                "principal_amortization_unit_price": 0.20196604,  

                "principal_amortization_amount": 20196.60382686,  

                "interest_amount": 400.33617314,  

                "interest_amount_unit_price": 0.00400336,  

                "post_fixed_interest_amount": 0.0,  

                "post_fixed_interest_amount_unit_price": 0.0,  

                "amount": 20596.94,  

                "due_principal": 40592.40814515,  

                "due_interest": 0.0,  

                "due_date": "2025-06-18",  

                "has_interest": true,  

                "current_unit_price": 0.20196604,  

                "latest_accrual_date": "2025-02-18",  

                "paid_at": null,  

                "paid_amount": 0.0,  

                "settlement_process_list": []  

            }  

        ]  

    },  

    "investment_list": [  

        {  

            "investment_key": "4b705afb-18cb-4fe5-922a-5eab71c2b558",  

            "acquisition_date": "2025-02-18",  

            "acquisition_unit_price": 1.0,  

            "acquisition_amount": 100000.0,  

            "acquisition_quantity": 100000.0,  

            "investor_key": "a1a75b66-6f7e-4bcc-9ff5-6f8adf7cae09",  

            "investor_name": "Ultimate Cascade",  

            "investor_document_number": "31.424.651/0001-32",  

            "investor_bank_account": {  

                "account_type": "checking",  

                "account_digit": "3",
```

--------------------------------

### Debt Status Webhook Payload

Source: https://docs.qitech.com.br/documentation/roteiros_laas/webhooks_inss

Example of a debt webhook payload containing installment details and TED receipt information.

```json
{

                "principal_amortization_amount": 90.13524961  

            },  

            {  

                "due_date": "2026-02-10",  

                "total_amount": 116.76,  

                "installment_key": "e226d32f-33ec-4a20-ad60-96a0ec3216d7",  

                "pre_fixed_amount": 21.85468788,  

                "principal_amortization_amount": 94.90531212  

            },  

            {  

                "due_date": "2026-03-10",  

                "total_amount": 116.76,  

                "installment_key": "710e51e3-9720-4b6a-a383-569736781e28",  

                "pre_fixed_amount": 15.16506862,  

                "principal_amortization_amount": 101.59493138  

            },  

            {  

                "due_date": "2026-04-10",  

                "total_amount": 116.76,  

                "installment_key": "88cba573-627d-4ca0-b39e-0fcc20f22422",  

                "pre_fixed_amount": 11.45566586,  

                "principal_amortization_amount": 105.30433414  

            },  

            {  

                "due_date": "2026-05-10",  

                "total_amount": 116.76,  

                "installment_key": "0e51f217-21c8-4897-baee-2bd2aad43d22",  

                "pre_fixed_amount": 5.59829551,  

                "principal_amortization_amount": 111.16170449  

            }  

        ],  

        "ted_receipt_list": [  

            {  

                "fee": 0,  

                "url": "https://storage.googleapis.com/live-doc-api/documents/304b5b46-08e5-4.pdf",  

                "amount": 1000,  

                "origin": {  

                    "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",  

                    "type": "payment_account",  

                    "branch": "0001",  

                    "document": "32402502000135",  

                    "bank_code": "329",  

                    "account_key": "836ce4ef-855b-4672-bc52-36e32e22ec05",  

                    "branch_digit": null,  

                    "account_digit": "1",  

                    "account_branch": "0001",  

                    "account_number": "00852",  

                    "financial_institution_name": "QI SCD S.A."  

                },  

                "timestamp": "2024-10-14T03:09:17",  

                "description": "DESCRICAO",  

                "destination": {  

                    "name": "DEVEDOR",  

                    "type": "checking_account",  

                    "branch": "0648",  

                    "purpose": "Crédito PIX em Conta",  

                    "document": "04973666068",  

                    "bank_ispb": "90400888",  

                    "branch_digit": null,  

                    "account_digit": "7",  

                    "account_number": "25252",  

                    "financial_institution_name": "BCO SANTANDER (BRASIL) S.A."  

                },  

                "end_to_end_id": "E3240250220241014030292IkYMOt523",  

                "transaction_key": "797ab666-07c4-4702-a68b-1d67afb34534",  

                "origin_transaction_key": "af8aa38f-8a49-45bd-9878-101cefe9bdd4"  

            }  

        ],  

        "requester_identifier_key": "70675b9fe09da90c8b5c992"  

    },  

    "status": "disbursed",  

    "webhook_type": "debt",  

    "event_datetime": "2024-10-14 03:09:17"  

}
```

--------------------------------

### GET /onboarding/{type}/{id}

Source: https://docs.qitech.com.br/documentation/caas/onboarding/query_registration

Recupera o JSON mais atualizado de um cadastro específico de pessoa física ou jurídica.

```APIDOC
## GET /onboarding/natural_person/{id}
## GET /onboarding/legal_person/{id}

### Description
Recupera o objeto JSON atualizado de um cadastro específico. Retorna 404 caso o identificador não seja encontrado.

### Method
GET

### Endpoint
https://api.caas.qitech.app/onboarding/natural_person/{id}
https://api.caas.qitech.app/onboarding/legal_person/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - O identificador único do cadastro.
```

--------------------------------

### Debt Operation JSON Structure

Source: https://docs.qitech.com.br/documentation/guides/INSS/new-credit-and-refinancing/end-to-end

Example of the JSON structure for a debt operation, including installment details and interest rate configuration.

```json
{

                        "total_amount": 101.84,  

                        "workdays": 20.0,  

                        "installment_status": null,  

                        "installment_type": null  

                    }  

                ],  

                "first_due_date": "2025-01-20",  

                "prefixed_interest_rate": {  

                    "monthly_rate": 0.0166,  

                    "daily_rate": 0.00054142,  

                    "annual_rate": 0.21843191,  

                    "interest_base": "calendar_days_365"  

                }  

            }  

        ]  

    }  

}   
```

--------------------------------

### Exemplo de Implementação SDK 4.0.0+

Source: https://docs.qitech.com.br/documentation/caas/face_recognition/web/example

Exemplo completo de inicialização do SDK WebFaceRecon na versão 4.0.0 ou superior.

```html
<script src="https://facerecon.caas.qitech.app/face-recognition-4-2-1.js"></script>  

  

<script>  

  async function iniciarReconhecimentoFacial() {  

    // 1. Obtenha o clientSessionKey via chamada server-to-server  

    const clientSessionKey = await fetchClientSessionKey();  

  

    // 2. Configure e instancie o SDK  

    const webFaceRecon = new QITechWebFaceRecon.WebFaceRecon()  

      .setThemeConfiguration({  

        primaryColor:  "#2848A8",  

        tertiaryColor: "#57D9FF",  

        fontFamily:    "Verdana"  

      })  

      .setSandboxEnvironment()  

      .setSessionId("UNIQUE_SESSION_ID")  

      .build();  

  

    // 3. Inicializa (valida browser/dispositivo e carrega modelo)  

    await webFaceRecon.initialize();  

  

    // 4. Inicia a captura da prova de vida  

    const response = await webFaceRecon.open(clientSessionKey);  

    console.log(`Status: ${response.status}, Key: ${response.data}`);  

  }  

</script>
```

--------------------------------

### Financial Object Configuration with Rebates

Source: https://docs.qitech.com.br/documentation/guides/INSS/new-credit-and-refinancing/end-to-end

Example of a financial object structure including installment details, interest configuration, and rebate settings.

```json
{

    "financial": {

        "first_due_date": "2022-12-07",

        "installment_face_value": 100,

        "disbursement_date": "2022-11-03",

        "limit_days_to_disburse": 3,

        "number_of_installments": 24,

        "disbursed_amount": 1876,

        "interest_type": "pre_price_days",

        "fine_configuration": {

            "monthly_rate": 0.01,

            "interest_base": "calendar_days",

            "contract_fine_rate": 0.02

        },

        "credit_operation_type": "ccb",

        "interest_grace_period": 0,

        "principal_grace_period": 0,

        "rebates": [

            {

                "amount": 20,

                "rebate_bank_account": {

                    "name": "Teste Ltda",

                    "document_number": "18533555000164",

                    "account_digit": "0",

                    "account_number": "4290001",

                    "branch_number": "0001",

                    "bank_code": "329"

                },

                "amount_type": "percentage",

                "fee_type": "spread"

            }

        ]

    }

}
```

--------------------------------

### Estruturas de resposta do método .initialize()

Source: https://docs.qitech.com.br/documentation/caas/face_recognition/web/collecting_response

Representa o objeto de sucesso e os possíveis cenários de erro retornados durante a inicialização do SDK.

```json
{

  status: "SUCCESS",

  data: null

}
```

```json
{

  status: "FAILURE",

  reason: "UNSUPPORTED_BROWSER",

  description: "User browser is not supported."

}
```

```json
{

  status: "FAILURE",

  reason: "NOT_MOBILE_DEVICE",

  description: "User device is not mobile."

}
```

```json
{

  status: "FAILURE",

  reason: "INITIALIZATION_ERROR",

  description: "..."

}
```

--------------------------------

### Initialize Web OCR SDK Implementation

Source: https://docs.qitech.com.br/documentation/caas/ocr/web/initialize_info

Demonstrates instantiating the WebOCR class, configuring the UI, and initializing the capture flow with specific document templates.

```html
<!DOCTYPE html>  

<html lang="pt-BR">  

<head>  

    <meta charset="UTF-8">  

    <meta name="viewport" content="width=device-width, initial-scale=1.0">  

    <title>Web OCR</title>  

    <script src="https://ocr.caas.qitech.app/4-1-1/ocr.js"></script>  

</head>  

<body>  

    <div class="demo-app-container">  

        <button onclick="initOCR(['rg', 'cnh', 'rg_digital'])">  

            Iniciar coleta do documento  

        </button>  

    </div>  

</body>  

  

<script>  

    var webOCR = new QiTechWebOCR.WebOCR(  

        "<WEB_TOKEN>",  

        "<SESSION_ID>"  

    )  

    .setThemeConfiguration({  

        "companyLogo": "https://my_company/logo.png",  

        "primaryColor": "#FF9900",  

        "fontFamily": "Verdana"  

    })  

    .setShowInstructionScreen(true)  

    .setShowSuccessScreen(true)  

    .setShowAllowedTemplatesScreen(true)  

    .setSandboxEnvironment()  

    .build()  

  

    function initOCR(allowed_templates) {  

        webOCR.initialize(allowed_templates)  

        .then((ocr_results) => {  

            console.log(ocr_results)  

        })  

        .catch((error) => {  

            console.log(error)  

        })  

    }  

</script>  

</html>
```

--------------------------------

### Credit Operation Response Structure

Source: https://docs.qitech.com.br/documentation/guides/INSS/portability%2Brefinancing/maquinas-de-status

Example JSON response for a credit operation, including status, fine configuration, and installment details.

```json
{
	"credit_operation_key": "<CREDIT-OPERATION-KEY>",
	"contract_number": "00000002",
	"document_key": "<DOCUMENT-KEY da CCB de Refinanciamento>",
	"document_url": "<URL da CCB de Refinanciamento>",
	"credit_operation_status": "issued",
	"fine_configuration": {
		"contract_fine_rate": 0.02,
		"interest_base": "calendar_days",
		"monthly_rate": 0.01
	},
	"disbursement_options": [{
		"installments": [{
				"additional_costs": [],
				"bank_slip_key": null,
				"business_due_date": "2021-08-09",
				"calendar_days": 53,
				"digitable_line": null,
				"due_date": "2021-08-08",
				"due_interest": 0,
				"due_principal": 997.87,
				"fine_amount": null,
				"has_interest": true,
				"installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
				"installment_number": 1,
				"installment_status": "created",
				"installment_type": "principal",
				"paid_amount": 0,
				"paid_at": null,
				"post_fixed_amount": 0,
				"pre_fixed_amount": 54.84865004983954,
				"principal_amortization_amount": 306.98134995016045,
				"total_amount": 361.83,
				"workdays": 37
			},
			{
				"additional_costs": [],
				"bank_slip_key": null,
				"business_due_date": "2021-09-08",
				"calendar_days": 31,
				"digitable_line": null,
				"due_date": "2021-09-08",
				"due_interest": 0,
				"due_principal": 690.8886500498395,
				"fine_amount": null,
				"has_interest": true,
				"installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1",
				"installment_number": 2,
				"installment_status": "created",
				"installment_type": "principal",
				"paid_amount": 0,
				"paid_at": null,
				"post_fixed_amount": 0,
				"pre_fixed_amount": 21.964874249804833,
				"principal_amortization_amount": 339.86512575019515,
				"tax_amount": 0,
				"total_amount": 361.83,
				"workdays": 22
			}
		],
		"prefixed_interest_rate": {
				"annual_rate": 0.44556431,
				"daily_rate": 0.00564312,
				"monthly_rate": 0.0556431,
				"interest_base": "calendar_days_365"
		},
		"iof_amount": 50,
		"external_contract_fee_amount": 0,
		"external_contract_fees": [],
		"contract_fee_amount": 0,
		"contract_fees": [],
		"number_of_installments": 2,
		"disbursed_issue_amount": 997.87,
		"final_disbursement_amount": 100,
		"issue_amount": 1147.87,
		"disbursement_date": "2021-05-31",
		"cet": 1.212,
		"annual_cet": 32.122
	}],
	"disbursement_bank_account": {
		"account_digit": "1",
		"account_number": "00001",
		"ispb": "00000000",
		"branch_number": "0001"
	}
}
```

--------------------------------

### INSS API Response Structure

Source: https://docs.qitech.com.br/documentation/guides/INSS/new-credit-and-refinancing/end-to-end

Example of the JSON response body containing installment details and interest rate configurations for credit operations.

```json
{
	"fine_amount": null,
	"has_interest": true,
	"installment_number": 6,
	"post_fixed_amount": null,
	"pre_fixed_amount": 8.1972396908,
	"principal_amortization_amount": 93.6427603092,
	"tax_amount": 1.72770892770474,
	"total_amount": 101.84,
	"workdays": 22.0,
	"installment_status": null,
	"installment_type": null
},
{
	"additional_costs": [],
	"business_due_date": "2025-07-21",
	"calendar_days": 31,
	"due_date": "2025-07-21",
	"due_interest": 0.0,
	"due_principal": 390.7989345071,
	"fine_amount": null,
	"has_interest": true,
	"installment_number": 7,
	"post_fixed_amount": null,
	"pre_fixed_amount": 6.6127072945,
	"principal_amortization_amount": 95.2272927055,
	"tax_amount": 1.999011328473856,
	"total_amount": 101.84,
	"workdays": 21.0,
	"installment_status": null,
	"installment_type": null
},
{
	"additional_costs": [],
	"business_due_date": "2025-08-20",
	"calendar_days": 30,
	"due_date": "2025-08-20",
	"due_interest": 0.0,
	"due_principal": 295.5716418016,
	"fine_amount": null,
	"has_interest": true,
	"installment_number": 8,
	"post_fixed_amount": null,
	"pre_fixed_amount": 4.8387153664,
	"principal_amortization_amount": 97.0012846336,
	"tax_amount": 2.274874127227187,
	"total_amount": 101.84,
	"workdays": 22.0,
	"installment_status": null,
	"installment_type": null
},
{
	"additional_costs": [],
	"business_due_date": "2025-09-22",
	"calendar_days": 33,
	"due_date": "2025-09-22",
	"due_interest": 0.0,
	"due_principal": 198.570357168,
	"fine_amount": null,
	"has_interest": true,
	"installment_number": 9,
	"post_fixed_amount": null,
	"pre_fixed_amount": 3.5787172455,
	"principal_amortization_amount": 98.2612827545,
	"tax_amount": 2.570318634292211,
	"total_amount": 101.84,
	"workdays": 23.0,
	"installment_status": null,
	"installment_type": null
},
{
	"additional_costs": [],
	"business_due_date": "2025-10-20",
	"calendar_days": 28,
	"due_date": "2025-10-20",
	"due_interest": 0.0,
	"due_principal": 100.3090744135,
	"fine_amount": null,
	"has_interest": true,
	"installment_number": 10,
	"post_fixed_amount": null,
	"pre_fixed_amount": 1.5318141716,
	"principal_amortization_amount": 100.3081858284,
	"tax_amount": 2.8541691195612935,
	"total_amount": 101.84,
	"workdays": 20.0,
	"installment_status": null,
	"installment_type": null
}
],
"first_due_date": "2025-01-20",
"prefixed_interest_rate": {
	"monthly_rate": 0.0166,
	"daily_rate": 0.00054142,
	"annual_rate": 0.21843191,
	"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-08",
```

--------------------------------

### Podfile Configuration (v6.0.0+)

Source: https://docs.qitech.com.br/documentation/caas/face_recognition/ios/native_swift

Example configuration for SDK versions 6.0.0 and higher, which require static linkage.

```ruby
  source 'https://github.com/QITechSDKs/iOS.git'  

  source 'https://cdn.cocoapods.org/'  

  target 'ExampleApp' do  

    use_frameworks! :linkage => :static  

    pod 'QITechIosFaceRecon', '~> 8.0.0'  

  end  

  

  post_install do |installer|  

    installer.pods_project.targets.each do |target|  

      if ['DatadogCore', 'DatadogInternal', 'DatadogCrashReporting', 'DatadogLogs'].include?(target.name)  

        target.build_configurations.each do |config|  

          config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.5'  

          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'  

        end  

      end  

    end  

  end  
```

--------------------------------

### Refinancing Response JSON Structure

Source: https://docs.qitech.com.br/documentation/manual_consignado_privado/manual_refinanciamento

Example of the JSON response body containing installment schedules, interest rate definitions, and contract fee breakdowns.

```json
{
	"business_due_date": "2025-10-21",
	"calendar_days": 28,
	"due_date": "2025-10-21",
	"due_interest": 0.0,
	"due_principal": 100.3097347892,
	"fine_amount": null,
	"has_interest": true,
	"installment_number": 10,
	"post_fixed_amount": null,
	"pre_fixed_amount": 1.5318141718,
	"principal_amortization_amount": 100.3081858282,
	"tax_amount": 2.8048174921281284,
	"total_amount": 101.84,
	"workdays": 20.0,
	"installment_status": null,
	"installment_type": null
},
{
	"disbursement_date": "2024-11-14",
	"contract_fees": [
		{
			"fee_type": "spread",
			"fee_amount": 4.57
		},
		{
			"fee_type": "ted_fee",
			"fee_amount": 1.5
		}
	],
	"external_contract_fees": [
		{
			"fee_type": "spread",
			"fee_amount": 0.0,
			"tax_amount": 0.0,
			"net_fee_amount": 0.0
		}
	],
	"contract_fee_amount": 6.07,
	"external_contract_fee_amount": 0.0,
	"net_external_contract_fee_amount": 0.0,
	"assignment_amount": 917.77,
	"issue_amount": 913.2,
	"cet": "2,0200%",
	"annual_cet": "27,0870%",
	"base_iof": 15.755779674642707,
	"additional_iof": 3.47016,
	"total_iof": 19.23,
	"total_pre_fixed_amount": 105.1973906257,
	"installments": [
		{
			"additional_costs": [],
			"business_due_date": "2025-01-21",
			"calendar_days": 67,
			"due_date": "2025-01-21",
			"due_interest": 0.0,
			"due_principal": 913.2,
			"fine_amount": null,
			"has_interest": true,
			"installment_number": 1,
			"post_fixed_amount": null,
			"pre_fixed_amount": 33.7254045271,
			"principal_amortization_amount": 68.1145954729,
			"tax_amount": 0.3742215875281126,
			"total_amount": 101.84,
			"workdays": 44.0,
			"installment_status": null,
			"installment_type": null
		},
		{
			"additional_costs": [],
			"business_due_date": "2025-02-21",
			"calendar_days": 31,
			"due_date": "2025-02-21",
			"due_interest": 0.0,
			"due_principal": 845.0854045271,
			"fine_amount": null,
			"has_interest": true,
			"installment_number": 2,
			"post_fixed_amount": null,
			"pre_fixed_amount": 14.2997636051,
			"principal_amortization_amount": 87.5402363949,
			"tax_amount": 0.7034733396694164,
			"total_amount": 101.84,
			"workdays": 23.0,
			"installment_status": null,
			"installment_type": null
		},
		{
			"additional_costs": [],
			"business_due_date": "2025-03-21",
			"calendar_days": 28,
			"due_date": "2025-03-21",
			"due_interest": 0.0,
			"due_principal": 757.5451681322,
			"fine_amount": null,
			"has_interest": true,
			"installment_number": 3
		}
	],
	"first_due_date": "2025-01-21",
	"prefixed_interest_rate": {
		"monthly_rate": 0.0166,
		"daily_rate": 0.00054142,
		"annual_rate": 0.21843191,
		"interest_base": "calendar_days_365"
	}
}
```

--------------------------------

### Initialize Desktop Device Scan in JavaScript

Source: https://docs.qitech.com.br/documentation/caas/device_scan/web/desktop

Example of initializing the DeviceScan SDK and enabling desktop identification using the setDesktop method.

```html
<html>  

<head>  

    <script src="https://ds.viewpkg.com/device-scan-2-1-1.js"></script>  

</head>  

  

<script>  

    var deviceScan = new vPkg.DeviceScan('web_token', 'session_id')  

    deviceScan.setSandbox()  

    deviceScan.setDesktop(true)  

    deviceScan.info('event_type', 'event_id')  

        .then((res) => console.log(res))  

        .catch((error) => console.log(error))  

</script>  

</html>
```

--------------------------------

### Exemplo de Implementação SDK Versões 3.x

Source: https://docs.qitech.com.br/documentation/caas/face_recognition/web/example

Exemplo de implementação para versões anteriores à 4.0.0, que exigem um hostComponent no construtor.

```html
<script>  

  // Versões 3.x  

  var hostComponent = document.getElementById('webfacerecon');  

  var webFaceRecon = new QITechWebFaceRecon.WebFaceRecon(hostComponent)  

    .setThemeConfiguration({  

      "buttonColor": "#2848A8",  

      "fontColor": "#FFFFFF",  

      "backgroundColor": "#FFFFFF"  

    })  

    .setSandboxEnvironment()  

    .setSessionId('UNIQUE_SESSION_ID')  

    .build();  

  

  webFaceRecon.initialize()  

    .then(() => fetchClientSessionKey())  

    .then(clientSessionKey => webFaceRecon.open(clientSessionKey))  

    .then(response => console.log(`Status: ${response.status}, Key: ${response.data}`))  

    .catch(error => {  

      console.error(error);  

      alert(error.reason || error);  

    });  

</script>
```

--------------------------------

### Credit Operation Response Body

Source: https://docs.qitech.com.br/zh-Hans/llm/zh-Hans/produto-.92d42d61c2.md

Example of a successful 200 OK response containing credit operation details, interest rates, tax configurations, and installment schedules.

```json
{
    "disbursement_date": "2025-09-24",
    "issue_amount": 2821.32,
    "interest_type": "pre_price_days",
    "assignment_amount": 2829.78,
    "base_iof": 10.6,
    "total_iof": 21.32,
    "additional_iof": 10.72,
    "cet": 5.09,
    "annual_cet": 81.39,
    "first_due_date": "2025-10-24",
    "disbursed_amount": 2800,
    "prefixed_interest_rate": {
        "annual_rate": 0.6935459998,
        "daily_rate": 0.0014644728,
        "interest_base": "calendar_days",
        "monthly_rate": 0.04488
    },
    "tax_configuration": {
        "base_rate": 8.2e-05,
        "additional_rate": 0.0038
    },
    "fees": [
        {
            "amount": 0.3,
            "fee_amount": 8.46,
            "amount_type": "percentage",
            "fee_type": "spread",
            "type": "internal"
        }
    ],
    "installments": [
        {
            "due_date": "2025-10-24",
            "amount": 1507.4,
            "due_principal": 2821.32,
            "due_interest": 0,
            "has_interest": true,
            "period": 1,
            "period_workdays": 1.1,
            "calendar_days": 30,
            "workdays": 22,
            "installment_number": 1,
            "period_to_disbursement": 1,
            "prefixed_amount": 126.62248868,
            "period_workdays_to_disbursement": 1.1,
            "calendar_days_to_disbursement": 30,
            "workdays_to_disbursement": 22,
            "tax_amount": 3.39671268,
            "principal_amortization_amount": 1380.77751132
        },
        {
            "due_date": "2025-11-24",
            "amount": 1507.4,
            "due_principal": 1440.54248868,
            "due_interest": 0,
            "has_interest": true,
            "period": 1,
            "period_workdays": 1,
            "calendar_days": 31,
            "workdays": 20,
            "installment_number": 2,
            "period_to_disbursement": 2,
            "prefixed_amount": 66.85751132,
            "period_workdays_to_disbursement": 2.1,
            "calendar_days_to_disbursement": 61,
            "workdays_to_disbursement": 42,
            "tax_amount": 7.20559353,
            "principal_amortization_amount": 1440.54248868
        }
    ]
}
```

--------------------------------

### Request Body Example

Source: https://docs.qitech.com.br/zh-Hans/llm/zh-Hans/produto-outros.508d6e2d2a.md

Example JSON payload for opening a document batch.

```json
{
  "type": "social_security_external_batch",
  "certifier_type": "qi_sign",
  "batch_name": "Lote INSS - pedido-2025-03-001",
  "request_control_key": "5ed20003-0610-46d2-88cc-a5d0de640696"
}
```
Tokens:
Raw