Documentation
Start typing to search…

Consulta

{
  "encabezado": {
    "productoRequerido": "501",
    "tipoResponsabilidad": "I",
    "tipoContrato": "AF",
    "claveUsuario": "KK25251001",
    "contrasenaUsuario": "kiban123",
    "numeroReferenciaOperador": "10012001",
    "importeContrato": 1000,
    "monedaCredito": "MX",
    "idioma": "SP"
  },
  "nombre": {
    "apellidoPaterno": "KIBAN",
    "apellidoMaterno": "CLOUD",
    "apellidoAdicional": "",
    "primerNombre": "LINK",
    "segundoNombre": "SANDBOX",
    "rfc": "KIBA900129RW9",
    "fechaNacimiento": "1990-01-29",
    "prefijo": "",
    "sufijo": "",
    "nacionalidad": "MX",
    "residencia": "1",
    "numeroLicenciaConducir": "",
    "estadoCivil": "S",
    "sexo": "M",
    "numeroCedulaProfesional": "",
    "numeroRegistroElectoral": "",
    "curp": "PEGR900129HDFRMC09",
    "clavePais": "MX",
    "numeroDependientes": 2,
    "edadesDependientes": "12,32"
  },
  "domicilio": {
    "direccion": {
      "direccion": "Paseo de la Reforma 403",
      "coloniaPoblacion": "Cuauhtemoc",
      "cp": "06500",
      "telefono": "",
      "extensionTelefonica": "",
      "fax": "12324"
    },
    "fechaResidencia": "1998-12-09",
    "tipoDomicilio": "C",
    "indicadorEspecialDomicilio": "K",
    "fechaReporte": "1998-12-09",
    "origenDomicilio": "MX"
  },
  "empleo": {
    "nombreORazonSocial": "KIBAN",
    "direccion": {
      "direccion": "Paseo de la Reforma 403",
      "coloniaPoblacion": "Cuauhtemoc",
      "cp": "06500",
      "telefono": "",
      "extensionTelefonica": "",
      "fax": "12324"
    },
    "cargo": "Backend developer",
    "fechaContratacion": "2022-02-08",
    "claveMoneda": "MX",
    "montoSueldo": "18000",
    "periodoPagoBaseSalarial": "S",
    "numeroEmpleado": "1c2D",
    "fechaUltimoDia": "2022-05-06",
    "origenRazonSocial": "MX"
  },
  "cuentas": [
    {
      "numCuenta": "123456789000",
      "claveOtorgante": "BB32151001",
      "nombreOtorgante": "Banco"
    },
    {
      "numCuenta": "123456789011",
      "claveOtorgante": "FF34001001",
      "nombreOtorgante": "Cooperativa"
    }
  ],
  "autenticacion": {
    "tarjetaCredito": true,
    "ultimo4Digitos": "1597",
    "creditoHipotecario": false,
    "creditoAutomotriz": false
  }
}

Definición

Descripción de cada uno de los segmentos y campos a enviar a BC.

Encabezado

El encabezado contiene los campos que se envían a BC, definidos en el segmento llamado INTL de su manual. Los campos a enviar son los siguientes:

productoRequerido:

  • Definición: El producto que se va a consultar a BC.
  • Tipo: Catálogo de Producto requerido.
  • Longitud: 3 caracteres.
  • Obligatoriedad: Requerido.

tipoResponsabilidad

  • Definición: Indica si la solicitud del Informe Buró es para un crédito individual o mancomunado.
  • Tipo: Catálogo de Tipo de responsabilidad.
  • Longitud: 1 caracter.
  • Obligatoriedad: Requerido.

tipoContrato

  • Definición: Producto de la solicitud del cliente.
  • Tipo: Catálogo de Tipo de contrato.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Requerido.

claveUsuario

  • Definición: Definir la clave de usuario otorgada por Buró. Se puede sustituir por el valor de hayas registrado en vault.
  • Tipo: Texto.
  • Longitud: 10 caracteres.
  • Obligatoriedad: Requerido.

