Introduction
QI DTVM is a financial institution that provides Investment Fund Administration and Custody services. We offer a range of services through REST APIs that enable a new experience across the entire operation, focused on convenience, automation and full transparency for everyone involved.
The purpose of this documentation is to describe the flows, endpoints and data structures required to operate any Investment Fund.
Note: if you have questions at any stage of the process, please contact integracao.dtvm@qitech.com.br describing your problem or question and we will assist you.
Access Profiles
In our system, we identify the user by the profile they assume within the QI DTVM structure. There are 6 profiles:
- Managers;
- Consultants;
- Originators;
- Assignors;
- Investors;
- Distributors.
Each profile has its own host, with the routes made available to it — see Environments (Hosts).
To have an Access Profile created so you can use our APIs, please contact our team at integracao.dtvm@qitech.com.br.
Managers and consultants only provide the name, e-mail and CPF of the responsible master user and, from there, create the integration and register the public key through the portal itself — without sending keys by e-mail. See Integration via the portal.
Where to start
- Create the integration: Integration via the portal (managers and consultants) or Key exchange (other profiles).
- Make your first call: Authentication test.
- Learn how to read errors and retry safely: API errors.
Environments (Hosts)
QI DTVM has two environments, Sandbox and Production. Both environments have completely identical code and behavior; however, the Sandbox environment uses entirely fictitious monetary values, while the Production environment carries out valid financial transactions.
The Sandbox environment was created for developers to build their integrations. When they are ready to go live, they only need to update the environment variables with the Production parameters.
Each profile has its own host. An API key is only recognized on the host of the profile it was issued for: a manager's key sent to the assignor host is rejected as Invalid API Key, even with a correct signature.
| Your profile | Sandbox | Production |
|---|---|---|
| Manager (fund manager) | https://manager-api.sandbox.qidtvm.com.br | https://manager-api.qidtvm.com.br |
| Consultant (consultancy) | https://consultant-api.sandbox.qidtvm.com.br | https://consultant-api.qidtvm.com.br |
| Assignor | https://assignor-api.sandbox.qidtvm.com.br | https://assignor-api.qidtvm.com.br |
| Originator | https://originator-api.sandbox.qidtvm.com.br | Provided by the integration team |
| Investor | https://investor-api.sandbox.qidtvm.com.br | https://investor-api.qidtvm.com.br |
| Distributor | https://distributor-api.sandbox.qidtvm.com.br | https://distributor-api.qidtvm.com.br |
Use the profile QI provided when the integration was created — or, if you created the integration through the portal, the profile of the portal where it was registered. A Sandbox API key does not work in Production, and vice versa.
In addition to the per-profile hosts, there is a public host in Production, https://api.qidtvm.com.br.
Real data from natural persons and/or legal entities must not be used in QI Tech's Sandbox environments.