Issuance of Corporate debt
With the debt issuance API, it is possible to request the issuance of a debt for a legal entity. It is not necessary to pre-register the borrower; simply provide the registration details at the time of the debt request.
QI Tech offers a solution for onboarding new clients and anti-fraud.
Check out the documentation for these APIs here..
To receive a quote, contact our sales team:
comercial@qitech.com.br or (11) 3522-1301.
The debt API is designed to be executed in just one request, after a prior upload of files (document upload). The header and body signature format for this request is described in detail here.
Request
Request Body
{
"borrower": {
"name": "RAZAO SOCIAL EMPRESA",
"email": "emailempresa@email.com",
"phone": {
"number": "991112222",
"area_code": "11",
"country_code": "055"
},
"address": {
"city": "São Paulo",
"state": "SP",
"number": "215",
"street": "Rua Gilberto Sabino",
"complement": "3 andar",
"postal_code": "05425020",
"neighborhood": "Pinheiros"
},
"cnae_code": "6822-6/00",
"role_type": "issuer",
"person_type": "legal",
"company_type": "ltda",
"trading_name": "NOME FANTASIA DA EMPRESA",
"foundation_date": "2019-07-05",
"attached_documents_list": [],
"company_document_number": "80282008000127",
"company_statute": "aa28e598-55e2-40f1-8884-671772c541a1",
"company_representatives": [
{
"name": "NOME DO REPRESENTANTE",
"email": "nomedorepresentante@email.com",
"phone": {
"number": "990121234",
"area_code": "11",
"country_code": "055"
},
"is_pep": false,
"spouse": {
"name": "NOME CONJUGE REPRESENTANTE",
"email": "conjugerepresentante@email.com",
"phone": {
"number": "988881234",
"area_code": "11",
"country_code": "055"
},
"birth_date": "1994-12-04",
"person_type": "natural",
"is_pep": false,
"mother_name": "NOME DA MAE DO CONJUGE DO REPRESENTANTE",
"individual_document_number": "26571990032",
"document_identification_number": "10101010100",
"address": {
"city": "São Paulo",
"state": "SP",
"number": "215",
"street": "Rua Gilberto Sabino",
"complement": "3 andar",
"postal_code": "05425020",
"neighborhood": "Pinheiros"
}
},
"address": {
"city": "São Paulo",
"state": "SP",
"number": "215",
"street": "Rua Gilberto Sabino",
"complement": "3 andar",
"postal_code": "05425020",
"neighborhood": "Pinheiros"
},
"role_type": "company_representative",
"birth_date": "1993-09-10",
"profession": "DIRETOR",
"mother_name": "NOME DA MAE DO REPRESENTANTE",
"nationality": "BRASILEIRO",
"person_type": "natural",
"marital_status": "married",
"property_system": "partial_communion_of_goods",
"attached_documents_list": [],
"individual_document_number": "31057466093",
"document_identification_number": "20202020200"
}
]
},
"financial": {
"disbursed_amount": 10000,
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"monthly_interest_rate": 0.03,
"disbursement_date": "2023-05-04",
"first_due_date": "2023-06-03",
"interest_grace_period": 0,
"principal_grace_period": 0,
"number_of_installments": 1,
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
}
},
"disbursement_bank_account": {
"name": "RAZAO SOCIAL EMPRESA",
"document_number": "80282008000127",
"bank_code": "341",
"branch_number": "8615",
"account_number": "22110",
"account_digit": "2",
"account_type": "checking_account"
},
"purchaser_document_number": "32402502000135"
}
Response
The response to this debt request will return the payment plan as well as a DEBT-KEY, which is the debt identifier in QI SCD.
Response Body
{
"data": {
"additional_iof": 38.57988,
"annual_cet": "71,3492%",
"assignment_amount": 10254.13,
"base_iof": 12.487704111671501,
"borrower": {
"document_number": "80282008000127",
"name": "RAZAO SOCIAL EMPRESA",
"related_party_key": "7620181e-f46a-45c1-a4ea-60439b9662ad"
},
"cet": "4,5900%",
"collaterals": [],
"contract": {
"number": "0000069971/RSE",
"signature_information": [
{
"signature_url": null,
"signer_document_number": "31057466093",
"signer_email": "nomedorepresentante@email.com",
"signer_external_key": null,
"signer_name": "NOME DO REPRESENTANTE",
"signer_role": "issuer"
}
],
"urls": [
"https://storage.googleapis.com/sandbox-doc-api/documents/df3e4530-3deb-4ba8-ad4e-c28ebeffb831/20230504122831.pdf"
]
},
"contract_fee_amount": 101.53,
"contract_fees": [
{
"fee_amount": 101.53,
"fee_type": "tac"
}
],
"external_contract_fee_amount": 101.53,
"external_contract_fees": [
{
"fee_amount": 101.53,
"fee_type": "spread",
"net_fee_amount": 92.14,
"tax_amount": 9.39
},
{
"fee_amount": 0,
"fee_type": "tac",
"net_fee_amount": 0,
"tax_amount": 0
}
],
"installments": [
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2023-06-05",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2023-06-03",
"due_interest": 0,
"due_principal": 10152.6,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "0eb42a83-557a-437a-9819-099b5364cde9",
"installment_number": 1,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 10152.6,
"original_pre_fixed_amount": 300.3450311613816,
"original_principal_amortization_amount": 10152.60496883862,
"original_total_amount": 10452.95,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 300.3450311613816,
"principal_amortization_amount": 10152.60496883862,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 12.487704111671501,
"total_accrual_amount": null,
"total_amount": 10452.95,
"total_paid_amount": 0,
"workdays": 21
}
],
"iof_charge_method": "financed",
"issue_amount": 10152.6,
"net_external_contract_fee_amount": 92.14,
"number_of_installments": 1,
"prefixed_interest_rate": {
"annual_rate": 0.42576089,
"created_at": "2023-05-04T12:28:30",
"daily_rate": 0.00097227,
"interest_base": "calendar_days_365",
"monthly_rate": 0.03
},
"requester_identifier_key": "feceb7fe-1305-45eb-899d-c87d36bcc534",
"total_iof": 51.07,
"total_pre_fixed_amount": 300.3450311613816
},
"event_datetime": "2023-05-04 12:28:35",
"key": "feceb7fe-1305-45eb-899d-c87d36bcc534",
"status": "waiting_signature",
"webhook_type": "debt"
}
Object Request Body
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| borrower * | object | Object Borrower - Credit operation borrower | - |
| guarantor | object | Object Guarantor - Credit operation guarantors | - |
| disbursement_bank_account * | object | Object Disbursement Bank Account - Bank account details for the operation disbursement | - |
| financial * | object | Object Financial - Bank account details for the operation disbursement. Identifier indicating that the sent object is an individual. It must ALWAYS contain the value "natural" for individual borrowers | - |
| purchaser_document_number * | string | CNPJ do cessionário (comprador) da operação de crédito | - |
Object Borrower
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| name * | string | Company's corporate name | 100 |
| trading_name * | string | Nome fantasia | |
| email * | string | Company's institutional email | 254 |
| phone * | object | Object Phone - Company's phone number | - |
| is_pep * | boolean | PEP indicator (http://www.portaldatransparencia.gov.br/download-de-dados/pep) | - |
| address * | object | Object Address - Borrower's address |
| - | | role_type * | enum | default: issuer | - | | person_type * | string | Legal entity indicator - default: legal | - | | company_document_number * | string | CNPJ (numbers only) | - | | cnae_code * | string | National Classification of Economic Activities | | | company_representatives * | array of objects | List of the company's legal representatives | Object Company Representatives | | company_type * | enum | Company type: "ltda", "sa", "micro_enterprise" ou "freelancer"| - | | company_statute * | string | document_key of the company's articles of association PDF | | | directors_election_minute | string | document_key of the company's election minutes PDF (mandatory only for companies with company_type "sa") | | | foundation_date * | date | Company opening date (format "YYYY-MM-DD") | |
As shown above, both the "borrower" field and the "guarantors" fields can be populated by either a PF Object or a PJ Object. The PJ Object represents a legal entity in QI Tech.
Object Company Representatives
| Filed | Description | Exampe | Máx. Caract. |
|---|---|---|---|
| person_type * | string | Identifier indicating that the sent object is an individual or a legal entity. | natural |
| name * | string | Corporate name for corporate operations or person's name for person operations. Limited to 100 characters. | |
| mother_name * | string | Mother's name of the client in case of person. Limited to 100 characters. | |
| birth_date * | string | Date of birth of the person (format "YYYY-MM-DD") | - |
| profession * | string | Client's profession. Limited to 64 characters. | 64 |
| nationality * | string | Client's nationality. | 50 |
| marital_status * | string | Client's marital status.l do cliente. | |
| property_system * | string | Property separation regime (mandatory only for individuals with marital_status "married").. | Enumeradores property_system |
| wedding_certificate * | string | DOCUMENT_KEY of the marriage certificate PDF (previously sent). If marital_status is "single," the value of this field must be NULL.. | |
| spouse * | string | Object Spouse (Mandatory only when "compulsory_separation_of_goods" is "total_communion_of_goods," "partial_communion_of_goods," "final_participation_of_acquisitions," or "compulsory_separation_of_goods." If marital_status is "single," the value of this field must be NULL. | Object Spouse |
| is_pep * | boolean | Declaration if the person is PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | true/false |
| individual_document_number * | string | Person's CPF (numbers only). | 10 |
| document_identification * | string | DOCUMENT_KEY of the photo identification document PDF (RG or CNH) (previously sent) | |
| document_identification_back | string | DOCUMENT_KEY of the back side of the photo identification document PDF (RG or CNH) (previously sent). | |
| document_identification_type * | string | Qual o tipo do documento de identificação enviado. | |
| document_identification_number * | string | Identification document number of the person sent in "document_identification". | 16 |
| email * | string | Client's email. | 254 |
| phone * | object | Client's phone number. | Object Phone |
| address | object | Client's address. | Object Address |
| proof_of_residence | string | DOCUMENT_KEY of the address proof PDF (previously sent). | - |
Object Spouse
| Field | Description | Example | Max. Caract. |
|---|---|---|---|
| person_type * | string | Identifier indicating that the sent object is an individual or a legal entity. | natural |
| name * | string | Corporate name for corporate operations or person's name for person operations. Limited to 100 characters. | |
| mother_name * | string | Mother's name of the client in case of person. Limited to 100 characters | |
| birth_date * | string | Date of birth of the person (format "YYYY-MM-DD") | - |
| profession * | string | Client's profession. Limited to 64 characters. | 64 |
| is_pep * | boolean | Declaration if the person is PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | true/false |
| individual_document_number * | string | Person's CPF (numbers only). | 10 |
| document_identification_number * | string | Identification document number of the person sent in "document_identification". | 16 |
| email * | string | Client's email | 254 |
| phone * | object | Client's phone number. | Object phone |
| address | object | Client's address. | Object address |
Object Address
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| city * | string | City | 100 |
| state * | string | Address state (with two uppercase characters) | 2 |
| number * | string | Address Numner | 10 |
| street * | string | Steet | 100 |
| complement * | string | Address complement (free text) | 100 |
| postal_code * | string | Postal Code (http://www.buscacep.correios.com.br/sistemas/buscacep/) | 8 |
| neighborhood * | string | Neighborhood | 100 |
Object Phone
| Field | Description | Example | Max. Caract. |
|---|---|---|---|
| number * | string | Phone number | 10 |
| area_code * | string | Phone area code (DDD) (https://ddd.guiamais.com.br/) | 2 |
| country_code * | string | Phone DDI code (https://ddi.guiamais.com.br/) | 3 |
Object Disbursement Bank Account
A debt issuance must contain the bank information for disbursement, by default, an account held by the debtor.
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| name | string | Account owner's name |
| 50 | | document_number | string | Account owner's CPF | 11 | | bank_code * | string | Financial institution's COMPE code financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 | | branch_number * | string | Branch number (do not include the branch check digit!) | 4 | | account_number * | string | Account number (without the account check digit!) | 10 | | account_digit * | string | Account check digit (use zero in place of letters) | 1 | | account_type | enum | Enumerador Account Type Account type | 1 |
Object Financial
The financial object describes the financial information of the issuance. Here, the interest rate, grace period, and debt value, among others, are defined. The Financial Object has the fields described below, but it is important to note that some fields are optional and mutually exclusive (if one is available, the other should not be sent).
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| amout | float | Issue/Nominal value of the credit operation | - |
| interest_type | object | Enumerador Interest Type - Amortization method and interest calculation method | - |
| credit_operation_type | object | Enumerador Credit Operation Type - Credit contract type | - |
| annual_interest_rate | float | Pre-fixed interest rate expressed in decimal per year | - |
| disbursement_date | date | Operation disbursement date | - |
| interest_grace_period | int | Interest grace period (in months) | - |
| principal_grace_period | int | Principal grace period | - |
| number_of_installments | int | Number of installments of the credit operation | - |
| fine_configuration | object | Object Fine Configuration - Late interest and penalty configuration | - |
Object Fine Configuration
In the Fine Configuration Object, the penalty and late interest amounts of the credit operation are provided.
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| contract_fine_rate | float | Penalty rate for delay | - |
| interest_base | enum | Enumerador Interest Base - Interest calculation base | - |
| monthly_rate | float | Monthly late interest rate | - |
Object Rebates
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| fee_type * | enum | Fee Type. | - |
| amount_type * | object | Amount Type. | - |
| amount * | object | Fee amount. If the fee type is percentage, the value must be between 0 and 100. | - |
Response Body
| Field | Type | Description | Max. Caract. |
|---|---|---|---|
| data[n].data | object | Object Data | - |
| data[n].event_datetime | date | Moment of credit operation generation | - |
| data[n].key | string | DEBT-KEY - Unique key of the credit operation within QI | - |
| data[n].status | string | Possible status of a debt | - |
| data[n].type | string | debt | - |
Enumerators
Person Type_Enumerators
| Enumerator | Description |
|---|---|
| legal | Corporate |
| natural | Person |
Amount Type_Enumerators
| Enumerator | Description |
|---|---|
| tac | Fee charged to the borrower. |
| spread | Fee charged to the fund added to the operation's transfer price. |
Account Type_Enumerators
| Enumerator | Description |
|---|---|
| checking_account | checking account |
| deposit_account | deposit account |
| guaranteed_account | guaranteed account |
| investment_account | investment account |
| payment_account | payment account |
| saving_account | saving account |
| salary_account | salary account |
Interest Type_Enumerators
| Enumerator | Description |
|---|---|
| pre_price_days | Price amortization method (equal installments) with calculation of pre-fixed interest per day |
| pre_price | Price amortization method (equal installments) with pre-fixed interest calculation in fixed periods (30 days) |
| pre_sac | SAC amortization method (constant amortization) with pre-fixed interest calculation per day |
| post_sac | SAC amortization method (constant amortization) with interest calculation based on a pre-fixed rate + post-fixed indexer (CDI, IPCA, or IGPM) per day |
| post_price | Price amortization method (equal installments) with interest calculation based on a pre-fixed rate + post-fixed indexer (CDI, IPCA, or IGPM) in fixed periods (30 days) |
| post_price_days | Price amortization method (equal installments) with interest calculation based on a pre-fixed rate + post-fixed indexer (CDI, IPCA, or IGPM) per day |
Credit Operation Type_Enumerators
| Enumerator | Description |
|---|---|
| ccb | Cédula de Crédito Bancário |
| cce | Cédula de Crédito à Exportação |
| cci | Cédula de Crédito Imobiliário |
| nce | Nota de Crédito à Exportação |
Interest Base_Enumerators
| Enumerator | Description |
|---|---|
| workdays | Interest calculation base in business days considering a year of 252 days |
| calendar_days | Interest calculation base in business days considering a year of 360 days |
| calendar_days_365 | Interest calculation base in business days considering a year of 365 days |
Fee Type_Enumerators
Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech
| Enumerator | Description |
|---|---|
| tac | Registration opening fee |
| spread | Spread charged on the acquisition value of the credit operation |
| warranty_analysis | Warranty analysis fee |
| ted_fee | TED Fee |
| spread_ted_fee | TED fee spread charged on the acquisition value of the credit operation |