contrasenaUsuario

  • Definición: Definir la contraseña del usuario. Se puede sustituir por el valor de hayas registrado en vault.
  • Tipo: Texto.
  • Longitud: 8 caracteres.
  • Obligatoriedad: Requerido.

numeroReferenciaOperador

  • Definición: Se puede enviar una referencia para identificar la consulta. Esta referencia la obtendrás en la respuesta.
  • Tipo: Texto.
  • Longitud: 25 caracteres.
  • Obligatoriedad: Opcional.

importeContrato

  • Definición: Indicar el monto del crédito solicitado o línea de crédito a autorizar.
  • Tipo: Numérico.
  • Longitud: 9 caracteres.
  • Obligatoriedad: Opcional.

monedaCredito

  • Definición: Indica el tipo de moneda del crédito del cliente.
  • Tipo: Catálogo de Tipo de moneda.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Requerido.

idioma

  • Definición: Indica el idioma en que deberá emitirse el informe de los créditos del archivo.
  • Tipo: Catálogo de Idioma.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

Nombre

Sección que contienen los datos de la persona a consultar en Buró de Crédito.

apellidoPaterno

  • Definición: Apellido paterno.
  • Tipo: Texto.
  • Longitud: 26 caracteres.
  • Obligatoriedad: Requerido.

apellidoMaterno

  • Definición: Apellido materno.
  • Tipo: Texto.
  • Longitud: 26 caracteres.
  • Obligatoriedad: Opcional.

apellidoAdicional

  • Definición: Apellido adicional.
  • Tipo: Texto.
  • Longitud: 26 caracteres.
  • Obligatoriedad: Opcional.

primerNombre

  • Definición: Primer nombre.
  • Tipo: Texto
  • Longitud: 26 caracteres
  • Obligatoriedad: Requerido

segundoNombre

  • Definición: Segundo nombre.
  • Tipo: Texto.
  • Longitud: 26 caracteres.
  • Obligatoriedad: Opcional.

rfc

  • Definición: RFC de la persona, puede ser con homoclave o sin homoclave.
  • Tipo: Texto.
  • Longitud:
    • 10 caracteres sin homoclave.
    • 13 caracteres con homoclave.
  • Obligatoriedad: Requerido.

fechaNacimiento

  • Definición: Fecha de nacimiento en formato aaaa-mm-dd.
  • Tipo: Texto.
  • Longitud: 10 caracteres.
  • Obligatoriedad: Opcional.

prefijo

  • Definición: Prefijos personales y profesionales.
  • Tipo: Catálogo de Prefijo.
  • Longitud: 3-4 caracteres.
  • Obligatoriedad: Opcional.

sufijo

  • Definición: Prefijos sufijos.
  • Tipo: Catálogo de Sufijo.
  • Longitud: 3 caracteres.
  • Obligatoriedad: Opcional.

nacionalidad

  • Definición: Indicar la nacionalidad del cliente.
  • Tipo: Catálogo de Países.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

residencia

  • Definición: Estado de la vivienda del cliente.
  • Tipo: Catálogo de Residencia.
  • Longitud: 1 caracter.
  • Obligatoriedad: Opcional.

numeroLicenciaConducir

  • Definición: Número de licencia de conducir.
  • Tipo: Texto.
  • Longitud: 20 caracteres.
  • Obligatoriedad: Opcional.

estadoCivil

sexo

  • Definición: Indicar el género del cliente.
  • Tipo: Catálogo de Género.
  • Longitud: 1 caracter.
  • Obligatoriedad: Opcional.

numeroCedulaProfesional

  • Definición: Indicar el número de cédula profesional del cliente.
  • Tipo: Texto.
  • Longitud: 20 caracteres.
  • Obligatoriedad: Opcional.

numeroRegistroElectoral

  • Definición: Indicar el número de identificación de la INE.
  • Tipo: Texto.
  • Longitud: 20 caracteres.
  • Obligatoriedad: Opcional.

curp

  • Definición: Indicar el CURP del cliente.
  • Tipo: Texto.
  • Longitud: 20 caracteres.
  • Obligatoriedad: Opcional.

clavePais

  • Definición: Indicar la clave del país de ciudadanía del cliente.
  • Tipo: Catálogo de Países.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

