Query

Intro

API to query Buró de Crédito - Personas Físicas (Consumers' database).
The response contains the INTL files sent to and received from Buró de Crédito.

Important points

productoRequerido

This field should be filled with the information you want to receive from Buró de Crédito. The complete catalog is available here

If you need more information about the products, please reach out to your Buró de Crédito contact.

🚧

About Producto Requerido and your Buró de Crédito users

You need to check with Buró de Crédito the privileges associated to your users before starting to query. Some products need specific privileges. We strongly recommend to review it with your Buró de Crédito contact.

Buró de Crédito credentials

"claveUsuario" and "contrasenaUsuario" are the username and password provided by Buró de Crédito. They must be valid and your Buró de Crédito account active in order to query in production.

If you want to use "vault", is possible to manage variables instead of use credentials in hard code.
For example, instead of use the next code:

{
  "encabezado": {
    "productoRequerido": "501",
    "tipoResponsabilidad": "I",
    "tipoContrato": "AF",
    "claveUsuario": "KK25251001",
    "contrasenaUsuario": "kiban123"
  }
}

You should use the next:

{
  "encabezado": {
    "productoRequerido": "501",
    "tipoResponsabilidad": "I",
    "tipoContrato": "AF",
    "claveUsuario": "@vault:secretVaultName:1",
    "contrasenaUsuario": "@vault:secretVaultName:2",
  }
}

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.

Also there you can see our options to update automatically the password of your "Buró de Crédito" user. Soon we will have an API to check the validity of your username and password manually.

If you don't want to use vault, to test the call in our sandbox environment we recommend using this credentials:
claveUsuario: KK25251001
contrasenaUsuario: kiban123

Autenticación

The "autenticacion" segment within the query is only meant to be sent if you're using this process to receive your customer's authorization to check his credit report.

Otherwise: please don't use the segment.

🚧

Authorization way

You need to validate with Buró 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 Credit Bureau 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.

In case that you will Authenticate your requests by NIP Bureaus, is necessary send in the request body the authorization object providing the ID of the NIP Bureaus process and the type NIP:

  "authorization": {
    "tipo": "nip",
    "id": "64b16c50968d6b5054fc22f7"
  }

Mandatory Fields

In the mandatory fields only example, you can see within the "Nombre" 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.

Origen del domicilio

The field "origenDomicilio" of the "Domicilio" section is optional. If it is not sent, we will consider the default value "MX" for this field.

Test cases

We included a query param in Sandbox so you can query test cases that we created to run tests.
In order to obtain the response you shall fill the query param with:

• completo: it sends back a response with all existing fields
• credenciales: it sends back an error message when the username and/or password provided by Buró de Crédito is/are not correct.
• bloqueado: it sends back an answer when the credit report has been blocked by the consumer. For more information on that feature, please refer to your Buró de Crédito contact.
• nipInvalido: it sends back an answer indicating that the provided NIP was incorrect.
• score_no_disponible: example when the response for the credit report was correct but the Score was not available to generate a success score response.

📘

You can also create your own test cases with our test case link module and you will be able to receive these cases in your responses, you just have to enter the name of your test case as a parameter. Remember that the test case name must be encoded to avoid sending whitespace in the URL.

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".

Data cleaning

Before sending the data to Buró de Crédito, kiban cloud performs data cleaning, necessary to prevent Buró de Crédito from sending back an error.

Here are the validations and transformations we are performing:

• Validate that the data you included is alphabetical.
• Remove the accents.
• Replace the letter Ñ by N.
• Remove the special characters.
• Put letters in uppercase.
• Remove spaces at the beginning and end of values (trimming).
• Allow compound surnames, for example, Del Toro.
• Do not allow two names in the primerNombre field.
• Remove commas from the address field.
• Split the address if it is greater than 40 characters : we then send the address in two different fields (40 caracteres max per field) to Buró de Crédito.

If you detect transformation in the data that you included in your call, this is because of the rules mentioned above, required to make a successful call to Buró de Crédito.