Explore our APIs
Our APIs
This portal contains information to help you integrate with our APIs.
Purpose
This documentation guides the implementation of a set of MOVA APIs, from feeding databases and creating the quotation to formalizing and signing the proposal, giving access to several types of "Credit Products".
About the Setup:
Creating the Credit Product
The MOVA platform includes a system called "BLOCS Platform". With this system, new credit products can be created immediately, based on available templates called "Blueprints". These templates cover products for both individuals and companies. A "Credit Product" works as its own operational workflow, so each one can be managed separately within MOVA. For this reason, each client that contracts one of these products can receive its own exclusive "Product Code" ("product_id"). Once our sales and product teams identify the Requester's needs, the "Blueprint" to be used is defined and the product is created on the platform. Once the "Credit Product" — understood as its operational flow — is created, the "Credit and Anti-Fraud Engine" that will process the Quotation information is configured and parameterized as appropriate for each context. A single Requester can have several "Credit Products" and therefore more than one product_id. Besides running more complex flows, the concept of "Credit Product" also includes sending Quotations simply to query Credit Bureaus and Databases, once the authorizations and consents have been collected from the subject of the analysis.
API Key
MOVA's support team will provide one or more "Api Keys" to the Requester. The "Api Key" is authenticated on every request and must be sent in the call's "Header".
Client Code
In addition to the "Api Key", MOVA's support team will provide a "Client Code" ("mova-client-id"). This code is unique per Requester. The "mova-client-id" is authenticated on every request and must also be sent in the call's "Header". This code, randomly generated and usually 36 alphanumeric characters long, ensures, together with the Api Key, that the Requester actually has access to the requested "Credit Product". In other words, multiple authentication points ensure that only authorized Requesters can create Quotations for their respective "Credit Products".
Product Code
In addition to the "Api Key" and the "mova-client-id" ("Client Code"), MOVA's support team will provide a "Product Code" ("product_id") for the Client's "Credit Product". This "Product Code" must be sent in the call payload, in the "product_id" field. The call will only be accepted if the "Api Key", the "Client Code" and the "Product Code" are correct and consistent with each other. The "Product Code" ("product_id") identifies which "Credit Product" is being triggered and links the call to it. This "Product Code" is widely used in the Platform's controls, including for generating tracking reports.
Rate Limiting
MOVA applies a Rate Limit policy to control the volume of requests per client in its environments. These limits ensure the stability and performance of the services.
Default Limit
In the Staging and Homologation environments, the default limit is Topázio.
Rate Limit Plans
If you need a different limit, contact MOVA support for evaluation.
| Level | Plan | Rate Limit (req/min) | Req/30 Days (8h/day) |
|---|---|---|---|
| 1 | Ágata | 50 | 720 K |
| 2 | Topázio | 100 | 1.44 M |
| 3 | Esmeralda | 200 | 2.88 M |
| 4 | Safira | 500 | 7.2 M |
| 5 | Diamante | 600 | 8.64 M |
Spike Arrest
| Staging | Homolog | Production |
|---|---|---|
| 5 req/s | 5 req/s | 25 req/s |
General Considerations
Given the potential particularities of a given "Credit Product" and possible customizations, some of the information presented here may vary depending on context and agreed configurations. In these cases, the parties should provide a specific version of the documentation to cover those variations.
Help
We are here to help you in the best way possible ;)
Contact us here