numeroDependientes

  • Definición: Indicar el número de personas que dependen económicamente del cliente.
  • Tipo: Numérico.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

edadesDependientes

  • Definición: Indicar las edades de los dependientes mencionados en el campo anterior. Se pueden indicar hasta 15 dependientes separados por comas sin espacios.
  • Tipo: Texto.
  • Longitud: 30 caracteres.
  • Obligatoriedad: Opcional.

Domicilio

Indicar los datos del domicilio de la persona.

direccion

  • Definición: Objeto de dirección que contienen los campos a consultar. Los siguientes campos, hasta fax, son campos de este objeto.
  • Tipo: Objeto.
  • Longitud: N/A.
  • Obligatoriedad: Requerido.

direccion

  • Definición: Indicar la calle y el número del domicilio de la persona.
  • Tipo: Texto.
  • Longitud: 80 caracteres.
  • Obligatoriedad: Requerido.

coloniaPoblacion

  • Definición: Indicar la colonia o población.
  • Tipo: Texto.
  • Longitud: 40 caracteres.
  • Obligatoriedad: Opcional.

cp

  • Definición: Indicar el código postal.
  • Tipo: Texto.
  • Longitud: 5 caracteres.
  • Obligatoriedad: Requerido.

telefono

  • Definición: Indicar el teléfono del domicilio.
  • Tipo: Numérico.
  • Longitud: 11 caracteres.
  • Obligatoriedad: Opcional.

extensionTelefonica

  • Definición: Indicar la extensión del teléfono del domicilio.
  • Tipo: Numérico.
  • Longitud: 8 caracteres.
  • Obligatoriedad: Opcional.

fax

  • Definición: Indicar el número de fax.
  • Tipo: Numérico.
  • Longitud: 11 caracteres.
  • Obligatoriedad: Opcional.

fechaResidencia

  • Definición: Fecha en la que comenzó a vivir en el domicilio con formato aaaa-mm-dd.
  • Tipo: Texto.
  • Longitud: 10 caracteres.
  • Obligatoriedad: Opcional.

tipoDomicilio

  • Definición: Tipo de domicilio reportado.
  • Tipo: Catálogo de Tipo de domicilio.
  • Longitud: 1 caracter.
  • Obligatoriedad: Opcional.

indicadorEspecialDomicilio

fechaReporte

  • Definición: Indica la fecha en que se reportó la dirección a Buró de Crédito en formato aaaa-mm-dd.
  • Tipo: Texto.
  • Longitud: 1 caracter.
  • Obligatoriedad: Opcional.

origenDomicilio

  • Definición: Indica el país de origen del domicilio.
  • Tipo: Catálogo de países.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

Empleo

Sección opcional para indicar los datos del empleo de la persona.

nombreORazonSocial

  • Definición: Indica el nombre del empleador del cliente.
  • Tipo: Texto.
  • Longitud: 40 caracteres.
  • Obligatoriedad: Opcional.

direccion

  • Definición: Objeto para indicar la dirección del empleo.
  • Tipo: Objeto. Los siguientes campos, hasta fax, son campos de este objeto.
  • Longitud: N/A.
  • Obligatoriedad: Opcional.

direccion

  • Definición: Indicar la calle y el número del domicilio de la persona.
  • Tipo: Texto.
  • Longitud: 80 caracteres.
  • Obligatoriedad: Requerido.

coloniaPoblacion

  • Definición: Indicar la colonia o población.
  • Tipo: Texto.
  • Longitud: 40 caracteres.
  • Obligatoriedad: Opcional.

cp

  • Definición: Indicar el código postal.
  • Tipo: Texto.
  • Longitud: 5 caracteres.
  • Obligatoriedad: Requerido.

telefono

  • Definición: Indicar el teléfono del domicilio.
  • Tipo: Numérico.
  • Longitud: 11 caracteres.
  • Obligatoriedad: Opcional.

extensionTelefonica

  • Definición: Indicar la extensión del teléfono del domicilio.
  • Tipo: Numérico.
  • Longitud: 8 caracteres.
  • Obligatoriedad: Opcional.

