Skip to main content

Custom Variables

To provide total flexibility in building your business, you can define and edit specific fields in the People, Companies, Employers and Requests Registrations that are important for your management and for filling out your Contract Model.

We will then validate and save these fields (which we call Variables) for you throughout the credit granting process. These variables will be injected into the context of rendering and filling out the contract for a Request, and are returned to you in queries to Requests (applications) and Person and Company Registrations, whenever you need them.

Example: A common use case is when the Originator requests the RENAVAM of a vehicle to be given as collateral, to assist the Financier in the process of approving a Request and for inclusion in the Loan Agreement (CCB).

As variáveis podem ser usadas em:

  • Creating Credit Requests

  • Individual Recipient Registration

  • Registration of Legal Entities Recipients

  • Individual Consenting Party Registration

  • Registration of Legal Entities

  • Individual Guarantor Registration

  • Registration of Corporate Guarantors

Supported variable types are: TEXT, NUMBER, DATE and BOOLEAN.

Attention point: The most common fields in credit products already exist in our API, so before creating a new variable, it is worth checking if it does not already exist in the API.

Exemplo de JSON com um "custom_variable" na requisição de uma nova Solicitação​

Mais detalhes em: Requests

JSON

"custom_variables": { "values": { "renavam": "<string>", "chassi": "<string>" } }