Intro

API to query Reporte de crédito Especial - Personas Físicas by kiban.
The response corresponds to the one returned by the Buró de Crédito for a special credit report in JSON format.

Important points

Request example

In the query example, all the fields that are mandatory to be able to make a query are presented. The fields for a correct query are described below.

Object	object	object	Type	Obligatory	Description
nombre			Object	Yes	Name object, where the data associated with the person to be consulted is placed
	primerNombre		String	Yes	First name of the person to consult
	segundoNombre		String	No	Second name of the person to consult
	apellidoPaterno		String	Yes	First last name of the person
	apellidoMaterno		String	No	second last name of the person
	rfc		String	Yes	RFC of the person: both the 10-character format without homokey and the 13-character format with homoclave are accepted.
domicilio			Object	Yes	Object containing the structure of the adress
	direccion		Object	Yes	Internal object that contains the fields of the adress
		direccion	String	Yes	Field to indicate the home address of the person consulted
		cp	String	Yes	Postal code of the home address of the person consulted
authorization			Object	Yes	Object containing the NIP authorization method
	tipo		String	Yes	Type of authorization, always indicate the value "nip"
	id		String	Yes	Place the generated identifier in the NIP process to authenticate this query.

Example JSON

{
    "nombre" : {
        "primerNombre" : "REPORTE",
        "segundoNombre" : "CREDITO",
        "apellidoPaterno" : "ESPECIAL",
        "apellidoMaterno" : "KIBAN",
        "rfc" : "KIBA901010",
        "fechaNacimiento" : "1990-10-10",
        "email": "help@kiban.com"
    },
    "domicilio" : {
        "direccion" : {
            "direccion" : "AV PASEO DE LA REFORMA 403",
            "cp" : "06500"
        }
    },
    "authorization" : {
        "tipo": "nip",
        "id": "66a01f0ad5424abb035c8c9f"
    }
}

authorization

You will notice in the mandatory fields, "tipo" and "id" within an authorization segment:

 "authorization": {
    "tipo": "nip",
    "id": "645a74e7dda9781161e787b"
  }

"Tipo" should always be filled with "nip" and "id" by the response of the validate nip call

To obtain the id in the validate nip call, it is mandatory to have performed the complete NIP Bureaus process

🚧
Certification
In order to run this API in production, you must have completed the certification process described in the following certification link, otherwise your request will be rejected, and you will get the "Certification required" example as error response.

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	663567bb713cf2110a110689	Consulta reporte de crédito por kiban	Successful credit report response
2	663567bb713cf2110a110688	NIP inválido	Indicates that the PIN used to authenticate the query is not valid
3	663567bb713cf2110a11068a	Score no disponible	Indicates that the person was consulted, but there was an error when recovering the score

📘
You can also create your own test cases
You can 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 id of your test case as a testCaseId parameter.
For more information visit our knowledge center to know more about test cases

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 don't send the number in the "dirección" field, we add SN at the end by default, to comply with BC rules.

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.