fax

  • Definición: Indicar el número de fax.
  • Tipo: Numérico.
  • Longitud: 11 caracteres.
  • Obligatoriedad: Opcional.

cargo

  • Definición: Cargo u ocupación del cliente.
  • Tipo: Texto.
  • Longitud: 30 caracteres.
  • Obligatoriedad: Opcional.

fechaContratacion

  • Definición: Fecha de contratación con formato aaaa-mm-dd.
  • Tipo: Texto.
  • Longitud: 10 caracteres.
  • Obligatoriedad: Opcional.

claveMoneda

  • Definición: Moneda con la cual le pagan al cliente su sueldo o salario.
  • Tipo: Texto con los siguientes posibles valores:
    • MX - Pesos mexicanos.
    • UI - Unidades de inversión.
    • US - Dólares americanos.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

montoSueldo

  • Definición: Monto de ingreso por sueldo o salario de acuerdo con el periodo en que su empleador realiza el pago.
  • Tipo: Numérico
  • Longitud: 9 caracteres.
  • Obligatoriedad: Opcional.

periodoPagoBaseSalarial

numeroEmpleado

  • Definición: Número de empleado o de nómina que le asignó el empleador.
  • Tipo: Texto.
  • Longitud: 15 caracteres.
  • Obligatoriedad: Opcional.

fechaUltimoDia

  • Definición: Fecha en que trabajó por última vez con el empleador con formato aaaa-mm-dd.
  • Tipo: Texto.
  • Longitud: 10 caracteres.
  • Obligatoriedad: Opcional.

origenRazonSocial

  • Definición: País de origen de la razón social del empleo.
  • Tipo: Catálogo de países.
  • Longitud: 2 caracteres.
  • Obligatoriedad: Opcional.

Cuentas

Sección para indicar las cuentas de una persona. Es un arreglo que se pede repetir hasta cuatro veces. Cada elemento tendrá los siguientes campos:

numCuenta

  • Definición: Indica el número de cuenta o crédito.
  • Tipo: Texto.
  • Longitud: 25 caracteres.
  • Obligatoriedad: Opcional.

claveOtorgante

  • Definición: Indicar la clave única o “Member Code” del usuario que otorgó el crédito.
  • Tipo: Texto.
  • Longitud: 10 caracteres.
  • Obligatoriedad: Opcional.

nombreOtorgante

  • Definición: Indicar el nombre del usuario que otorgó el crédito.
  • Tipo: Texto.
  • Longitud: 16 caracteres.
  • Obligatoriedad: Opcional.

Autenticación

Esta sección se debe enviar si desea autenticar la consulta a BC a través de cuatro preguntas. Se deben agregar los siguientes campos:

tarjetaCredito

  • Definición: Campo para indicar si cuenta con tarjeta de crédito.
  • Tipo: Booleano.
  • Longitud: N/A.
  • Obligatoriedad: Requerido.

ultimo4Digitos

  • Definición: Si contestaste true a tarjetaCredito. Se deben indicar los últimos cuatro dígitos de una tarjeta de crédito activa.
  • Tipo: Numérico.
  • Longitud: 4 caracteres.
  • Obligatoriedad: Opcional.

creditoHipotecario

  • Definición: Campo para indicar si cuenta con un crédito hipotecario.
  • Tipo: Booleano.
  • Longitud: N/A.
  • Obligatoriedad: Requerido.

creditoAutomotriz

  • Definición: Campo para indicar si cuenta con un crédito automotriz.
  • Tipo: Booleano.
  • Longitud: N/A.
  • Obligatoriedad: Requerido.

Authorization

Sección para indicar los datos cuando se autoriza la consulta a BC a través de NIP enviado por kiban.

tipo

  • Definición: Campo para indicar el tipo de autorización. Se debe enviar siempre el valor nip.
  • Tipo: Texto.
  • Longitud: 3 caracteres.
  • Obligatoriedad: Requerido.

id

  • Definición: Identificador del proceso de NIP ejecutado anteriormente.
  • Tipo: Texto.
  • Longitud: 3 caracteres.
  • Obligatoriedad: Requerido.

Updated about 5 hours ago