DOCSEARCHbyAlgolia
Submit Docs

QI Tech API Documentation

website·Indexed 34 days ago

https://docs.qitech.com.br

Developer documentation for QI Tech's financial services, including BaaS (Banking as a Service) and CaaS (Card as a Service). Features include endpoints for Pix transfers, TED transactions, account movements, card issuance, debt simulation, and CNAB 444 file examples.

Tokens
2.6M
Snippets
10.4K
Records
15.8K
Agent score
52%

What's inside QI Tech

  1. Overview of asset settlement methods

    Settlement (write-off) of assets held in a fund's portfolio can be achieved through two primary methods. Both methods result in the same payment batch and reconciliation process.

    1. File Upload (Portal): Best for high-volume daily routines using bank return files. Supports CNAB 444 and CSV formats. Available in the Manager and Consultant portal.
    2. API Insertion: Best for one-off settlements and real-time integrations. Uses JSON format via the Asset Settlement API.

  2. Overview of QI Tech Ancillary Financial Products

    Beyond payroll loans and cards, QI Tech provides the following specialized services:

    • QI Sign: Electronic signature services.
    • BNPL E-commerce: 'Buy Now Pay Later' integration for e-commerce platforms.
    • Credit Rights Negotiation: Negotiation and assignment of receivables.
    • Crédito Clean: Clean credit issuance APIs.

  4. Overview of QI Tech iOS OCR SDK

    The QI Tech iOS OCR (Optical Character Recognition) SDK allows applications to capture images of customer documents (such as Driver's Licenses or Identity Cards) and send them to the QI Tech OCR API for recognition. Captured documents can then be referenced via a key across other QI Tech system products.

  5. Overview of Pix Automatico Journey 1 (No QR Code)

    Journey 1 allows a receiver to request recurring payment authorization from a payer directly within the payer's banking app. This method eliminates the need for the payer to scan a QR Code. It is ideal for scenarios where there is an active contact (phone, chat, in-person) or an existing relationship with the customer. The process involves the receiver creating the recurrence using the payer's account data, after which the payer receives an app notification to approve the recurrence.

  6. Overview of QI Tech Prepaid Card Issuance

    QI Tech provides APIs that allow partners to act as sub-issuers, enabling their own customers to request and issue both physical and virtual prepaid cards. All API calls require authentication and the service must be explicitly enabled by the QI Tech team.

  7. Overview of QI Tech Authentication Session Management API

    The Authentication Session Management API is designed to control the complete user KYC (Know Your Customer) flow. It organizes the authentication process by allowing the creation of KYC registration sessions with customized flows. It integrates with other QI Tech authentication services, including Device Scan, Face Recognition, and OCR. The API provides a link that initiates a web page to guide users through the defined KYC steps and collects the necessary information for subsequent analyses, such as individual registration or pre-transactional analysis.

  8. Overview of QI Tech Account Monitoring API

    The Account Monitoring API allows users to monitor individuals (Pessoas Físicas) and legal entities (Pessoas Jurídicas) across various monitoring topics with customizable intervals.

    Monitoring topics for Individuals:

    • OFAC (Office of Foreign Assets Control)
    • UNSC (United Nations Security Council)
    • IBAMA (Environmental Penalties)
    • PEP (Politically Exposed Persons)
    • Receita Federal (Taxpayer registration status)

    Monitoring topics for Legal Entities:

    • OFAC (Office of Foreign Assets Control)
    • UNSC (United Nations Security Council)
    • IBAMA (Environmental Penalties)
    • CEIS (Ineligible and Suspended Companies)
    • CNEP (National Registry of Punished Companies)
    • Receita Federal (Taxpayer registration status)

    Intervals are defined per monitoring topic and person type (e.g., OFAC can be monitored every 10 days for individuals and every 30 days for legal entities).

  9. Overview of the Private Payroll Loan Auction Workflow

    The private payroll loan auction process consists of four primary stages:

    1. Loan Request Filter Configuration: Setting up filters to define the target audience for loan requests.
    2. Webhook Reception and Proposal Submission: Receiving filtered loan request webhooks, simulating credit conditions, and submitting a proposal to the internal auction.
    3. Proposal and Signature Tracking: Monitoring webhooks for internal auction updates and the signing of the credit operation.
    4. Averment Authorization and Disbursement Tracking: Authorizing the averment (registration of the loan) and managing potential failures during the averment or disbursement phases.

  10. Overview of Brazilian Army Payroll Loan Origination

    The API enables the origination of CCB payroll loans for active, inactive, and pensioner members of the Brazilian Army. The entire lifecycle—margin inquiry, issuance, registration (averbação), disbursement, and cancellation—is managed via the Zetra (eConsig) platform. The service operates 24/7, including holidays.
    {
  "collateral_type": "military_payroll",
  "instrument": "CCB (via POST /debt)"
}

  11. Overview of the consolidated_credit_rights_conciliation_assets report

    The consolidated_credit_rights_conciliation_assets report lists payment events for credit rights registered on a specific accounting date. It tracks the effect of each payment on the asset value, including the value before and after payment, the reduction, and the calculated accounting result. This report consolidates two types of assets: credit operations (e.g., CCB) and discounted credit rights (e.g., duplicates). It replaces the legacy reports credit_rights_conciliation_assets, credit_rights_conciliation_installments, and discounted_credit_rights_conciliation_assets.

  12. Overview of the Asset Settlement process

    The Asset Settlement process allows for recording installment payments, amortizations, repurchases, and other settlement events for assets in an investment fund's portfolio.

    Scope: This flow applies exclusively to credit rights (such as CCBs, invoices, and contracts) already included in the fund's portfolio. It does NOT apply to Treasury Bills, Debentures, or other fixed-income assets.

    Prerequisites:

    1. Access must be enabled for Sandbox and Production environments by contacting integracao.dtvm@qitech.com.br.
    2. You must have the fund_class_key (fund key), which is required in the base URL for all endpoints: /settlement/fund_class/{fund_class_key}.