Intro
This API will help you audit and reconcile the Círculo de crédito Personas Físicas queries that you make on your side with the NIP process Kiban Bureaus.
Important points
Request
Run this API only after running the query on your side.
Remember that if you want to use this API, you must execute it immediately after querying the Círculo de Crédito Personas Físicas from your system.
We strongly recommend you to provide all the data fields in upper case, but is your decision if you use your own format.
The elements to send in the request are:
| field Name | type | required | length | Description |
|---|---|---|---|---|
| idNipValidation | Alphanumeric | Yes | equal to 24 characters | Indicate the id generated in the validate NIP process. |
| folioConsulta | Alphanumeric | Yes | Less than or equal to 99 characters | Indicates the operator reference number generated by the credit circle, it is the query folio ID that is generated in the Circle credit system |
| nombres | Alphabetic | Yes | Between 2 and 26 characters | Indicate the name(s) of the consulted person |
| apellidoPaterno | Alphabetic | Yes | Between 2 and 26 characters | Enter the last name of the consulted person |
| apellidoMaterno | Alphabetic | No | Between 2 and 26 characters | Enter the second last name of the consulted person |
| rfc | Alphanumeric | Yes | equal to 10 or equal to 13 characters | Provide the RFC of the consulted person |
| direccion | Alphanumeric | Yes | maximum 80 characters | Provide the address of the consulted person |
| numeroControlConsulta | Alphanumeric | Yes | Greater than 1 character | You can enter your own control ID in this field to link this query with your system data. |
Generate audit file
This API allows you to provide our system with the data needed to generate an audit. To obtain the audit file, we recommend you use our Generate audit file NIP Círculo de Crédito Persona Física service.
Successful response
To know the fields of a successful response we suggest you look at our example called success in the response section.
In a successful response, you will only receive the requested information (as previously described) and a 200 HTTP code indicating that the request was successfully applied.
{
"id": "6503d157f922b3da9ba5676b",
"createdAt": "2023-09-15T03:36:55.555479015Z",
"finishedAt": "2023-09-15T03:36:55.857059566Z",
"duration": 301,
"status": "SUCCESS",
"request": {
"idNipValidation": "6503d138f922b3da9ba56765",
"folioConsulta": "000983",
"nombres": "KIBAN CLOUD",
"apellidoPaterno": "LINK",
"apellidoMaterno": "API",
"rfc": "KIBA970815BPA",
"direccion": "AVENIDA PASEO DE LA REFORMA 403"
}
}
Possible Errors
Required fields
If any of the required fields are not provided in the request body, a 400 bad request HTTP error code will be returned.
{
"apellidoMaterno": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty",
"apellidoPaterno": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty",
"direccion": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty",
"folioConsulta": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty",
"idNipValidation": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty",
"nombres": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty",
"rfc": "REQUIRED_FIELD_ERROR; EMPTY_ERROR; can't be empty"
}
Invalid format
If any of the required fields do not conform the specific format in the request body, a 400 bad request HTTP error code will be returned.
{
"idNipValidation": "FORMAT_ERROR; invalid id string",
"numeroControlConsulta": "FORMAT_ERROR; wrong type"
}
NIP not validated
If the NIP cannot be validated, you will receive an HTTP error with code 400.
{
"idNipValidation": "CONFLICT_ERROR; nip record is not validated"
}
NIP already consumed
If you enter a NIP that has already been validated, you will receive an HTTP error with code 400.
{
"idNipValidation": "CONFLICT_ERROR; nip already consumed"
}
Not existing NIP
If you provide a NIP that does not exist, you will receive an error with a 400 HTTP code.
{
"idNipValidation": "ERROR_NOT_FOUND"
}
Unknown Field
If you provide a parameter that does not match with the request body parameters, you will receive an error indicating the name of the invalid parameter, you will receive an error with a 400 HTTP code.
{
"idNipValidation": "UNKNOWN_KEY"
}