Intro

This API is meant to query Círculo de Crédito - Personas Físicas (Consumers' database).
In the answer the XML files sent to and received from Círculo de Crédito will be included.

Important points

encabezado section

claveOtorgante
This key is provided from Círculo de Crédito.

If you need more information about the products, please reach out to your Círculo de Crédito contact

Círculo de Crédito credentials

"usuario" : a code provided by Círculo de Crédito to identify your company
"claveOtorgante" : username to identify the person who is going to do the query.
"contraseña" : password for the provided claveOtorgante.

if you want to use "Vault", you can provide variables instead of hardcode the credentials.
For example, instead of writing :

"encabezado": {
    "claveOtorgante": "0123456789",
    "contrasena": "USER123456",
    "usuario": "230714"
  },

You should use the next:

{
 "encabezado": {
    "claveOtorgante": "@vault:secretVaultName:1",
    "contrasena": "@vault:secretVaultName:2",
    "usuario": "230714"
  },

Where secretVaultName is the name of the credential created in vault.
:1 means that link take the first tuple value of the vault credential with the name "secretVaultName".
:2 means that link take the second tuple value of the vault credential with the name "secretVaultName"

For more information about vault, please visit our knowledge center in this link or visit the API related to vault in this link.

To test the call in our sandbox environment we recommend using this credentials:
claveUsuario: KK25251001
contrasenaUsuario: kiban123

detalleConsulta section

folioConsultaOtorgante

It can be any alphanumeric data of a maximum of 25 characters to identify the query, the same data sent is received in the response.

productoRequerido

Is the key of product requested, this field should be filled with the information provided from Círculo de Crédito. The complete catalog is available here

tipoCuenta

Type of the account provided from Círculo de Crédito. The complete catalog is available here

claveUnidadMonetaria

This field is optional. The key of the currency, the accepted values are:

MX, for Mexican Pesos. If it is not sent in the query, this value will be assigned by default
UD, for Unidades de Inversión
US, for USD dollars.

importeContrato

Is a positive numeric value that indicates the total amount of credit requested, indicate a maximum of 9 digits.

numeroFirma

It can be any alphanumeric data of a maximum of 25 characters to identify the query, It is a signature number associated with the authorization of the consumer to be consulted, this data allows "Círculo de crédito" to reconcile the authorization of the consultation with its system.

numeroSolicitud

Identifier of the authentication by the grantor. This number is exactly returned in the response by "Círculo de Crédito"

autenticacion section

The "autenticacion" segment within the inquiry should only be submitted if you are using this process to receive autograph authorization from your customer to check their credit report.

Otherwise: please don't use the segment.

🚧
Authorization way
You need to validate with Círculo de crédito the way in which your inquiries are authorized, to validate that your client properly authorizes being consulted. We strongly recommend to review it with your Círculo de Crédito contact. Also you can use our NIP Bureaus authentication service to authenticate your inquiries. For more information you can see the NIP Bureaus post in our knowledge center.

Fields for datosPersonales

In the mandatory fields only example, you can see within the "datosPersonales" section, the fields "apellidoMaterno" and "segundoNombre". If the individual you want to check, doesn't have a "apellidoMaterno" or "segundoNombre" please leave the fields blank. The other fields are mandatory to request the person.

Test the service (test cases)

We have included a query parameter in Sandbox to enable you to query the test cases that we created for running tests. To get a response, fill the testCaseId parameter with any of the following cases:

Num	Id	Name	Description
1	663567bb713cf2110a110698	Consulta reporte de crédito	Indicates that the PDF could not be found
2	663567bb713cf2110a110699	Usuario no válido	Successful credit report response

📘
Test your own test case
In case you want to test your own test case created in link, you can send in the testCaseId parameter the identifier of the test case you want to use.
For more information visit our knowledge center to know more about test cases

Quick tip

You can send a unique ID in "numeroReferenciaOperador" to identify the query and associate it to your client.
You will receive the same ID in the response "numeroReferenciaOperador".