swagger: '2.0'
info:
  title: 'FICO® Score - Simulación'
  description: "<p>La API de FICO® Score determina la probabilidad de incumplimiento de un acreditado en los próximos doce meses. A mayor puntaje de score, menor es el riesgo.<br><br><img src='https://developer.circulodecredito.com.mx/sites/default/files/2020-10/circulo_de_credito-apihub.png'  width='240'/></p><br/>"
  version: 2.0.2
  termsOfService: 'https://developer.circulodecredito.com.mx/legal'
  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: 'FICO® Score'
    description: 'La API para FICO® Score calcula el score de la persona en cuestión.'
    externalDocs:
      description: 'Portal de desarrolladores'
      url: 'https://developer.circulodecredito.com.mx/productos/ficoscore-simulation'
schemes:
  - 'https'
paths:
  '/v2/ficoscore':
    post:
      tags:
        - 'FICO® Score'
      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: 'body'
          description: '<p>Ejemplos para generar diferentes respuestas:<br><ul><li><b>Status Code 200 Score 720</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "SESENTAYDOS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1965-08-09", <br>"RFC": "SEPJ650809JG1",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 58", <br>"coloniaPoblacion": "MONTEVIDEO", <br>"delegacionMunicipio": "GUSTAVO A MADERO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "07730"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 650</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "CINCUENTAYNUEVE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1945-02-12", <br>"RFC": "CIPJ450212KG4",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 168", <br>"coloniaPoblacion": "CHALMA DE GUADALUPE", <br>"delegacionMunicipio": "GUSTAVO A MADERO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "07210"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 735</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "SESENTAYSIETE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1945-08-07", <br>"RFC": "SEPJ4508071Y8",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 746", <br>"coloniaPoblacion": "PUEBLO LA CANDELARIA", <br>"delegacionMunicipio": "COYOACAN", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "04380"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 550</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "DIEZYSEIS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1970-08-25", <br>"RFC": "DIPJ700825549",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 975", <br>"coloniaPoblacion": "AVANTE", <br>"delegacionMunicipio": "COYOACAN", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "04460"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 520</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "SESENTAYCINCO", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1974-02-11", <br>"RFC": "SEPJ740211TL7",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 285", <br>"coloniaPoblacion": "ALDANA", <br>"delegacionMunicipio": "AZCAPOTZALCO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "02910"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 640</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "DIEZ", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1969-01-20", <br>"RFC": "DIPJ690120I50",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 998", <br>"coloniaPoblacion": "PARAJE TLALATLACO", <br>"delegacionMunicipio": "XOCHIMILCO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "16247"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 500</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "TREINTAYOCHO", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1988-09-09", <br>"RFC": "TEPJ880909AKA",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 1646", <br>"coloniaPoblacion": "JUSTO SIERRA", <br>"delegacionMunicipio": "IZTAPALAPA", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "09460"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 525</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "CUARENTAYCUATRO", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1997-10-19", <br>"RFC": "CUPJ971019FM9",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 966", <br>"coloniaPoblacion": "SANTA LUCÍA CHANTEPEC", <br>"delegacionMunicipio": "ALVARO OBREGON", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "01509"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 610</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "SESENTAYSEIS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1975-10-02", <br>"RFC": "SEPJ751002UK4",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 974", <br>"coloniaPoblacion": "GRANJAS ESMERALDA", <br>"delegacionMunicipio": "IZTAPALAPA", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "09810"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 570</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "TREINTAYDOS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1986-05-28", <br>"RFC": "TEPJ860528278",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 1304", <br>"coloniaPoblacion": "SAN LUCAS XOCHIMANCA", <br>"delegacionMunicipio": "XOCHIMILCO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "16300"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 660</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "CUARENTAYOCHO", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1966-04-04", <br>"RFC": "CUPJ6604046Y9",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 180", <br>"coloniaPoblacion": "BARRIO SAN DIEGO", <br>"delegacionMunicipio": "XOCHIMILCO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "16080"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 380</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "TREINTAYSIETE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1967-01-29", <br>"RFC": "TEPJ670129E48",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 65", <br>"coloniaPoblacion": "EL PARQUE DE COYOACÁN", <br>"delegacionMunicipio": "COYOACAN", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "04899"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 405</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "EÑE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1969-12-11", <br>"RFC": "EEPJ691211166",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 1653", <br>"coloniaPoblacion": "APATLACO", <br>"delegacionMunicipio": "IZTAPALAPA", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "09430"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 510</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "TREINTAYSEIS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1949-10-04", <br>"RFC": "TEPJ491004CB9",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 304", <br>"coloniaPoblacion": "CARLOS ZAPATA VELA", <br>"delegacionMunicipio": "IZTACALCO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "08040"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 605</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "ONCE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1994-07-17", <br>"RFC": "OEPJ940717858",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 160", <br>"coloniaPoblacion": "TEPEYAC INSURGENTES", <br>"delegacionMunicipio": "GUSTAVO A MADERO", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "07020"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 535</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "CINCUENTAYSEIS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1955-07-19", <br>"RFC": "CIPJ550719EZ3",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 600", <br>"coloniaPoblacion": "LA ASUNCIÓN", <br>"delegacionMunicipio": "TLAHUAC", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "13000"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 470</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "CIENTOUNO", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1964-10-06", <br>"RFC": "CIPJ641006H3A",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 881", <br>"coloniaPoblacion": "PENSADOR MEXICANO", <br>"delegacionMunicipio": "VENUSTIANO CARRANZA", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "15510"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 600</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "DOS", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1964-02-04", <br>"RFC": "DOPJ6402046I9",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 1349", <br>"coloniaPoblacion": "SANTA CECILIA", <br>"delegacionMunicipio": "COYOACAN", <br>"ciudad": "CIUDAD DE MÉXICO", <br>"estado": "CDMX", <br>"CP": "04930"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 490</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "SESENTA", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1944-01-04", <br>"RFC": "SEPJ440104K91",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 772", <br>"coloniaPoblacion": "JOSÉ VASCONCELOS CALDERÓN", <br>"delegacionMunicipio": "AGUASCALIENTES", <br>"ciudad": "AGUASCALIENTES", <br>"estado": "AGS", <br>"CP": "20200"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 590</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "SETENTA", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1973-06-14", <br>"RFC": "SEPJ730614LK8",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 1837", <br>"coloniaPoblacion": "INFONAVIT LOMAS DEL PORVENIR", <br>"delegacionMunicipio": "TIJUANA", <br>"ciudad": "TIJUANA", <br>"estado": "BC", <br>"CP": "22535"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 545</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "TRECE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1988-12-03", <br>"RFC": "TEPJ881203DQ4",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 692", <br>"coloniaPoblacion": "LA LAGUNA", <br>"delegacionMunicipio": "COMONDU", <br>"ciudad": "COMONDU", <br>"estado": "BCS", <br>"CP": "23823"<br>}<br>}<br>}<br></li><li><b>Status Code 200 Score 450</b> <br>{<br>"folio": "123456",<br>"persona":{<br>"nombres": "JUAN",<br>"apellidoPaterno": "DIECISIETE", <br>"apellidoMaterno": "PRUEBA",<br>"fechaNacimiento": "1955-10-16", <br>"RFC": "DIPJ551016DM2",<br>"domicilio": {<br>"direccion": "PASADISO ENCONTRADO 1114", <br>"coloniaPoblacion": "TENABO CENTRO", <br>"delegacionMunicipio": "TENABO", <br>"ciudad": "TENABO", <br>"estado": "CAMP", <br>"CP": "24700"<br>}<br>}<br>}<br></li><li><b>Status Code 204</b> Colocar "JOHANN" en el campo "nombres" o "WOLFGANG" en el campo "apellidoPaterno"</li><li><b>Status Code 400</b> No especificar alguno de los campos requeridos como "nombres", "apellidoPaterno", "fechaNacimiento", "direccion", "codigoPostal", "colonia", "municipio", "ciudad", o "estado" </li><li><b>Status Code 401</b> Colocar "FRIEDRICH" en el campo "nombres" o colocar "NIETZSCHE" en el campo "segundoNombre"</li><li><b>Status Code 403</b> Colocar "COAH" en el campo "estado" </li><li><b>Status Code 429</b> Colocar "QROO" en el campo "estado" </li><li><b>Status Code 500</b> Colocar "DANIEL" en el campo "nombres" o "TAB" en el campo "estado" </li><li><b>Status Code 503</b> Colocar "LOUIS PASTEUR" en el campo "nombres" </li></ul></p>'
          required: true
          schema:
            $ref: '#/definitions/Peticion'
      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 "{Campo}" 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:
 
  CatalogoEstadoCivil:
    type: 'string'
    description: '<table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>D</td><td>Divorciado</td></tr><tr><td>L</td><td>Unión Libre</td></tr><tr><td>C</td><td>Casado</td></tr><tr><td>S</td><td>Soltero</td></tr><tr><td>V</td><td>Viudo</td></tr><tr><td>E</td><td>Separado</td></tr></tbody></table>'
    minLength: 1
    maxLength: 1
    enum:
      - 'D'
      - 'L'
      - 'C'
      - 'S'
      - 'V'
      - 'E'
  CatalogoEstados:
    type: 'string'
    description: 'Estado en que se ubica el domicilio <table><thead><tr><th>Clave</th><th>Estado</th></tr></thead><tbody><tr><td>AGS</td><td>AGUASCALIENTES</td></tr><tr><td>BC</td><td>BAJA CALIFORNIA NORTE</td></tr><tr><td>BCS</td><td>BAJA CALIFORNIA SUR</td></tr><tr><td>CAMP</td><td>CAMPECHE</td></tr><tr><td>CDMX</td><td>CIUDAD DE MÉXICO</td></tr><tr><td>CHIS</td><td>CHIAPAS</td></tr><tr><td>CHIH</td><td>CHIHUAHUA</td></tr><tr><td>COAH</td><td>COHAHUILA</td></tr><tr><td>COL</td><td>COLIMA</td></tr><tr><td>DF</td><td>DISTRITO FEDERAL</td></tr><tr><td>DGO</td><td>DURANGO</td></tr><tr><td>GTO</td><td>GUANAJUATO</td></tr><tr><td>GRO</td><td>GUERRERO</td></tr><tr><td>HGO</td><td>HIDALGO</td></tr><tr><td>JAL</td><td>JALISCO</td></tr><tr><td>MEX</td><td>MÉXICO</td></tr><tr><td>MICH</td><td>MICHOCÁN</td></tr><tr><td>MOR</td><td>MORELOS</td></tr><tr><td>NAY</td><td>NAYARIT</td></tr><tr><td>NL</td><td>NUEVO LEÓN</td></tr><tr><td>OAX</td><td>OXACA</td></tr><tr><td>PUE</td><td>PUEBLA</td></tr><tr><td>QRO</td><td>QUERÉTARO</td></tr><tr><td>QROO</td><td>QUINTANA ROO</td></tr><tr><td>SLP</td><td>SAN LUIS POTOSÍ</td></tr><tr><td>SIN</td><td>SINALOA</td></tr><tr><td>SON</td><td>SONORA</td></tr><tr><td>TAB</td><td>TABASCO</td></tr><tr><td>TAMP</td><td>TAMAULIPAS</td></tr><tr><td>TLAX</td><td>TLAXCALA</td></tr><tr><td>VER</td><td>VERACRUZ</td></tr><tr><td>YUC</td><td>YUCATÁN</td></tr><tr><td>ZAC</td><td>ZACATECAS</td></tr></tbody></table>'
    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'
  CatalogoRazones:
    type: 'string'
    description: 'Código de la razón por la que se genera el valor del score. Ver tabla Razones Score<table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>A0</td><td>Historial de pago de la cuenta es demasiado nuevo</td><tr><td>A1</td><td>Último reporte de la Cuenta en estatus de morosidad</td><tr><td>A2</td><td>Monto de crédito disponibles en cuentas revolventes</td><tr><td>A3</td><td>Monto de deuda en cuentas es demasiado alto</td><tr><td>A4</td><td>Monto de deuda en el banco/nacional en cuentas revolventes</td><tr><td>A5</td><td>Monto de deuda clasificado en cobranza</td><tr><td>A6</td><td>Monto de deuda en las cuentas morosas</td><tr><td>A7</td><td>Monto de deuda en cuentas abiertas recientemente es demasiado alto</td><tr><td>A8</td><td>Monto de deuda en cuentas revolventes abiertas recientemente de banco/nacionales es muy alta</td><tr><td>A9</td><td>Monto de deuda en cuentas abiertos recientemente en empresas de financiamiento al consumo es demasiado alto</td><tr><td>B0</td><td>Monto de deuda en cuentas de minoristas abiertas recientemente es demasiado alta</td><tr><td>B1</td><td>Monto de deuda en cuentas revolventes abiertas recientemente es demasiado alto</td><tr><td>B2</td><td>Monto de deuda en cuentas de empresas de financiamiento de ventas abiertas recientemente es muy alto</td><tr><td>B3</td><td>Monto de deuda en las cuentas de minoristas</td><tr><td>B4</td><td>Monto de deuda en cuentas revolventes</td><tr><td>B5</td><td>Monto de deuda en cuentas de crédito revolventes es demasiado alto</td><tr><td>B6</td><td>Montos en mora en cuentas</td><tr><td>D0</td><td>Declaración de quiebra reportada</td><tr><td>D1</td><td>Fecha de la última consulta muy reciente</td><tr><td>D2</td><td>Morosidad en las cuentas</td><tr><td>D3</td><td>Morosidad en cuentas abiertas recientemente</td><tr><td>D4</td><td>Eliminación de registro público o la cobranza reportada</td><tr><td>D5</td><td>La frecuencia de la morosidad</td><tr><td>D6</td><td>Nivel de morosidad en las cuentas</td><tr><td>D7</td><td>Morosidad grave</td><tr><td>D8</td><td>Morosidad grave, y registro público, o la cobranza reportada</td><tr><td>D9</td><td>Morosidad grave, registro público eliminado, o la cobranza reportada</td><tr><td>E0</td><td>Información Demográfica</td><tr><td>E1</td><td>Falta información demográfica</td><tr><td>E2</td><td>Número de consultas</td><tr><td>E3</td><td>Frecuencia de las consultas</td><tr><td>E4</td><td>La falta de información reciente de la cuenta</td><tr><td>E5</td><td>Monto de deuda en los registros públicos eliminados</td><tr><td>E6</td><td>Proporción del saldo sobre el límite de las cuentas</td><tr><td>F0</td><td>Historial de pagos disponible es insuficiente</td><tr><td>F1</td><td>Falta de cuentas de crédito de reciente creación</td><tr><td>F2</td><td>Falta de cuentas revolventes de reciente creación</td><tr><td>F3</td><td>Falta de información reciente de préstamo de autofinanciamiento</td><tr><td>F4</td><td>Falta de información reciente préstamo de auto</td><tr><td>F5</td><td>Falta de información reciente de banco/nacional revolvente</td><tr><td>F6</td><td>Falta de información reciente sobre cuentas de empresas de financiamiento al consumo</td><tr><td>F7</td><td>Falta de información reciente de préstamos</td><tr><td>F8</td><td>Falta de información reciente de préstamos hipotecarios</td><tr><td>F9</td><td>Falta de información reciente de préstamos no hipotecarios</td><tr><td>G0</td><td>Falta de información reciente de cuentas de minoristas</td><tr><td>G1</td><td>Falta de información reciente de cuentas revolventes</td><tr><td>G2</td><td>No hay créditos hipotecarios reportados</td><tr><td>G3</td><td>No hay información de saldos revolventes recientes de Bancos/Nacional</td><tr><td>G4</td><td>No hay información de saldos no hipotecarios recientes</td><tr><td>G5</td><td>No hay saldos de cuentas minoristas</td><tr><td>G6</td><td>No hay saldos revolventes recientes</td><tr><td>J0</td><td>Tiempo de Duración de las cuentas se han establecido</td><tr><td>J1</td><td>Tiempo de Duración de las cuentas de automóviles se han establecido</td><tr><td>J2</td><td>Tiempo de Duración de las cuentas revolventes del banco/nacionales se han establecido</td><tr><td>J3</td><td>Tiempo de Duración de los préstamos de compañías de financiamiento al consumo se han establecido</td><tr><td>J4</td><td>Tiempo de Duración de los préstamos a plazos se han establecido</td><tr><td>J5</td><td>Tiempo de Duración de las cuentas hipotecarias reportado se han establecido</td><tr><td>J6</td><td>Tiempo de Duración de los préstamos a plazos abiertos se han establecido</td><tr><td>J7</td><td>Tiempo de Duración de las cuentas de minoristas se han establecido</td><tr><td>J8</td><td>Tiempo de Duración de cuentas revolventes se han establecido</td><tr><td>J9</td><td>Tiempo transcurrido desde la actividad de la cuenta es demasiado largo</td><tr><td>K0</td><td>Tiempo transcurrido desde la Morosidad es demasiado reciente o desconocida</td><tr><td>K1</td><td>Tiempo transcurrido desde la eliminación del registro público o de la cobranza es demasiado corto</td><tr><td>K2</td><td>Tiempo transcurrido desde la apertura de la cuenta más reciente es demasiado corto</td><tr><td>K3</td><td>Tiempo transcurrido desde la más reciente apertura de cuenta automática es demasiado corto</td><tr><td>K4</td><td>Tiempo transcurrido desde la apertura de cuenta revolvente de banco/nacionales más reciente es demasiado corto</td><tr><td>K5</td><td>Tiempo transcurrido desde la apertura de cuenta de empresas de financiamiento de consumo más reciente es demasiado corto</td><tr><td>K6</td><td>Tiempo transcurrido desde la apertura de cuenta de préstamo a plazos más reciente es demasiado corto</td><tr><td>K7</td><td>Tiempo transcurrido desde la apertura de cuenta minorista más recientes</td><tr><td>K8</td><td>Tiempo transcurrido desde que se abrió la cuenta revolvente más reciente</td><tr><td>K9</td><td>Ha transcurrido muy poco tiempo desde que se abrió la cuenta más reciente de "sales finance"</td><tr><td>M0</td><td>Tiene un número de cuentas actualmente en impago</td><tr><td>M1</td><td>Número de cuentas "marcadas" con impago</td><tr><td>M2</td><td>Número de cuentas con impago reciente</td><tr><td>M3</td><td>Número de cuentas revolventes bancarias/nacionales activas</td><tr><td>M4</td><td>Número de cuentas activas de "retail"</td><tr><td>M5</td><td>Número de registros públicos adversos/derogados</td><tr><td>M6</td><td>Número de cuentas revolventes bancarias/nacionales con saldo</td><tr><td>M7</td><td>Número de cuentas revolventes bancarias/nacionales</td><tr><td>M8</td><td>Número de cuentas revolventes bancarias/nacionales u otras cuentas revolventes</td><tr><td>M9</td><td>Número de cobranzas registradas</td><tr><td>N0</td><td>Número de cuentas de "consumerfinancecompany" establecidas relativas a la longitud de la historia del consumidor</td><tr><td>N1</td><td>Número de consultas por compañías de financiamiento al consumo</td><tr><td>N2</td><td>Número de cuentas establecidas</td><tr><td>N3</td><td>Número de "open installmentloans"</td><tr><td>N4</td><td>Número de cuentas recientemente abiertas con compañías de financiamiento al consumo</td><tr><td>N5</td><td>Número de cuentas de "retail"</td><tr><td>N6</td><td>Número de cuentas de "retail" con saldo</td><tr><td>N7</td><td>Número de cuentas revolventes</td><tr><td>N8</td><td>Número de cuentas revolventes con saldos más altos que su límite</td><tr><td>P0</td><td>La proporción del saldo vs límite en las cuentas de préstamo automotriz es muy alta</td><tr><td>P1</td><td>La proporción del saldo vs límite en las cuentas con impago es muy alta</td><tr><td>P2</td><td>La proporción del saldo vs límite en las cuentas de financiamiento al consumo es muy alta</td><tr><td>P3</td><td>La proporción del saldo vs límite en las cuentas de "retail" es muy alta</td><tr><td>P5</td><td>La proporción del saldo vs el límite de crédito en cuentas revolventes nacionales o en otras cuentas revolventes es muy alta</td><tr><td>P6</td><td>La proporción del saldo vs límites de crédito en cuentas revolventes es muy alta</td><tr><td>P7</td><td>La proporción del saldo vs límite en "sales financecompany" es muy alta</td><tr><td>P8</td><td>La proporción del saldo vs el préstamo en créditos hipotecarios es muy alta</td><tr><td>P9</td><td>La proporción de saldo del préstamo vs la cantidad del préstamo es muy alta</td><tr><td>Q0</td><td>La proporción de saldos revolventes vs saldos totales es muy alta</td><tr><td>Q1</td><td>La proporción de saldos vs límites de créditos en las cuentas revolventes bancarias/nacionales es muy alta</td><tr><td>R0</td><td>Muy pocas cuentas han sido pagadas actualmente como fue convenido</td><tr><td>R1</td><td>Muy pocas cuentas con saldos</td><tr><td>R2</td><td>Muy pocas cuentas con información reciente de pagos</td><tr><td>R3</td><td>Muy pocas cuentas activas</td><tr><td>R4</td><td>Muy pocas cuentas revolventes bancarias/nacionales </td><tr><td>R5</td><td>Muy pocas cuentas revolventes bancarias/nacionales con información reciente de pagos</td><tr><td>R6</td><td>Muy pocas cuentas con compañías de financiamiento al consumo con información reciente de pagos </td><tr><td>R7</td><td>Muy pocas cuentas de "instalment"R8Muy pocas cuentas de "retail"</td><tr><td>R9</td><td>Muy pocas cuentas de "retail" con información reciente de pagos</td><tr><td>S0</td><td>Muy pocas cuentas revolventes</td><tr><td>S1</td><td>Muy pocas cuentas revolventes con información reciente de pagos</td><tr><td>S2</td><td>Muy pocas cuentas de "sales financecompany" con información reciente de pagos</td><tr><td>T0</td><td>Muchas cuentas abiertas recientemente</td><tr><td>T1</td><td>Muchas cuentas con saldos</td><tr><td>T2</td><td>Muchas cuentas revolventes bancarias/nacionales</td><tr><td>T3</td><td>Muchas cuentas de compañías financiamiento al consumo</td><tr><td>T4</td><td>Muchas cuentas de "instalment"</td><tr><td>T5</td><td>Muchas consultas en los últimos 12 meses</td><tr><td>T6</td><td>Muchas cuentas activas recientemente</td><tr><td>T7</td><td>Muchas cuentas de automóvil activas recientemente</td><tr><td>T8</td><td>Muchas cuentas revolventes bancarias/nacionales activas recientemente</td><tr><td>T9</td><td>Muchas cuentas de compañías financiamiento al consumo recientemente activas</td><tr><td>U0</td><td>Muchas cuentas de "instalment loan" recientemente activas</td><tr><td>U1</td><td>Muchas cuentas de "retail" recientemente activas</td><tr><td>U2</td><td>Muchas cuentas de "sales financecompany" recientemente activas</td><tr><td>U4</td><td>Muchas cuentas recientemente abiertas con saldos</td><tr><td>U5</td><td>Muchas cuentas revolventes bancarias/nacionales recientemente abiertas</td><tr><td>U6</td><td>Muchas cuentas de compañías de financiamiento al consumo recientemente abiertas</td><tr><td>U7</td><td>Muchas cuentas de "instalment" recientemente abiertas</td><tr><td>U8</td><td>Muchas cuentas de "retail" recientemente abiertas con saldos</td><tr><td>U9</td><td>Muchas cuentas revolventes recientemente abiertas</td><tr><td>V0</td><td>Muchas cuentas revolventes recientemente abiertas con saldos</td><tr><td>V1</td><td>Muchas cuentas de "sales financecompany" recientemente abiertasV2Muchas cuentas de "retail"</td><tr><td>V3</td><td>Muchas cuentas revolventes</td><tr><td>V4</td><td>Muchas cuentas revolventes bancarias/nacionales recientemente abiertas con saldos</td><tr><td>W3</td><td>Número de cuentas "subprime"</td><tr><td>W4</td><td>Falta de información de cargo reciente a tarjeta </td><tr><td>W5</td><td>Sin saldos de cargo a tarjeta recientes</td><tr><td>W6</td><td>Proporción de saldos vs límites de crédito en cuentas de "tarjetas de cargo" es muy alta</td><tr><td>W7</td><td>Sin saldos de cuenta recientesW8La proporción de "Cash Advances" vs el "Límite de Cash Advance" es muy alta</td><tr><td>W9</td><td>Cash Advance Activity on Accounts</td><tr><td>X0</td><td>Pagos pendientes en las cuentas</td><tr><td>C1</td><td>No existe el expediente.</td><tr><td>C2</td><td>El expediente encontrado no tiene cuentas.</td><tr><td>C3</td><td>El expediente encontrado está marcado como fallecido.</td><tr><td>C4</td><td>El expediente encontrado no tiene cuantas activas en los últimos 24 meses.</td><tr><td>C5</td><td>El expediente está marcado como fraudulento o sospechoso de fraude.</td><tr><td>SC</td><td>No pudo calcularse score.</td></tbody></table>'
    enum:
      - 'A0'
      - 'A1'
      - 'A2'
      - 'A3'
      - 'A4'
      - 'A5'
      - 'A6'
      - 'A7'
      - 'A8'
      - 'A9'
      - 'B0'
      - 'B1'
      - 'B2'
      - 'B3'
      - 'B4'
      - 'B5'
      - 'B6'
      - 'D0'
      - 'D1'
      - 'D2'
      - 'D3'
      - 'D4'
      - 'D5'
      - 'D6'
      - 'D7'
      - 'D8'
      - 'D9'
      - 'E0'
      - 'E1'
      - 'E2'
      - 'E3'
      - 'E4'
      - 'E5'
      - 'E6'
      - 'F0'
      - 'F1'
      - 'F2'
      - 'F3'
      - 'F4'
      - 'F5'
      - 'F6'
      - 'F7'
      - 'F8'
      - 'F9'
      - 'G0'
      - 'G1'
      - 'G2'
      - 'G3'
      - 'G4'
      - 'G5'
      - 'G6'
      - 'J0'
      - 'J1'
      - 'J2'
      - 'J3'
      - 'J4'
      - 'J5'
      - 'J6'
      - 'J7'
      - 'J8'
      - 'J9'
      - 'K0'
      - 'K1'
      - 'K2'
      - 'K3'
      - 'K4'
      - 'K5'
      - 'K6'
      - 'K7'
      - 'K8'
      - 'K9'
      - 'M0'
      - 'M1'
      - 'M2'
      - 'M3'
      - 'M4'
      - 'M5'
      - 'M6'
      - 'M7'
      - 'M8'
      - 'M9'
      - 'N0'
      - 'N1'
      - 'N2'
      - 'N3'
      - 'N4'
      - 'N5'
      - 'N6'
      - 'N7'
      - 'N8'
      - 'P0'
      - 'P1'
      - 'P2'
      - 'P3'
      - 'P5'
      - 'P6'
      - 'P7'
      - 'P8'
      - 'P9'
      - 'Q0'
      - 'Q1'
      - 'R0'
      - 'R1'
      - 'R2'
      - 'R3'
      - 'R4'
      - 'R5'
      - 'R6'
      - 'R7'
      - 'R9'
      - 'S0'
      - 'S1'
      - 'S2'
      - 'T0'
      - 'T1'
      - 'T2'
      - 'T3'
      - 'T4'
      - 'T5'
      - 'T6'
      - 'T7'
      - 'T8'
      - 'T9'
      - 'U0'
      - 'U1'
      - 'U2'
      - 'U4'
      - 'U5'
      - 'U6'
      - 'U7'
      - 'U8'
      - 'U9'
      - 'V0'
      - 'V1'
      - 'V3'
      - 'V4'
      - 'W3'
      - 'W4'
      - 'W5'
      - 'W6'
      - 'W7'
      - 'W9'
      - 'X0'
      - 'C1'
      - 'C2'
      - 'C3'
      - 'C4'
      - 'C5'
      - 'SC'
  CatalogoResidencia:
    type: 'integer'
    format: 'int32'
    description: 'Descripciones para los valores enviados en este campo por Círculo de Crédito. <table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>1</td><td>Propietario</td></tr><tr><td>2</td><td>Renta</td></tr><tr><td>3</td><td>Vive con Familiares</td></tr><tr><td>4</td><td>Vivienda Hipotecada</td></tr><tr><td>5</td><td>No Disponible</td></tr></tbody></table>'
    minimum: 1
    maximum: 5
    enum:
      - 1
      - 2
      - 3
      - 4
      - 5
  CatalogoSexo:
    type: 'string'
    description: '<table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>F</td><td>Femenino</td></tr><tr><td>M</td><td>Masculino</td></tr></tbody></table>'
    minLength: 1
    maxLength: 1
    enum:
      - 'F'
      - 'M'
  CatalogoTipoAsentamiento:
    type: 'string'
    description: '<table><thead><tr><th>Clave</th><th>Tipo de Asentamiento</th></tr></thead><tbody><tr><td>0</td><td>PENDIENTE POR ACTUALIZAR</td></tr><tr><td>1</td><td>AEROPUERTO</td></tr><tr><td>2</td><td>BARRIO</td></tr><tr><td>3</td><td>BASE NAVAL</td></tr><tr><td>4</td><td>CAMPAMENTO</td></tr><tr><td>5</td><td>CENTRO</td></tr><tr><td>6</td><td>CENTRO URBANO</td></tr><tr><td>7</td><td>COLONIA</td></tr><tr><td>8</td><td>CONDOMINIO</td></tr><tr><td>9</td><td>CONGREGACION</td></tr><tr><td>10</td><td>CONJUNTO HABITACIONAL</td></tr><tr><td>11</td><td>CONJUNTO HABITACIONAL RESIDENCIAL</td></tr><tr><td>12</td><td>CONJUNTO HABITACIONAL URBANO</td></tr><tr><td>13</td><td>CONJUNTO POPULAR</td></tr><tr><td>14</td><td>CONJUNTO RESIDENCIAL</td></tr><tr><td>15</td><td>CONJUNTO URBANO</td></tr><tr><td>16</td><td>CONJUNTO URBANO POPULAR</td></tr><tr><td>17</td><td>EJIDO</td></tr><tr><td>18</td><td>ESCUELA</td></tr><tr><td>19</td><td>ESTACION DE RADIO</td></tr><tr><td>20</td><td>EX-HACIENDA</td></tr><tr><td>21</td><td>EX-RANCHO</td></tr><tr><td>22</td><td>FABRICA</td></tr><tr><td>23</td><td>FINCA</td></tr><tr><td>24</td><td>FRACCIONAMIENTO</td></tr><tr><td>25</td><td>FRACCIONAMIENTO INDUSTRIAL</td></tr><tr><td>26</td><td>FRACCIONAMIENTO RESIDENCIAL</td></tr><tr><td>27</td><td>GRANJA</td></tr><tr><td>28</td><td>HACIENDA</td></tr><tr><td>29</td><td>INGENIO</td></tr><tr><td>30</td><td>JUNTA AUXILIA</td></tr><tr><td>31</td><td>MODULO HABIT</td></tr><tr><td>32</td><td>PARQUE</td></tr><tr><td>33</td><td>PARQUE INDUS</td></tr><tr><td>34</td><td>CUADRILLA</td></tr><tr><td>35</td><td>POBLADO COM</td></tr><tr><td>36</td><td>PUEBLO</td></tr><tr><td>37</td><td>RANCHO O RAN</td></tr><tr><td>38</td><td>RESIDENCIAL</td></tr><tr><td>39</td><td>VILLA</td></tr><tr><td>40</td><td>UNIDAD HABIT</td></tr><tr><td>41</td><td>ZONA FEDERAL</td></tr><tr><td>42</td><td>ZONA HABITAC</td></tr><tr><td>43</td><td>ZONA INDUSTR</td></tr><tr><td>44</td><td>ZONA RESIDEN</td></tr><tr><td>45</td><td>ZONA URBANA</td></tr><tr><td>46</td><td>ZONA URBANA</td></tr><tr><td>47</td><td>CAMPO MILITA</td></tr><tr><td>48</td><td>VIVIENDA POPU</td></tr><tr><td>49</td><td>CLUB DE GOLF</td></tr><tr><td>50</td><td>COOPERATIVA</td></tr><tr><td>51</td><td>CIUDAD</td></tr><tr><td>52</td><td>OFICINA DE CO</td></tr><tr><td>53</td><td>GRAN USUARIO</td></tr><tr><td>54</td><td>ZONA COMERC</td></tr><tr><td>55</td><td>ZONA RURAL</td></tr></tbody></table>'
    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'
  CatalogoTipoDomicilio:
    type: 'string'
    description: '<table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>N</td><td>Negocio</td></tr><tr><td>O</td><td>Domicilio del otorgante</td></tr><tr><td>C</td><td>Casa</td></tr><tr><td>P</td><td>Apartado Postal</td></tr><tr><td>E</td><td>Empleo</td></tr></tbody></table>'
    minLength: 1
    maxLength: 1
    example: 'C'
    enum:
      - 'N'
      - 'O'
      - 'C'
      - 'P'
      - 'E'
  Domicilio:
    type: 'object'
    description: 'Datos del domicilio de la persona a consultar'
    required:
      - 'direccion'
      - 'ciudad'
      - 'codigoPostal'
      - 'estado'
      - 'municipio'
      - 'coloniaPoblacion'
    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.'
        maxLength: 80
        example: 'HIDALGO 32'
      coloniaPoblacion:
        type: 'string'
        description: 'Reportar la colonia a la cual pertenece la dirección contenida en el elemento dirección.'
        maxLength: 65
        example: 'CENTRO'
      delegacionMunicipio:
        type: 'string'
        description: 'Reportar la delegación o municipio a la cual pertenece la dirección contenida en el elemento Dirección.'
        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.'
        maxLength: 65
        example: 'BENITO JUAREZ'
      estado:
        $ref: '#/definitions/CatalogoEstados'
      CP:
        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.'
        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'
        example: "2018-12-21"
      numeroTelefono:
        type: 'string'
        description: 'Debe de contener una longitud mínima de 5 caracteres. Cada carácter debe ser un número de 0-9, si se ingresa cualquier otro carácter el registro será rechazado.'
        maxLength: 20
        example: '5512345678'
      tipoDomicilio:
        $ref: '#/definitions/CatalogoTipoDomicilio'
      tipoAsentamiento:
        $ref: '#/definitions/CatalogoTipoAsentamiento'
      fechaRegistroDomicilio:
        type: 'string'
        description: 'Fecha en la cual se registró el domicilio.'
        format: 'yyyy-MM-dd'
        example: "2018-12-20"
      tipoAltaDomicilio:
        type: 'integer'
        format: 'int32'
        description: 'Los valores posibles: 0 = Alta de crédito 1 = Consulta expediente'
        minimum: 0
        maximum: 1
      idDomicilio:
        type: 'string'
        description: 'Identificador único del domicilio'
        example: '316110890'
  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'
  Peticion:
    type: 'object'
    required:
      - 'persona'
      - 'folio'
    properties:
      folio:
        type: 'string'
        description: 'Folio de la consulta con relación al otorgante'
        example: '0000001'
      persona:
        $ref: '#/definitions/Persona'
    description: 'Datos generales de la persona a consultar.'
    example:
      folio: '123456'
      persona:
        nombres: 'JUAN'
        apellidoPaterno: 'SESENTAYDOS'
        apellidoMaterno: 'PRUEBA'
        fechaNacimiento: '1965-08-09'
        RFC: 'SEPJ650809JG1'
        domicilio:
          direccion: 'PASADISO ENCONTRADO 58'
          coloniaPoblacion: 'MONTEVIDEO'
          ciudad: 'CIUDAD DE MÉXICO'
          CP: '07730'
          delegacionMunicipio: 'GUSTAVO A MADERO'
          estado: 'CDMX'
  Persona:
    type: 'object'
    required:
      - 'nombres'
      - 'apellidoPaterno'
      - 'apellidoMaterno'
      - 'fechaNacimiento'
      - 'domicilio'
    properties:
      apellidoPaterno:
        type: 'string'
        description: 'Reportar el Apellido Paterno completo, no usar abreviaturas o iniciales'
        maxLength: 30
        example: 'PRUEBA'
      apellidoMaterno:
        type: 'string'
        description: 'Cuando solo se reporte un Apellido, este debe ser puesto en Apellido Paterno y el ApellidoMaterno contendrá "NO PROPORCIONADO".'
        maxLength: 30
        example: 'CUATRO'
      apellidoAdicional:
        type: 'string'
        description: 'Puede utilizarse para reporta el Apellido de casada.'
        maxLength: 30
      nombres:
        type: 'string'
        description: 'Reportar Primer Nombre, Segundo Nombre o Nombres compuestos del consumidor. No se aceptan abreviaciones'
        maxLength: 50
        example: 'JUAN'
      fechaNacimiento:
        type: 'string'
        description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)'
        format: 'yyyy-MM-dd'
        example: '1980-01-04'
      RFC:
        type: 'string'
        description: 'RFC con homoclave de la persona'
        pattern: '^([A-ZÑ,&amp;]{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})?$'
        example: 'PUAC800104'
      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)$'
        example: 'SAZR010101HCMLNS09'
      nacionalidad:
        type: 'string'
        description: 'Debe contener la clave de la nacionalidad del consumidor.'
        maxLength: 2
      residencia:
        $ref: '#/definitions/CatalogoResidencia'
      estadoCivil:
        $ref: '#/definitions/CatalogoEstadoCivil'
      sexo:
        $ref: '#/definitions/CatalogoSexo'
      claveElectorIFE:
        type: 'string'
        description: 'La clave de elector que se encuentra en el IFE/INE.'
        maxLength: 20
      numeroDependientes:
        type: 'integer'
        format: 'int32'
        description: 'Se debe de reportar el número de Dependientes Económicos del Consumidor.'
      fechaDefuncion:
        type: 'string'
        description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)'
        format: 'yyyy-MM-dd'
        example: '9999-01-01'
      domicilio:
        $ref: '#/definitions/Domicilio'
    description: 'Datos generales de la persona a consultar.'
  Respuesta:
    type: 'object'
    properties:
      folioConsulta:
        type: 'string'
        description: 'Folio de la consulta'
        example: '386636538'
      folio:
        type: 'string'
        description: 'Folio de la consulta con relación al otorgante'
        example: '0000001'
      score:
        $ref: '#/definitions/Score'
  Score:
    type: 'object'
    description: 'Contiene los elementos Score.'
    properties:
      nombreScore:
        type: 'string'
        description: 'Nombre del modelo o tipo de score que se está reportando.'
        example: 'FICO'
      valor:
        type: 'integer'
        format: 'int32'
        description: 'Valor de la calificación (SCORE) reportado. Los valores para FICO pueden ser 0 o dentro del intervalo 300 a 850.'
        minimum: 0
        maximum: 900
        example: 546
      razones:
        type: 'array'
        items:
          $ref: '#/definitions/CatalogoRazones'
        minItems: 1
        maxItems: 4
        example:
          - 'D8'
          - 'E4'
          - 'K0'
          - 'D2'
