swagger: '2.0' info: description: 'Este reporte muestra el historial crediticio, el cumplimiento de pago de los compromisos que la persona ha adquirido con entidades financieras, no financieras e instituciones comerciales que dan crédito o participan en actividades afines al crédito.' version: 1.0.2 title: 'Reporte de crédito consolidado - Simulación' termsOfService: 'https://developer.circulodecredito.com.mx/terms-use' contact: email: 'api@circulodecredito.com.mx' license: name: 'Derechos reservados Circulo de Crédito 2020' url: 'http://www.circulodecredito.com.mx' host: 'services.circulodecredito.com.mx' basePath: '/sandbox' tags: - name: 'Reporte de crédito consolidado' externalDocs: description: 'Portal de desarrolladores' url: 'https://developer.circulodecredito.com.mx/productos/rcc-simulation' schemes: - 'https' paths: '/v1/rcc': post: summary: 'Obtiene el reporte de crédito consolidado.' description: '' tags: - 'Reporte de crédito consolidado' operationId: 'getReporte' consumes: - 'application/json' produces: - 'application/json' parameters: - name: 'x-api-key' in: 'header' required: true type: 'string' description: 'ConsumerKey obtenido desde el portal de desarrolladores' default: '' - in: 'body' name: 'request' description: '

Ejemplos para generar diferentes respuestas:


Listado de los caracteres especiales que se sugieren reemplazar en los request de las peticiones.


