Intro
This API is meant to query Buró de Crédito - Personas Físicas (Consumers' database).
In the answer the INTL files sent to and received from Buró de Crédito will be included.
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 code:
{
"encabezado": {
"productoRequerido": "501",
"tipoResponsabilidad": "I",
"tipoContrato": "AF",
"claveUsuario": "@vault:nombreVariable:1",
"contrasenaUsuario": "@vault:nombreVariable:2",
}
}
Where nombreVariable 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 "nombreVariable".
:2 means that link take the second tuple value of the vault credential with the name "nombreVariable"
Soon we will have an API to check the validity of your username and password.
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.
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.
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".