swagger: '2.0'
info:
  title: 'FICO® Extended Score v2'
  description: "La API para FICO® Score Extended, es el primer score en el mercado mexicano que califica el nivel de cumplimiento de pago de un individuo considerando al grupo de personas con las que comparte domicilio. <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.1
  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: '/'
tags:
  - name: 'FICO Extended Score'
    description: La API para FICO® Score Extended calcula el Score de la persona en cuestión.
    externalDocs:
      description: 'Portal de desarrolladores'
      url: 'https://developer.circulodecredito.com.mx/productos'
schemes:
  - 'https'
paths:
  '/v2/ficoextended':
    post:
      summary: ''
      description: ''
      tags:
        - Fico Extended Score
      operationId: 'getReporte'
      consumes:
        - 'application/json'
      produces:
        - 'application/json'
      parameters:
        - name: 'x-signature'
          in: 'header'
          required: true
          type: 'string'
          description: 'Firma generada con la llave privada'
          default: ''
        - name: 'x-api-key'
          in: 'header'
          required: true
          type: 'string'
          description: 'ConsumerKey obtenido desde el portal de desarrolladores'
          default: ''
        - name: 'username'
          in: 'header'
          required: true
          type: 'string'
          description: 'Usuario de Círculo de Crédito'
          default: ''
        - name: 'password'
          in: 'header'
          required: true
          type: 'string'
          description: 'Contraseña de Círculo de Crédito'
          default: ''
        - in: 'body'
          name: 'body'
          description: ''
          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>El historial de pago de la(s) cuenta(s) es demasiado reciente para su clasificación</td><tr><td>A1</td><td>Último reporte de la(s) cuenta(s) con estatus de morosidad.</td><tr><td>A2</td><td>Monto de crédito disponible en cuenta(s) revolvente(s).</td><tr><td>A3</td><td>El monto de deuda en cuenta(s) es demasiado alto.</td><tr><td>A5</td><td>Monto de deuda en cuenta(s) enviada(s) a cobranza.</td><tr><td>A6</td><td>Monto de deuda en cuenta(s) morosa(s).</td><tr><td>A7</td><td>El monto de deuda en cuenta(s) abierta(s) recientemente es demasiado alto.</td><tr><td>A9</td><td>El monto de deuda en cuenta(s) abierta(s) recientemente en  financieras para el consumidor es demasiado alto</td><tr><td>B0</td><td>El monto de deuda en cuenta(s) abierta(s) de consumo es demasiado algo</td><tr><td>B1</td><td>El monto de deuda en cuenta(s) abierta(s) de cargo(s) revolvente es demasiado alto</td><tr><td>B2</td><td>El monto de deuda en cuenta(s) abierta(s) en compañías de finanzas al consumidor es demaisado alto</td><tr><td>B3</td><td>Monto de deuda en cuenta(s) de consumo</td><tr><td>B4</td><td>Monto de deuda en cuenta(s) revolente</td><tr><td>B5</td><td>Monto de deuda en cuenta(s) de crédito(s) revolvente(s) demasiado alto.</td><tr><td>B6</td><td>Saldo vencido en cuenta(s).</td><tr><td>B7</td><td>El monto de deuda en cuenta(s) revolvente es demasiado alto</td><tr><td>D0</td><td>Declaración de quiebra reportada.</td><tr><td>D1</td><td>Fecha de la última consulta muy reciente.</td><tr><td>D2</td><td>Morosidad en cuenta(s).</td><tr><td>D3</td><td>Morosidad en cuenta(s) abierta(s) recientemente.</td><tr><td>D4</td><td>Registro(s) público(s) adverso(s) o cobranza reportada.</td><tr><td>D5</td><td>Morosidad frecuente.</td><tr><td>D6</td><td>Nivel de morosidad en cuentas.</td><tr><td>D7</td><td>Morosidad grave.</td><tr><td>D8</td><td>Morosidad grave, registro público adverso o cobranza reportada.</td><tr><td>D9</td><td>Morosidad en cuenta relacionada</td><tr><td>D10</td><td>Morosidad en prestamo relacionado</td><tr><td>D11</td><td>Morosidad reciente en cuenta relacionada</td><tr><td>D12</td><td>Morosidad en prestamo de consumo</td><tr><td>D13</td><td>Morosidad relacionado al pago semanal del crédito</td><tr><td>D14</td><td>Morosidad en pago semanal del crédito</td><tr><td>E0</td><td>Información Demográfica.<tr><td>E1</td><td>Falta información demográfica.</td><tr><td>E2</td><td>Número de consultas.</td><tr><td>E3</td><td>Frecuencia de consultas.</td><tr><td>E4</td><td>Falta de información reciente de la(s) cuenta(s)</td><tr><td>E5</td><td>Monto de deuda en registro(s) público(s) adverso(s).</td><tr><td>E6</td><td>Proporción del saldo respecto al límite de crédito en cuenta(s).</td><tr><td>E7</td><td>Frecuencia de consultas relacionadas.</td><tr><td>E8</td><td>Información insuficiente</td><tr><td>F0</td><td>Historial de pagos fijos insuficiente.</td><tr><td>F1</td><td>Falta de cuentas de crédito de reciente creación.</td><tr><td>F2</td><td>Falta de información reciente en cuenta(s) revolventes</td><tr><td>F3</td><td>Falta de información reciente de préstamo(s) de autofinanciamiento.</td><tr><td>F4</td><td>Falta de información reciente de préstamo(s) de auto.</td><tr><td>F6</td><td>Falta de información reciente en cuenta(s) en financieras para el consumidor</td><tr><td>F7</td><td>Falta de información reciente de préstamo(s) a plazo fijo.</td><tr><td>F8</td><td>Falta de información reciente de préstamo(s) hipotecarios.</td><tr><td>F9</td><td>Falta de información reciente de préstamo(s) con garantía(s).</td><tr><td>G0</td><td>Falta de información reciente en cuenta(s) al consumo</td><tr><td>G1</td><td>Falta de información reciente de cuentas revolventes.</td><tr><td>G2</td><td>Sin préstamos hipotecarios</td><tr><td>G4</td><td>Sin información reciente de balances hipotecarios</td><tr><td>G5</td><td>Sin balances recientes de consumo</td><tr><td>G6</td><td>No hay saldos revolventes recientes.</td><tr><td>G7</td><td>Sin previa mora en pago</td><tr><td>G8</td><td>Sin cuenta(s) con pago semanal</td><tr><td>J0</td><td>Antigüedad desde la apertura de cuenta(s).</td><tr><td>J1</td><td>Antigüedad desde la apertura de cuenta(s) automotrices</td><tr><td>J3</td><td>Antigüedad desde la apertura de cuenta(s) de créditos en financieras al consumidor</td><tr><td>J4</td><td>Antigüedad desde la apertura de préstamo(s) a plazo fijo.</td><tr><td>J5</td><td>Antigüedad desde la apertura de cuenta(s) hipotecaria(s).</td><tr><td>J6</td><td>Antigüedad desde la apertura en cuenta(s) abierta(s).</td><tr><td>J7</td><td>Antigüedad desde la apertura en cuenta(s) al consumo</td><tr><td>J8</td><td>Antigüedad desde la apertura de cuenta(s) revolvente(s).</td><tr><td>J9</td><td>Antigüedad desde la apertura de cuenta(s) con garantía(s).</td><tr><td>J10</td><td>Antigüedad desde la apertura en el hogar</td><tr><td>K0</td><td>Tiempo transcurrido desde la Morosidad es demasiado reciente o desconocido.</td><tr><td>K1</td><td>Tiempo transcurrido desde registro(s) público(s) adverso(s) o cobranza es demasiado corto.</td><tr><td>K2</td><td>Tiempo transcurrido desde la apertura de cuenta más reciente es demasiado corto.</td><tr><td>K3</td><td>Tiempo transcurrido desde la apertura de cuenta(s) de automotriz más reciente es demasiado corto.</td><tr><td>K5</td><td>Tiempo transcurrido desde la apertura de cuenta(s) en financieras para el consumidor más reciente es demasiado corto.</td><tr><td>K6</td><td>Tiempo transcurrido desde la apertura de cuenta(s) de préstamo a plazo fijo más reciente es demasiado corto.</td><tr><td>K7</td><td>Tiempo transcurrido desde la apertura de cuenta(s) al consumo más reciente es demasiado corto.</td><tr><td>K8</td><td>Tiempo transcurrido desde la apertura de cuenta(s) revolvente(s) más reciente es demasiado corto.</td><tr><td>K9</td><td>Tiempo transcurrido desde la apertura de cuenta(s) en compañías de finanzas más reciente es demasiado corto.</td><tr><td>K10</td><td>Tiempo relacionado desde la Morosidad es demasiado reciente o desconocido.</td><tr><td>M0</td><td>Cantidad de Cuentas actualmente con estatus de mora.</td><tr><td>M1</td><td>Cantidad de Cuentas en mora.</td><tr><td>M2</td><td>Cantidad de Cuentas actualmente con reciente mora.</td><tr><td>M4</td><td>Cantidad de Cuentas de consumo activa</td><tr><td>M5</td><td>Cantidad de Registros públicos adversos o negativos.</td><tr><td>M6</td><td>Cantidad de Registros de impago</td><tr><td>M9</td><td>Cantidad de Cuentas enviadas a cobranza.</td><tr><td>M10</td><td>Cantidad de Registros relacionados negativos.</td><tr><td>N0</td><td>Cantidad de Cuentas abiertas en financieras para el consumidor relacionados al periodo  de financiamientos al consumo</td><tr><td>N1</td><td>Cantidad de consultas en financieras para el consumidor.</td><tr><td>N2</td><td>Cantidad de Cuentas abiertas.</td><tr><td>N3</td><td>Cantidad de Préstamos abiertos a plazo fijo.</td><tr><td>N4</td><td>Cantidad de Cuentas recientes en financieras para el cosumidor</td><tr><td>N5</td><td>Cantidad de Cuentas de consumo</td><tr><td>N6</td><td>Cantidad de Balances en Cuentas de consumo</td><tr><td>N7</td><td>Cantidad de Cuentas revolventes.</td><tr><td>N8</td><td>Cantidad de Cuentas revolventes con saldo superior al límite.</td><tr><td>N9</td><td>Cantidad en Cuentas abiertas</td><tr><td>N10</td><td>Cantidad en Cuentas con pagos semanales</td><tr><td>P0</td><td>Proporción del saldo respecto al límite para cuenta(s) demasiado alto.</td><tr><td>P1</td><td>Proporción del saldo respecto al límite para cuenta(s) morosa(s) demasiado alto.</td><tr><td>P2</td><td>Proporción del saldo respecto al límite para cuenta(s) en financieras para el consumidor  es muy alto</td><tr><td>P3</td><td>Proporción del saldo respecto al límite para cuenta(s) de consumo es muy alto</td><tr><td>P6</td><td>Proporción del saldo respecto al límite para cuenta(s) revolvente(s) demasiado alto.</td><tr><td>P7</td><td>Proporción del saldo respecto al límite para cuenta(s) de compañía de finanzas es muy alto</td><tr><td>P8</td><td>Proporción del saldo respecto al límite para montos de préstamos es muy alto</td><tr><td>P9</td><td>Proporción del saldo de Préstamo(s) respecto al Monto de los Préstamo(s) demasiado alto.</td><tr><td>Q0</td><td>Proporción del saldo(s) revolvente(s) respecto de saldo(s) total(s) demasiado alto.</td><tr><td>R0</td><td>Muy pocas cuentas con pagos al corriente según lo pactado.</td><tr><td>R1</td><td>Muy pocas cuentas con saldos.</td><tr><td>R2</td><td>Muy pocas cuentas con información de pago reciente.</td><tr><td>R3</td><td>Muy pocas cuentas activas.</td><tr><td>R6</td><td>Muy pocas cuentas de financieras para el consumidor con información de pago reciente</td><tr><td>R7</td><td>Muy pocas cuentas a plazo fijo.</td><tr><td>R8</td><td>Muy pocas cuentas de consumo.</td><tr><td>R9</td><td>Muy pocas cuentas de consumo con información de pago reciente.</td><tr><td>R10</td><td>Muy pocas cuentas relacionadas pagadas al corriente</td><tr><td>S0</td><td>Muy pocas cuentas de crédito revolvente.</td><tr><td>S1</td><td>Muy pocas cuentas de crédito revolvente con información de pago reciente</td><tr><td>S2</td><td>Muy pocas cuentas de compañías de finanzas con información de pago reciente</td><tr><td>T0</td><td>Demasiadas cuentas abiertas recientemente.</td><tr><td>T1</td><td>Demasiadas cuentas con saldos.</td><tr><td>T3</td><td>Demasidas cuentas en financieras para el consumidor</td><tr><td>T4</td><td>Demasiadas cuentas a plazo fijo.</td><tr><td>T5</td><td>Demasiadas consultas en los últimos 12 meses.</td><tr><td>T6</td><td>Demasiadas cuentas activadas recientemente.</td><tr><td>T7</td><td>Demasiadas cuentas activadas de auto recientemente.</td><tr><td>T9</td><td>Demasiadas cuentas activadas recientemente en financieras para el consumidor</td><tr><td>U0</td><td>Demasiadas cuentas activadas recientemente de préstamos</td><tr><td>U1</td><td>Demasiadas cuentas activadas recientemente de consumo</td><tr><td>U2</td><td>Demasiadas cuentas activadas en compañía de finanzas</td><tr><td>U4</td><td>Demasiadas cuentas abiertas recientemente con saldos.</td><tr><td>U6</td><td>Demasiadas cuentas abiertas recientemente en financieras para el consumidor</td><tr><td>U7</td><td>Demasiadas cuentas recientemente abiertas de préstamos</td><tr><td>U8</td><td>Demasiadas cuentas de consumo recientemente abiertas con saldos</td><tr><td>U9</td><td>Demasiadas cuentas revolventes recientemente abiertas </td><tr><td>V0</td><td>Demasiadas cuentas revolventes recientemente abiertas con saldos</td><tr><td>V1</td><td>Demasiadas cuentas recientemente abiertas en compañías financieras</td><tr><td>V2</td><td>Demasiadas cuentas de consumo  </td><tr><td>V3</td><td>Demasiadas cuentas revolventes.</td><tr><td>W4</td><td>Falta de información reciente en cargos de tarjetas</td><tr><td>W5</td><td>Sin saldos recientes en tarjetas</td><tr><td>W6</td><td>Proporción de saldos a los límites de crédito en cargos de tarjetas es muy alta</td><tr><td>X0</td><td>Cuentas con pago(s) vencido(s).</td><tr><td>SC</td><td>No se calculó el Score por servicio temporalmente no disponible o tiempo en espera demasiado largo.</td></tr><tr><td>C1</td><td>No existe el expediente en la base.</td></tr><tr><td>C2</td><td>El expediente encontrado solo tiene datos demográficos o tiene cuentas inactivas en los últimos 24 meses.</td></tr><tr><td>C3</td><td>El titular del expediente encontrado está marcado como fallecido.</td></tr><tr><td>C4</td><td>El expediente encontrado no tiene cuentas activas en los últimos 24 meses.</td></tr><tr> <td>C5</td><td>El titular del expediente encontrado está marcado como fraudulento.</td></tr><tr><td>C6</td><td>Sin información suficiente para calcular el score</td></tr></tbody></table>'
  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'
    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: PRUEBA
        apellidoMaterno: CUATRO
        fechaNacimiento: '1980-01-04'
        RFC: PUCJ800104
        domicilio:
          direccion: INSURGENTES SUR 1004
          coloniaPoblacion: INSURGENTES
          ciudad: BENITO JUAREZ
          CP: '11230'
          delegacionMunicipio: BENITO JUAREZ
          estado: DF
  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.'
    example:
      nombres: 'JUAN'
      apellidoPaterno: 'PRUEBA'
      apellidoMaterno: 'CUATRO'
      fechaNacimiento: '1980-01-04'
      domicilio:
        direccion: "san joaquin"
        coloniaPoblacion: "el arenal"
        ciudad: "mexico"
        estado: "cdmx"
        pais: "MEX"
        delegacionMunicipio: "iztapalapa"
        cp: "12345"
  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'