CARÁCTER ESPECIAL CARÁCTER SIMPLE
ÁA
áa
ÉE
ée
ÍI
íi
ÓO
óo
ÚU
úu
ÜU
üu
ÑN
ñn
, ` - / ; : ! ?Reemplazar por carácter vacío
' required: true schema: $ref: '#/definitions/PersonaPeticion' responses: '200': description: 'OK' schema: $ref: '#/definitions/Respuesta' '204': description: 'NO CONTENT' '400': description: 'BAD REQUEST' schema: $ref: '#/definitions/Errores' examples: application/json: errores: codigo: '400.1' mensaje: 'El campo "primerNombre" no puede estar vacío.' '401': description: 'UNAUTHORIZED' schema: $ref: '#/definitions/Errores' examples: application/json: errores: - codigo: '401.1' mensaje: 'Acceso no autorizado, x-api-key no válida.' - codigo: '401.2' mensaje: 'Acceso no autorizado.' - codigo: '401.4' mensaje: 'Acceso no autorizado, no tiene el producto asociado.' - codigo: '401.5' mensaje: 'Acceso no autorizado, no tiene acceso al recurso.' '403': description: 'FORBIDDEN' schema: $ref: '#/definitions/Errores' examples: application/json: errores: - codigo: '403.1' mensaje: 'No se pudo autenticar, x-signature no es válida.' '404': description: 'NOT FOUND' schema: $ref: '#/definitions/Errores' examples: application/json: errores: - codigo: '404.1' mensaje: 'No se encontró a la persona.' '429': description: 'TOO MANY REQUESTS' schema: $ref: '#/definitions/Errores' examples: application/json: errores: - codigo: '429.1' mensaje: 'Se han enviado demasiadas solicitudes. Se debe esperar antes de realizar una nueva solicitud.' '500': description: 'INTERNAL SERVER ERROR' schema: $ref: '#/definitions/Errores' examples: application/json: errores: - codigo: '500.1' mensaje: 'Ocurrio un problema, inténtelo nuevamente más tarde.' '503': description: 'SERVICE UNAVAILABLE' definitions: CatalogoErrores: type: 'string' description: '
Descripción
Error en la formacion del JSON: {mensaje}
Error en la formacion del JSON
La consulta no pudo ser procesada, intente nuevamente.
Se espera elemento NumeroCuenta en CuentasReferencia
La longitud de la clave del otorgante en el encabezado no es valida
La clave del otorgante es un campo requerido en el encabezado
La longitud del nombre de usuario no es valida
El nombre de usuario del otorgante es un campo requerido en el encabezado
La longitud del password no es valida
El password es un campo requerido en el encabezado
La longitud del folio de la consulta del otorgante no es valida
Es requerida la autenticacion
La longitud del producto requerido no es valida
El producto requerido es un campo requerido en el detalle de consulta
La longitud de la unidad monetaria no es valida
La clave de la unidad monetaria es un campo requerido en el detalle de consulta
La longitud del importe del contrato no es valida
El importe del contrato es un campo requerido en detalles consulta
EL valor del importe del contrato no es valido
La longitud del numero de firma no es valida
El numero de firma es un campo requerido en detalles consulta
La longitud del numero de solicitud no es valida
La longitud del medio de consulta no es valida
La longitud del apellido paterno no es valida
El apellido paterno es un campo requerido en Nombre
La longitud del apellido materno no es valida
El apellido materno es un campo requerido en nombre
La longitud del apellido adicional no es valida
La longitud de los nombres no es valida
El o los nombres son un campo obligatorio para nombre
La fecha de nacimiento es un campo requerido
Formato de fecha no valido para fecha de nacimiento
La longitud de la fecha no es valida
La longitud del RFC no es valida
La longitud de la CURP no es valida
La longitud de la nacionalidad no es valida
La longitud del identificador de residencia no es valida
La longitud del estado civil no es valida
El valor del sexo no es valido
La longitud del sexo no es valida
La longitud de la clave de elector del IFE no es valida
Formato de numero no valido para numero de dependientes
La longitud del numero de dependientes no es valida
La longitud de la direccion no es valida
El campo direccion es requerido en direccion
La longitud de la colonia/poblacion no es valida
La longitud de la delegacion/municipio no es valida
La longitud de la ciudad no es valida
Si no se proporciona delegacion/municipio la ciudad es requerida
Si no proporciona ciudad la delegacion/municipio es requerida
El estado {estado} no es valido en dirección
La longitud del estado no es valida
El estado es requerido en direccion
El codigo postal no pertenece al Estado {estado}
La longitud del codigo postal no es valida
El codigo postal es un campo requerido en direccion
Formato de fecha no valido para fecha de residencia
La longitud de la fecha de residencia no es valida
La longitud del numero telefonico no es valida
La longitud del tipo de domicilio no es valida
Formato de numero no valido para tipo de asentamiento
La longitud del tipo de asentamiento no es valida
La longitud del nombre de la empresa no es valida
La longitud de la direccion del empleo no es valida
La longitud de la colonia/poblacion del empleo no es valida
La longitud de la delegacion/municpio del empleo no es valida
La longitud de la ciudad del empleo no es valida
El estado {estadoEmpleo} no es valido en empleo
La longitud del estado del empleo no es valida
El codigo postal del empleo no pertenece al Estado {estadoEmpleo}
La longitud del codigo postal del empleo no es valida
La longitud del telefono del empleo no es valida
La longitud de la extension del empleo no es valida
La longitud del fax del empleo no es valida
La longitud del puesto del empleo no es valida
Formato de fecha no valido para fecha de contratacion de empleo
La longitud de la fecha de contratacion de empleo no es valida
La longitud de clave moneda del empleo no es valida
La longitud del salario mensual de empleo no es valida
Formato de fecha no valido para fecha ultimo dia laborado
La longitud de la fecha ultimo dia de empleo no es valida
El tipo de cuenta invalido en detalle de consulta
El tipo de cuenta es requerido en detalle de consulta
La longitud del numero de referencia no es valida
La longitud de tiene tarjeta de credito no es valida
Tiene es un campo requerido en tarjeta de credito
El numero de cuenta es un campo requerido en tarjeta de credito
La longitud del limite de credito no es valida
La longitud de tiene credito hipotecario no es valida
Tiene es un campo requerido en credito hipotecario
La longitud del numero de contrato no es valida
La longitud de tiene credito automotriz no es valida
Tiene es un campo requerido en credito automotriz
La longitud del numero de contrato no es valida
La consulta no pudo ser procesada, intente nuevamente.
El apellido paterno es un campo requerido en Nombre
' CatalogoFrecuenciaPago: type: 'string' description: '
ValorDescripción
AAnual
BBimestral
CCatorcenal
DDeducción del Salario
ESemestral
MMensual
QQuincenal
RPago Mínimo Para Cuentas Revolventes
SSemanal
TTrimestral
UUna Sola Exhibición
' minLength: 1 maxLength: 1 example: 'S' enum: - 'A' - 'B' - 'C' - 'D' - 'E' - 'M' - 'Q' - 'R' - 'S' - 'T' - 'U' CatalogoEstadoCivil: type: 'string' description: '
ClaveDescripción
DDivorciado
LUnión Libre
CCasado
SSoltero
VViudo
ESeparado
' minLength: 1 maxLength: 1 enum: - 'D' - 'L' - 'C' - 'S' - 'V' - 'E' CatalogoEstados: type: 'string' description: 'Estado en que se ubica el domicilio
ClaveEstado
AGSAGUASCALIENTES
BCBAJA CALIFORNIA NORTE
BCSBAJA CALIFORNIA SUR
CAMPCAMPECHE
CDMXCIUDAD DE MÉXICO
CHISCHIAPAS
CHIHCHIHUAHUA
COAHCOHAHUILA
COLCOLIMA
DFDISTRITO FEDERAL
DGODURANGO
GTOGUANAJUATO
GROGUERRERO
HGOHIDALGO
JALJALISCO
MEXMÉXICO
MICHMICHOCÁN
MORMORELOS
NAYNAYARIT
NLNUEVO LEÓN
OAXOXACA
PUEPUEBLA
QROQUERÉTARO
QROOQUINTANA ROO
SLPSAN LUIS POTOSÍ
SINSINALOA
SONSONORA
TABTABASCO
TAMPTAMAULIPAS
TLAXTLAXCALA
VERVERACRUZ
YUCYUCATÁN
ZACZACATECAS
' minLength: 0 maxLength: 4 example: 'JAL' enum: - 'AGS' - 'BC' - 'BCS' - 'CAMP' - 'COAH' - 'COL' - 'CHIS' - 'CHIH' - 'DF' - 'CDMX' - 'DGO' - 'GTO' - 'GRO' - 'HGO' - 'JAL' - 'MEX' - 'MICH' - 'MOR' - 'NAY' - 'NL' - 'OAX' - 'PUE' - 'QRO' - 'QROO' - 'SLP' - 'SIN' - 'SON' - 'TAB' - 'TAMP' - 'TLAX' - 'VER' - 'YUC' - 'ZAC' CatalogoMoneda: type: 'string' description: '
ValorMoneda
MXPesos Mexicanos
USDólares
UDUnidades de Inversión
' minLength: 2 maxLength: 2 example: 'MX' enum: - 'MX' - 'US' - 'UD' CatalogoNacionalidad: type: 'string' description: '

Debe contener la clave de la nacionalidad del consumidor los valores posibles son los siguientes:

ClaveNacionalidadPaís
ADAndorraAndorra
AFAfganaAfganistán
AGAntigua y BarbadoAntigua y Barbado
AIAnguilaAnguila
ANAlbaniaAlbania
AOAngolaAngola
ASAscensiónAscensión
ATArgentinaArgentina
AUAustralianaAustralia
AWÁrabeArabia
AXAzoresAzores
BBBarbadosBarbados
BDBangladeshBangladesh
BEBelgaBélgica
BFBurkinaBurkina
BGBúlgaraBulgaria
BHBahreinBahrein
BIBurundiBurundi
BJBeninBenin
BKBirmaniaBirmania
BMButánBután
BNBruneiBrunei
BOBolivianaBolivia
BRBrasileñoBrasil
BSBahamasBahamas
BUBermudasBermudas
BWBotswanaBotswana
BXBosnia HerzegovinaBosnia Herzegovina
BZBeliceBelice
CBColombianaColombia
CCCórcegaCórcega
CDChadChad
CFRep. Central AfricanaRep. Central Africana
CGCongoCongo
CHLiechtensteinLiechtenstein
CIIslas CaimánIslas Caimán
CJComorosComoros
CLChilenaChile
CMCamerunésCamerún
CNCanadienseCanadá
CPChinaChina (Pekín)
CSRepública Checa EslovacaRepública Checa Eslovaca
CUCariacouCariacou
CVCabo VerdeCabo Verde
CYChipreChipre
DFAustriacaAustria
DJDjiboutiDjibouti
DKDanésDinamarca
DMDominicanaDominicana
DODominicanaRepública Dominicana
DWAlemanaAlemania
DZArgeliaArgelia
ECEcuatorianaEcuador
EGEgipciaEgipto
EMTimor OrientalTimor Oriental
ESEspañolaEspaña
ETEtiopiaEtiopia
FAIslas Falkland (Malvinas)Islas Falkland (Malvinas)
FEIslas FaroeIslas Faroe
FIFinlandiaFinlandia
FJFijiFiji
FPPolinesiaPolinesia
FRFrancesaFrancia
GBGabónGabón
GDGranadaGranada
GEGroenlandiaGroenlandia
GFGuayana FrancesaGuayana Francesa
GHGhanaGhana
GIGibraltarGibraltar
GMGambiaGambia
GNGuineaGuinea
GPGuadalupeGuadalupe
GQGuinea EcuatorialGuinea Ecuatorial
GRGriegaGrecia
GTGuatemaltecaGuatemala
GWGuinea BissauGuinea Bissau
GXRepública De GeorgiaRepública De Georgia
GYGuyanaGuyana
HAHaitianaHaití
HKHong KongHong Kong
HNHondureñaHonduras
HRCubanoCuba
HUHúngaraHúngara
HXCroataCroacia
IBIndiaIndia
ICCosta De MarfilCosta De Marfil
IEIrlandesaIrlandesa
IFIndonesiaIndonesia
IGIsraelíIsraelí
IQIraquíIraquí
IRIraníIraní
ISIslandiaIslandia
ITItalianoItaliano
JMJamaicanoJamaicano
JOJordanoJordano
JPJaponesaJaponesa
KAKampucheaKampuchea
KEKenyaKenya
KIKiribatiKiribati
KNSan Cristóbal De NeváisSan Cristóbal De Neváis
KRCorea Del SurCorea Del Sur
KWKuwaitKuwait
KXCorea Del NorteCorea Del Norte
LBLibanesLibanes
LCSanta LuciaSanta Lucia
LEIslas De SotaventoIslas De Sotavento
LKSri LankaSri Lanka
LOLaosLaos
LRLiberiaLiberia
LSLesothoLesotho
LTLituaniaLituania
LULuxemburgoLuxemburgo
LVLibiaLibia
LXLetoniaLetonia
MCMongoliaMongolia
MDMadeiraMadeira
MGMadagascarMadagascar
MHMacedoniaMacedonia
MJMacaoMacao
MKMontserratMontserrat
MLMaliMali
MMMontenegroMontenegro
MPSao Tome y PrincipadoSao Tome y Principado
MQMartinicoMartinico
MRMauritaniaMauritania
MTMaltaMalta
MUMauricioMauricio
MVMaldivasMaldivas
MWMalawiMalawi
MXMexicanaMéxico
MYMalasiaMalasia
MZMozambiqueMozambique
NANauruNauru
NDNo DefinidoNo Definido
NINicaraguaNicaragua
NLHolandesaHolanda
NNAntillas HolandesasAntillas Holandesas
NONoruegaNoruega
NPNepalNepal
NRNigerianoNigeria
NWNueva CaledoniaNueva Caledonia
NZNueva ZelandiaNueva Zelandia
OAKatarKatar
OMOmánOmán
PGPapúa Nueva GuineaPapúa Nueva Guinea
PHFilipinasFilipinas
PKPakistánPakistán
PLPolacoPolonia
PMPanameñoPanamá
PSIslas PitcairnIslas Pitcairn
PTPortuguésPortugal
PUPeruanaPerú
PYParaguayoParaguay
RCMarroquíMarruecos
REIslas ReuniónIslas Reunión
RORumanaRumania
RURusaRusia
RWRuandaRuanda
SASaudí ÁrabeArabia Saudita
SBSudanSudan
SESuecoSuecia
SFSan Vencen y Las GranadasSan Vencen y Las Granadas
SHSanta HelenaSanta Helena
SIIslas SalmonIslas Salmon
SNSenegalSenegal
SOSomaliaSomalia
SPSan Pierre y MiquelónSan Pierre y Miquelón
SRSurinamSurinam
SSSan KittsSan Kitts
STIslas Santa CruzIslas Santa Cruz
SUEstoniaEstonia
SVSalvadoreñaEl Salvador
SWSuizaSuiza
SXSerbiaSerbia
SYSiriaSiria
SZSwazilandiaSwazilandia
TATongaTonga
TCTurcos e Islas CaicosTurcos e Islas Caicos
TDTristán De CunhaTristán De Cunha
TGTogoTogo
THTailandiaTailandia
TRTurcaTurquía
TTTrinidad y TobagoTrinidad y Tobago
TUTúnezTúnez
TVTuvalaTuvala
TWTaiwánTaiwán
TZTanzaniaTanzania
UAUcranianoUcrania
UGUgandaUganda
UKReino UnidoReino Unido
UMÁrabeEmiratos Árabes Unidos
USEstadounidenseEstados Unidos
UYUruguayoUruguay
VCCiudad Del VaticanoCiudad Del Vaticano
VEVenezolanaVenezuela
VGIslas Vírgenes InglesasIslas Vírgenes Inglesas
VNVietnamiVietnam
VUVanuatuVanuatu
WSSamoa OesteSamoa Oeste
WTGales / Isla FuturaGales / Isla Futura
XNEsloveniaEslovenia
YEYemen (Del Sur)Yemen (Del Sur)
YSYemen (Del Norte)Yemen (Del Norte)
ZASudafricanaÁfrica Del Sur
ZMZambiaZambia
ZRZaireZaire
ZWZimbabweZimbabwe
ClaveDescripciónADCuenta o monto en aclaraciónCACartera al Corriente Vendida o cedida a un usuario de una SociedadCCCuenta cancelada o cerradaCDConvenio y disminución de pagoCLCuenta cerrada que estuvo en cobranza y fue pagada totalmente sin causar quebrantoCOCrédito en ControversiaCVCuenta que no está al corriente vendida o cedida a un usuario de una SociedadFDCuenta FraudulentaFNFraude no Atribuible al ConsumidorFPFianza pagadaFRAdjudicación o aplicación de garantíaGPEjecución de Garantía Prendaria o Fiduciaria en Pago por CréditoIACuenta InactivaIMIntegrante causante de moraISIntegrante que fue subsidiado para evitar moraLCConvenio de finiquito o pago menor acordado con el ConsumidorLGPago menor por programa institucional o de gobierno, incluyendo los apoyos a damnificados por catástrofes naturalesLOEn LocalizaciónLSTarjeta de Crédito Extraviada o RobadaNACuenta al corriente vendida o cedida a un NO Usuario de una SociedadNVCuenta que no está al corriente vendida o cedida a un NO Usuario de una SociedadPCCuenta en CobranzaPDPrórroga otorgada debido a un desastre naturalPEPrórroga otorgada al acreditado por situaciones especialesPIPrórroga otorgada al acreditado por invalidez, defunciónPRPrórroga otorgada debido a una pérdida de relación laboralRACuenta reestructurada sin pago menor, por programa institucional o gubernamental, incluyendo los apoyos a damnificados por catástrofes naturalesRIRobo de identidadRFResolución judicial favorable al clienteRNCuenta reestructurada debido a un proceso judicialRVCuenta reestructurada sin pago menor por modificación de la situación del cliente, a petición de ésteSGDemanda por el OtorganteUPCuenta que causa quebrantoVRDación en Pagos ó Renta' minLength: 2 maxLength: 2 example: 'CA' enum: - 'AD' - 'CA' - 'CC' - 'CD' - 'CL' - 'CO' - 'CV' - 'FD' - 'FN' - 'FP' - 'FR' - 'GP' - 'IA' - 'IM' - 'IS' - 'LC' - 'LG' - 'LO' - 'LS' - 'NA' - 'NV' - 'PC' - 'PD' - 'PE' - 'PI' - 'PR' - 'RA' - 'RI' - 'RF' - 'RN' - 'RV' - 'SG' - 'UP' - 'VR' CatalogoResidencia: type: 'string' description: 'Descripciones para los valores enviados en este campo por Círculo de Crédito.
ClaveDescripción
1Propietario
2Renta
3Vive con Familiares
4Vivienda Hipotecada
5No Disponible
' minLength: 1 maxLength: 1 enum: - '1' - '2' - '3' - '4' - '5' CatalogoSexo: type: 'string' description: '
ClaveDescripción
FFemenino
MMasculino
' minLength: 1 maxLength: 1 enum: - 'F' - 'M' CatalogoTipoAsentamiento: type: 'string' description: '
ClaveTipo de Asentamiento
0PENDIENTE POR ACTUALIZAR
1AEROPUERTO
2BARRIO
3BASE NAVAL
4CAMPAMENTO
5CENTRO
6CENTRO URBANO
7COLONIA
8CONDOMINIO
9CONGREGACION
10CONJUNTO HABITACIONAL
11CONJUNTO HABITACIONAL RESIDENCIAL
12CONJUNTO HABITACIONAL URBANO
13CONJUNTO POPULAR
14CONJUNTO RESIDENCIAL
15CONJUNTO URBANO
16CONJUNTO URBANO POPULAR
17EJIDO
18ESCUELA
19ESTACION DE RADIO
20EX-HACIENDA
21EX-RANCHO
22FABRICA
23FINCA
24FRACCIONAMIENTO
25FRACCIONAMIENTO INDUSTRIAL
26FRACCIONAMIENTO RESIDENCIAL
27GRANJA
28HACIENDA
29INGENIO
30JUNTA AUXILIA
31MODULO HABIT
32PARQUE
33PARQUE INDUS
34CUADRILLA
35POBLADO COM
36PUEBLO
37RANCHO O RAN
38RESIDENCIAL
39VILLA
40UNIDAD HABIT
41ZONA FEDERAL
42ZONA HABITAC
43ZONA INDUSTR
44ZONA RESIDEN
45ZONA URBANA
46ZONA URBANA
47CAMPO MILITA
48VIVIENDA POPU
49CLUB DE GOLF
50COOPERATIVA
51CIUDAD
52OFICINA DE CO
53GRAN USUARIO
54ZONA COMERC
55ZONA RURAL
' example: '28' enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' CatalogoTipoCredito: type: 'string' description: '
ClaveTipo de Contrato
AAArrendamiento Automotriz
ABAutomotriz Bancario
AEFísica Actividad Empresarial
AMAparatos/Muebles
ARArrendamiento
AVAviación
BCBanca Comunal
BLBote/Lancha
BRBienes Raíces
CACompra De Automóvil
CCCrédito Al Consumo
CFCrédito Fiscal
COConsolidación
CPCrédito Personal Al Consumo
EDEditorial
EQEquipo
FFFondeo Fira
FIFianza
FTFactoraje
GSGrupo Solidario
HBHipotecario Bancario
HEPréstamo Tipo Home Equity
HVHipotecario ó Vivienda
LCLínea de Crédito
MCMejoras a la Casa
NGPréstamo No Garantizado
PBPréstamo Personal Bancario
PCProcampo
PEPréstamo Para Estudiante
PGPréstamo Garantizado
PQPréstamo Quirografario
PMPréstamo Empresarial
PNPréstamo de Nómina
PPPréstamo Personal
SHSegunda Hipoteca
TCTarjeta De Crédito
TDTarjeta Departamental
TGTarjeta Garantizada
TSTarjeta De Servicios
VRVehículo Recreativo
OTOtros
NCDesconocido
' minLength: 2 maxLength: 2 example: 'PP' enum: - 'AA' - 'AB' - 'AE' - 'AM' - 'AR' - 'AV' - 'BC' - 'BL' - 'BR' - 'CA' - 'CC' - 'CF' - 'CO' - 'CP' - 'ED' - 'EQ' - 'FF' - 'FI' - 'FT' - 'GS' - 'HB' - 'HE' - 'HV' - 'LC' - 'MC' - 'NG' - 'PB' - 'PC' - 'PE' - 'PG' - 'PQ' - 'PM' - 'PN' - 'PP' - 'SH' - 'TC' - 'TD' - 'TG' - 'TS' - 'VR' - 'OT' - 'NC' CatalogoTipoCuenta: type: 'string' description: '
ClaveTipo de cuenta
FPagos fijos
HHipoteca
LSin límite preestablecido
RRevolvente
QQuirografario
ACrédito de habilitación o avío
ECrédito refaccionario
PCrédito prendario
' minLength: 1 maxLength: 1 example: 'F' enum: - 'F' - 'H' - 'L' - 'R' - 'Q' - 'A' - 'E' - 'P' CatalogoTipoDomicilio: type: 'string' description: '
ClaveDescripción
NNegocio
ODomicilio del otorgante
CCasa
PApartado Postal
EEmpleo
' minLength: 1 maxLength: 1 example: 'C' enum: - 'N' - 'O' - 'C' - 'P' - 'E' CatalogoTipoResponsabilidad: type: 'string' description: '
ClaveTipo de responsabilidad
IIndividual(Titular)
MMancomunado
OObligatorio Solidario
AAval
TTitular con Aval
' minLength: 1 maxLength: 1 example: 'I' enum: - 'I' - 'M' - 'O' - 'A' - 'T' Consulta: type: 'object' description: 'Datos de consultas.' properties: fechaConsulta: type: 'string' description: 'Fecha de la consulta.' example: '2020-01-09' claveOtorgante: type: 'string' description: 'Clave del otorgante.' example: "CDC0001" nombreOtorgante: type: 'string' description: 'Nombre del Otorgante.' example: "MICROFINANCIERA" direccionOtorgante: type: 'string' description: 'Dirección del otorgante.' example: "MICROFINANCIERA" telefonoOtorgante: type: 'string' description: 'Número telefónico del otorgante.' example: '5512345678' tipoCredito: type: 'string' description: 'Tipo de crédito que se solicitó.' example: "M" importeCredito: type: 'string' description: 'Monto solicitado.' tipoResponsabilidad: $ref: '#/definitions/CatalogoTipoResponsabilidad' claveUnidadMonetaria: $ref: '#/definitions/CatalogoMoneda' idDomicilio: type: 'string' description: 'Identificador de domicilio asociado al elemento Domicilio. Esta etiqueta solo se presenta para los productos que incluyen detalle de Domicilios.' example: '316110890' minLength: 0 maxLength: 20 servicios: type: 'string' description: 'Los valores posibles son 0 = Sin servicios ó 1 = Servicios al hogar' example: '1' Consultas: type: 'object' description: 'Si existen consultas, se listarán.' properties: consultas: type: 'array' items: $ref: '#/definitions/Consulta' Credito: type: 'object' description: 'El elemento de crédito contiene el comportamiento actual e histórico del crédito del consumidor, este elemento se repite dependiendo del número de cuentas del consumidor.' properties: fechaActualizacion: type: 'string' description: 'Fecha correspondiente al periodo que se reportó el crédito' format: 'yyyy-MM-dd' example: '2018-02-28' registroImpugnado: type: 'string' description: 'Si el crédito fue impugnado (Si tiene alguna investigación por alguna controversia ya sea por parte del otorgante o el cliente)' example: 0 claveOtorgante: type: 'string' description: 'Clave del otorgante' example: '' nombreOtorgante: type: 'string' description: 'Nombre del Otorgante que reporta la cuenta' example: "MICROFINANCIERA" cuentaActual: type: 'string' description: 'Número de cuenta del crédito' example: '' tipoResponsabilidad: $ref: '#/definitions/CatalogoTipoResponsabilidad' tipoCuenta: $ref: '#/definitions/CatalogoTipoCuenta' tipoCredito: $ref: '#/definitions/CatalogoTipoCredito' claveUnidadMonetaria: $ref: '#/definitions/CatalogoMoneda' valorActivoValuacion: type: 'string' description: 'Valor total del activo para propósitos de evaluación o recuperación. Es el valor monetario de la garantía.' example: 0 numeroPagos: type: 'string' description: 'Total de pagos determinado en la apertura del crédito.' example: 16 frecuenciaPagos: $ref: '#/definitions/CatalogoFrecuenciaPago' montoPagar: type: 'string' description: 'Monto a pagar' example: 6276 fechaAperturaCuenta: type: 'string' description: 'Fecha en que se aperturó el crédito.' format: 'yyyy-MM-dd' example: '2018-01-20' fechaUltimoPago: type: 'string' description: 'Fecha más reciente en la que el cliente efectuó un pago.' format: 'yyyy-MM-dd' example: '2018-02-20' fechaUltimaCompra: type: 'string' description: 'Fecha más reciente en que el cliente efectuó una compra o disposición de crédito.' format: 'yyyy-MM-dd' example: '2018-02-26' fechaCierreCuenta: type: 'string' description: 'Fecha en la que se liquidó o cerró el crédito.' format: 'yyyy-MM-dd' example: '' fechaReporte: type: 'string' description: 'Periodo al que corresponde el crédito reportado por el otorgante.' format: 'yyyy-MM-dd' example: '2018-02-28' ultimaFechaSaldoCero: type: 'string' description: 'Última fecha en que la cuenta quedó en ceros.' format: 'yyyy-MM-dd' example: '' garantia: type: 'string' description: 'Garantía utilizada para asegurar el crédito otorgado.' example: '' creditoMaximo: type: 'string' description: 'Contiene el máximo importe de crédito utilizado por el cliente.' example: 25104 saldoActual: type: 'string' description: 'Saldo del crédito.' example: 14714 limiteCredito: type: 'string' description: 'El límite de crédito.' example: 0 saldoVencido: type: 'string' description: 'Saldo vencido de la cuenta.' example: 0 numeroPagosVencidos: type: 'string' description: 'Número de pagos vencidos.' example: 0 pagoActual: type: 'string' description: 'Pago actual.' example: '1' historicoPagos: type: 'string' description: 'Histórico de pagos.' example: 'V' fechaRecienteHistoricoPagos: type: 'string' description: 'Fecha más reciente del histórico de pagos.' format: 'yyyy-MM-dd' example: '' fechaAntiguaHistoricoPagos: type: 'string' description: 'Fecha más antigua del histórico de pagos.' format: 'yyyy-MM-dd' example: '' clavePrevencion: $ref: '#/definitions/CatalogoPrevencion' totalPagosReportados: type: 'string' description: 'Total de pagos realizados por el cliente.' example: 0 peorAtraso: type: 'string' description: 'Mayor cantidad de pagos incumplidos en el histórico del cliente.' example: 0 fechaPeorAtraso: type: 'string' description: 'Fecha en la que el cliente tuvo su peor atraso.' format: 'yyyy-MM-dd' example: '' saldoVencidoPeorAtraso: type: 'string' description: 'Saldo vencido del peor atraso.' montoUltimoPago: type: 'number' description: 'Monto último pago' format: 'double' idDomicilio: type: 'string' description: 'Identificador de domicilio asociado al elemento Domicilio. Esta etiqueta solo se presenta para los productos que incluyen detalle de Domicilios.' minLength: 0 maxLength: 20 servicios: type: 'string' description: 'Los valores posibles son 0 = Sin servicios ó 1 = Servicios al hogar' minLength: 0 maxLength: 1 Creditos: type: 'object' description: 'Si existen créditos, se listarán.' properties: creditos: type: 'array' items: $ref: '#/definitions/Credito' Domicilio: type: 'object' description: 'Datos del domicilio de la persona a consultar' required: - 'direccion' - 'ciudad' - 'codigoPostal' - 'estado' - 'municipio' - 'colonia' properties: direccion: type: 'string' description: 'Reportar el nombre de la calle, número exterior, número interior. Deben considerarse avenida,cerrada, manzana, lote, edificio,departamento etc. Debe contener por lo menos dos cadenas de caracteres para que el registro sea válido, de lo contrario el registro será rechazado.' minLength: 0 maxLength: 85 example: 'HIDALGO 32' colonia: type: 'string' description: 'Reportar la colonia a la cual pertenece la dirección contenida en el elemento dirección.' minLength: 0 maxLength: 65 example: 'CENTRO' municipio: type: 'string' description: 'Reportar la delegación o municipio a la cual pertenece la dirección contenida en el elemento Dirección.' minLength: 0 maxLength: 65 example: 'LA BARCA' ciudad: type: 'string' description: 'Reportar la ciudad a la cual pertenece la dirección contenida en el elemento Dirección.' minLength: 0 maxLength: 65 example: 'BENITO JUAREZ' estado: $ref: '#/definitions/CatalogoEstados' codigoPostal: type: 'string' description: 'El código postal reportado debeestar compuesto por 5 dígitos. Para que el código postal sea válido deberá corresponder al estado reportado.' minLength: 5 maxLength: 5 example: '47917' fechaResidencia: type: 'string' description: 'Debe de reportarse la fecha desde cuando el consumidor vive en la dirección reportada.' format: 'yyyy-MM-dd' numeroTelefono: type: 'string' description: 'Debe de contener una longitud mínima de 5 caracteres, cada caracter debe ser un número de 0-9, si se ingresa cualquier otro caracter el registro será rechazado.' tipoDomicilio: $ref: '#/definitions/CatalogoTipoDomicilio' tipoAsentamiento: $ref: '#/definitions/CatalogoTipoAsentamiento' Domicilios: type: 'object' description: 'Si existen créditos, se listarán.' properties: domicilios: type: 'array' items: $ref: '#/definitions/Domicilio' Empleo: type: 'object' description: 'Contiene la información sobre los empleos que ha tenido el consumidor.' properties: nombreEmpresa: type: 'string' description: 'Nombre o Razón Social de la empresa que emplea al Cliente. Cuando el consumidor sea trabajador independiente, no está asociado a una empresa o no cuenta con un trabajo se reportará uno de los siguientes posibles valores:

' direccion: type: 'string' description: 'Reportar el nombre de la calle, número exterior, número interior. Deben considerarse avenida,cerrada, manzana, lote, edificio,departamento etc. Debe contener por lo menos dos cadenas de caracteres para que el registro sea válido, de lo contrario el registro será rechazado.' minLength: 0 maxLength: 85 example: 'HIDALGO 32' colonia: type: 'string' description: 'Reportar la colonia a la cual pertenece la dirección contenida en el elemento dirección.' minLength: 0 maxLength: 65 example: 'CENTRO' municipio: type: 'string' description: 'Reportar la delegación o municipio a la cual pertenece la dirección contenida en el elemento Dirección.' minLength: 0 maxLength: 65 example: 'LA BARCA' ciudad: type: 'string' description: 'Reportar la ciudad a la cual pertenece la dirección contenida en el elemento Dirección.' minLength: 0 maxLength: 65 example: 'BENITO JUAREZ' estado: $ref: '#/definitions/CatalogoEstados' codigoPostal: type: 'string' description: 'El código postal reportado debeestar compuesto por 5 dígitos. Para que el código postal sea válido deberá corresponder al estado reportado.' minLength: 5 maxLength: 5 example: '47917' numeroTelefono: type: 'string' description: 'Número telefónico del empleo.' extension: type: 'string' description: 'Extensión telefónica.' example: '' fax: type: 'string' description: 'Fax.' puesto: type: 'string' description: 'Título o posición de empleo.' fechaContratacion: type: 'string' description: 'Fecha de contratación.' format: 'yyyy-MM-dd' claveMoneda: $ref: '#/definitions/CatalogoMoneda' salarioMensual: type: 'string' description: 'Ingreso Mensual.' fechaUltimoDiaEmpleo: type: 'string' description: 'Fecha del último día que trabajo en esa empresa.' format: 'yyyy-MM-dd' fechaVerificacionEmpleo: type: 'string' description: 'Fecha en que el otorgante verificó los datos proporcionados por el acreditado.' format: 'yyyy-MM-dd' Empleos: type: 'object' description: 'Si existen empleos, se listarán.' properties: empleos: type: 'array' items: $ref: '#/definitions/Empleo' Error: type: 'object' description: 'error' properties: codigo: type: 'string' example: 'VA003' description: 'Código de error.' mensaje: type: 'string' example: 'Título de error, El campo "{Campo}" es requerido.' description: 'Mensaje de error.' Errores: type: 'object' description: 'Si existen errores, se listarán.' properties: errores: type: 'array' items: $ref: '#/definitions/Error' PersonaPeticion: description: 'Datos generales de la persona a consultar.' type: 'object' required: - 'primerNombre' - 'apellidoPaterno' - 'apellidoMaterno' - 'fechaNacimiento' - 'rfc' - 'domicilio' properties: primerNombre: type: 'string' description: 'Primer nombre de la persona' minLength: 0 maxLength: 100 segundoNombre: type: 'string' description: 'Segundo nombre de la persona' minLength: 0 maxLength: 100 apellidoPaterno: type: 'string' description: 'Apellido paterno de la persona' minLength: 0 maxLength: 30 apellidoMaterno: type: 'string' description: 'Apellido materno de la persona' minLength: 0 maxLength: 30 apellidoAdicional: type: 'string' description: 'Apellido adicional de la persona, si tuviere' minLength: 0 maxLength: 30 fechaNacimiento: type: 'string' description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)' format: 'yyyy-MM-dd' rfc: type: 'string' description: 'RFC con homoclave de la persona' pattern: '^([A-ZÑ,&]{3,4}([0-9]{2})(0[1-9]|1[0-2])(0[1-9]|1[0-9]|2[0-9]|3[0-1]))([A-Z\\d]{3})?$' curp: type: 'string' description: 'CURP de la persona, emitida por RENAPO' pattern: '^([A-Z][AEIOUX][A-Z]{2}\\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\\d])(\\d)$' numeroSeguridadSocial: type: 'string' description: 'Debe colocar el número con el que el acreditado se encuentra afiliado a una institución de seguro social, el cual se compone por 11 caracteres Solo aplica para INFONAVIT y FOVISSSTE' minLength: 11 maxLength: 11 nacionalidad: type: 'string' description: '

Debe contener la clave de la nacionalidad del consumidor los valores posibles son los siguientes:

ClaveNacionalidadPaís
ADAndorraAndorra
AFAfganaAfganistán
AGAntigua y BarbadoAntigua y Barbado
AIAnguilaAnguila
ANAlbaniaAlbania
AOAngolaAngola
ASAscensiónAscensión
ATArgentinaArgentina
AUAustralianaAustralia
AWÁrabeArabia
AXAzoresAzores
BBBarbadosBarbados
BDBangladeshBangladesh
BEBelgaBélgica
BFBurkinaBurkina
BGBúlgaraBulgaria
BHBahreinBahrein
BIBurundiBurundi
BJBeninBenin
BKBirmaniaBirmania
BMButánBután
BNBruneiBrunei
BOBolivianaBolivia
BRBrasileñoBrasil
BSBahamasBahamas
BUBermudasBermudas
BWBotswanaBotswana
BXBosnia HerzegovinaBosnia Herzegovina
BZBeliceBelice
CBColombianaColombia
CCCórcegaCórcega
CDChadChad
CFRep. Central AfricanaRep. Central Africana
CGCongoCongo
CHLiechtensteinLiechtenstein
CIIslas CaimánIslas Caimán
CJComorosComoros
CLChilenaChile
CMCamerunésCamerún
CNCanadienseCanadá
CPChinaChina (Pekín)
CSRepública Checa EslovacaRepública Checa Eslovaca
CUCariacouCariacou
CVCabo VerdeCabo Verde
CYChipreChipre
DFAustriacaAustria
DJDjiboutiDjibouti
DKDanésDinamarca
DMDominicanaDominicana
DODominicanaRepública Dominicana
DWAlemanaAlemania
DZArgeliaArgelia
ECEcuatorianaEcuador
EGEgipciaEgipto
EMTimor OrientalTimor Oriental
ESEspañolaEspaña
ETEtiopiaEtiopia
FAIslas Falkland (Malvinas)Islas Falkland (Malvinas)
FEIslas FaroeIslas Faroe
FIFinlandiaFinlandia
FJFijiFiji
FPPolinesiaPolinesia
FRFrancesaFrancia
GBGabónGabón
GDGranadaGranada
GEGroenlandiaGroenlandia
GFGuayana FrancesaGuayana Francesa
GHGhanaGhana
GIGibraltarGibraltar
GMGambiaGambia
GNGuineaGuinea
GPGuadalupeGuadalupe
GQGuinea EcuatorialGuinea Ecuatorial
GRGriegaGrecia
GTGuatemaltecaGuatemala
GWGuinea BissauGuinea Bissau
GXRepública De GeorgiaRepública De Georgia
GYGuyanaGuyana
HAHaitianaHaití
HKHong KongHong Kong
HNHondureñaHonduras
HRCubanoCuba
HUHúngaraHúngara
HXCroataCroacia
IBIndiaIndia
ICCosta De MarfilCosta De Marfil
IEIrlandesaIrlandesa
IFIndonesiaIndonesia
IGIsraelíIsraelí
IQIraquíIraquí
IRIraníIraní
ISIslandiaIslandia
ITItalianoItaliano
JMJamaicanoJamaicano
JOJordanoJordano
JPJaponesaJaponesa
KAKampucheaKampuchea
KEKenyaKenya
KIKiribatiKiribati
KNSan Cristóbal De NeváisSan Cristóbal De Neváis
KRCorea Del SurCorea Del Sur
KWKuwaitKuwait
KXCorea Del NorteCorea Del Norte
LBLibanesLibanes
LCSanta LuciaSanta Lucia
LEIslas De SotaventoIslas De Sotavento
LKSri LankaSri Lanka
LOLaosLaos
LRLiberiaLiberia
LSLesothoLesotho
LTLituaniaLituania
LULuxemburgoLuxemburgo
LVLibiaLibia
LXLetoniaLetonia
MCMongoliaMongolia
MDMadeiraMadeira
MGMadagascarMadagascar
MHMacedoniaMacedonia
MJMacaoMacao
MKMontserratMontserrat
MLMaliMali
MMMontenegroMontenegro
MPSao Tome y PrincipadoSao Tome y Principado
MQMartinicoMartinico
MRMauritaniaMauritania
MTMaltaMalta
MUMauricioMauricio
MVMaldivasMaldivas
MWMalawiMalawi
MXMexicanaMéxico
MYMalasiaMalasia
MZMozambiqueMozambique
NANauruNauru
NDNo DefinidoNo Definido
NINicaraguaNicaragua
NLHolandesaHolanda
NNAntillas HolandesasAntillas Holandesas
NONoruegaNoruega
NPNepalNepal
NRNigerianoNigeria
NWNueva CaledoniaNueva Caledonia
NZNueva ZelandiaNueva Zelandia
OAKatarKatar
OMOmánOmán
PGPapúa Nueva GuineaPapúa Nueva Guinea
PHFilipinasFilipinas
PKPakistánPakistán
PLPolacoPolonia
PMPanameñoPanamá
PSIslas PitcairnIslas Pitcairn
PTPortuguésPortugal
PUPeruanaPerú
PYParaguayoParaguay
RCMarroquíMarruecos
REIslas ReuniónIslas Reunión
RORumanaRumania
RURusaRusia
RWRuandaRuanda
SASaudí ÁrabeArabia Saudita
SBSudanSudan
SESuecoSuecia
SFSan Vencen y Las GranadasSan Vencen y Las Granadas
SHSanta HelenaSanta Helena
SIIslas SalmonIslas Salmon
SNSenegalSenegal
SOSomaliaSomalia
SPSan Pierre y MiquelónSan Pierre y Miquelón
SRSurinamSurinam
SSSan KittsSan Kitts
STIslas Santa CruzIslas Santa Cruz
SUEstoniaEstonia
SVSalvadoreñaEl Salvador
SWSuizaSuiza
SXSerbiaSerbia
SYSiriaSiria
SZSwazilandiaSwazilandia
TATongaTonga
TCTurcos e Islas CaicosTurcos e Islas Caicos
TDTristán De CunhaTristán De Cunha
TGTogoTogo
THTailandiaTailandia
TRTurcaTurquía
TTTrinidad y TobagoTrinidad y Tobago
TUTúnezTúnez
TVTuvalaTuvala
TWTaiwánTaiwán
TZTanzaniaTanzania
UAUcranianoUcrania
UGUgandaUganda
UKReino UnidoReino Unido
UMÁrabeEmiratos Árabes Unidos
USEstadounidenseEstados Unidos
UYUruguayoUruguay
VCCiudad Del VaticanoCiudad Del Vaticano
VEVenezolanaVenezuela
VGIslas Vírgenes InglesasIslas Vírgenes Inglesas
VNVietnamiVietnam
VUVanuatuVanuatu
WSSamoa OesteSamoa Oeste
WTGales / Isla FuturaGales / Isla Futura
XNEsloveniaEslovenia
YEYemen (Del Sur)Yemen (Del Sur)
YSYemen (Del Norte)Yemen (Del Norte)
ZASudafricanaÁfrica Del Sur
ZMZambiaZambia
ZRZaireZaire
ZWZimbabweZimbabwe