swagger: '2.0'
info:
  title: 'FINTECH SCORE'
  description: "<p>La API FinTech Score es una herramienta con la que ordenas una población de solicitantes por su nivel de riesgo cubriendo las necesidades de las FinTechs como los son: plazos más cortos que van de 1 día hasta 3 meses en promedio, montos de $3.5K promedio, renovaciones con mayor frecuencia, mayores tasas de interés y disponibilidad inmediata.<br><br><img src='https://developer.circulodecredito.com.mx/sites/default/files/2020-10/circulo_de_credito-apihub.png'  width='240'/></p><br/>"
  version: 1.1.0
  termsOfService: 'https://developer.circulodecredito.com.mx/legal'
  contact:
    email: 'api@circulodecredito.com.mx'
  license:
    name: 'Derechos reservados Circulo de Crédito 2021'
    url: 'https://developer.circulodecredito.com.mx/aviso-de-privacidad'
host: 'services.circulodecredito.com.mx'
basePath: '/sandbox'
tags:
  - name: 'FINTECH SCORE'
    description: ''
    externalDocs:
      description: 'Portal de desarrolladores'
      url: 'https://developer.circulodecredito.com.mx/productos/nuestras-apis'
schemes:
  - 'https'
paths:
  '/v1/fintechscore':
    post:
      tags:
        - 'FINTECH SCORE'
      operationId: 'getReporte'
      consumes:
        - 'application/json'
      produces:
        - 'application/json'
      parameters:
        - in: 'header'
          name: 'x-api-key'
          required: true
          type: 'string'
          description: 'ConsumerKey obtenido desde el portal de desarrolladores'
        - 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'
  '/v1/fintechscore/folio':
    post:
      tags:
        - 'FINTECH SCORE'
      operationId: 'getReporteFolio'
      consumes:
        - 'application/json'
      produces:
        - 'application/json'
      parameters:
        - in: 'header'
          name: 'x-api-key'
          required: true
          type: 'string'
          description: 'ConsumerKey obtenido desde el portal de desarrolladores'
       
        - in: 'body'
          name: 'body'
          description: ''
          required: true
          schema:
            $ref: '#/definitions/PeticionFolio'
      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.'
       
        '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:
  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: 'CDMX'
    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.<table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>E0</td><td>No Hit</td><tr><td>E1</td><td>Cuentas desactualizadas por más de 24 mesess</td><tr><td>E2</td><td>Fecha de defunción antecede a la fecha de cálculo</td></tbody></table>'
    enum:
      - 'E0'
      - 'E1'
      - 'E2'
  CatalogoPais:
    type: 'string'
    description: 'Pais en el que se ubica el domicilio <table> <thead> <tr> <th>País</th> <th>Clave</th> </tr> </thead> <tbody> <tr> <td> Croacia</td> <td>HX</td> </tr> <tr> <td> México</td> <td>MX</td> </tr> <tr> <td> África Del Sur</td> <td>ZA</td> </tr> <tr> <td> Albania</td> <td>AN</td> </tr> <tr> <td> Alemania</td> <td>DW</td> </tr> <tr> <td> Andorra</td> <td>AD</td> </tr> <tr> <td> Angola</td> <td>AO</td> </tr> <tr> <td> Anguila</td> <td>AI</td> </tr> <tr> <td> Antigua Y Barbado</td> <td>AG</td> </tr> <tr> <td> Antillas Holandesas</td> <td>NN</td> </tr> <tr> <td> Arabia Saudita</td> <td>SA</td> </tr> <tr> <td> Argelia</td> <td>DZ</td> </tr> <tr> <td> Argentina</td> <td>AT</td> </tr> <tr> <td> Arabia</td> <td>AW</td> </tr> <tr> <td> Ascensión</td> <td>AS</td> </tr> <tr> <td> Australia</td> <td>AU</td> </tr> <tr> <td> Austria</td> <td>DF</td> </tr> <tr> <td> Azores</td> <td>AX</td> </tr> <tr> <td> Bahamas</td> <td>BS</td> </tr> <tr> <td> Baréin</td> <td>BH</td> </tr> <tr> <td> Bangladés</td> <td>BD</td> </tr> <tr> <td> Barbados</td> <td>BB</td> </tr> <tr> <td> Bélgica</td> <td>BE</td> </tr> <tr> <td> Belice</td> <td>BZ</td> </tr> <tr> <td> Benín</td> <td>BJ</td> </tr> <tr> <td> Bermudas</td> <td>BU</td> </tr> <tr> <td> Birmania</td> <td>BK</td> </tr> <tr> <td> Bolivia</td> <td>BO</td> </tr> <tr> <td> Bosnia Herzegovina</td> <td>BX</td> </tr> <tr> <td> Botswana</td> <td>BW</td> </tr> <tr> <td> Brasil</td> <td>BR</td> </tr> <tr> <td> Brunéi</td> <td>BN</td> </tr> <tr> <td> Bulgaria</td> <td>BG</td> </tr> <tr> <td> Burkina</td> <td>BF</td> </tr> <tr> <td> Burundi</td> <td>BI</td> </tr> <tr> <td> Bután</td> <td>BM</td> </tr> <tr> <td> Cabo Verde</td> <td>CV</td> </tr> <tr> <td> Camerún</td> <td>CM</td> </tr> <tr> <td> Canadá</td> <td>CN</td> </tr> <tr> <td> Cariacou</td> <td>CU</td> </tr> <tr> <td> Chad</td> <td>CD</td> </tr> <tr> <td> Chile</td> <td>CL</td> </tr> <tr> <td> China (pekin)</td> <td>CP</td> </tr> <tr> <td> Chipre</td> <td>CY</td> </tr> <tr> <td> Ciudad Del Vaticano</td> <td>VC</td> </tr> <tr> <td> Colombia</td> <td>CB</td> </tr> <tr> <td> Comoros</td> <td>CJ</td> </tr> <tr> <td> Congo</td> <td>CG</td> </tr> <tr> <td> Corcega</td> <td>CC</td> </tr> <tr> <td> Corea Del Norte</td> <td>KX</td> </tr> <tr> <td> Corea Del Sur</td> <td>KR</td> </tr> <tr> <td> Costa De Marfil</td> <td>IC</td> </tr> <tr> <td> Cuba</td> <td>HR</td> </tr> <tr> <td> Dinamarca</td> <td>DK</td> </tr> <tr> <td> Djibouti</td> <td>DJ</td> </tr> <tr> <td> Dominicana</td> <td>DM</td> </tr> <tr> <td> Ecuador</td> <td>EC</td> </tr> <tr> <td> Egipto</td> <td>EG</td> </tr> <tr> <td> El Salvador</td> <td>SV</td> </tr> <tr> <td> Emiratos Arabes Unidos</td> <td>UM</td> </tr> <tr> <td> España</td> <td>ES</td> </tr> <tr> <td> Estados Unidos</td> <td>US</td> </tr> <tr> <td> Eslovenia</td> <td>XN</td> </tr> <tr> <td> Estonia</td> <td>SU</td> </tr> <tr> <td> Etiopia</td> <td>ET</td> </tr> <tr> <td> Fiji</td> <td>FJ</td> </tr> <tr> <td> Filipinas</td> <td>PH</td> </tr> <tr> <td> Finlandia</td> <td>FI</td> </tr> <tr> <td> Francia</td> <td>FR</td> </tr> <tr> <td> Gabón</td> <td>GB</td> </tr> <tr> <td> Gales / Isla Futura</td> <td>WT</td> </tr> <tr> <td> Gambia</td> <td>GM</td> </tr> <tr> <td> Ghana</td> <td>GH</td> </tr> <tr> <td> Gibraltar</td> <td>GI</td> </tr> <tr> <td> Granada</td> <td>GD</td> </tr> <tr> <td> Grecia</td> <td>GR</td> </tr> <tr> <td> Groenlandia</td> <td>GE</td> </tr> <tr> <td> Guadalupe</td> <td>GP</td> </tr> <tr> <td> Guatemala</td> <td>GT</td> </tr> <tr> <td> Guyana</td> <td>GY</td> </tr> <tr> <td> Guayana Francesa</td> <td>GF</td> </tr> <tr> <td> Guinea</td> <td>GN</td> </tr> <tr> <td> Guinea Bissau</td> <td>GW</td> </tr> <tr> <td> Guinea Ecuatorial</td> <td>GQ</td> </tr> <tr> <td> Haití</td> <td>HA</td> </tr> <tr> <td> Holanda</td> <td>NL</td> </tr> <tr> <td> Honduras</td> <td>HN</td> </tr> <tr> <td> Hong Kong</td> <td>HK</td> </tr> <tr> <td> Hungría</td> <td>HU</td> </tr> <tr> <td> India</td> <td>IB</td> </tr> <tr> <td> Indonesia</td> <td>IF</td> </tr> <tr> <td> Irán</td> <td>IR</td> </tr> <tr> <td> Irak</td> <td>IQ</td> </tr> <tr> <td> Irlanda</td> <td>IE</td> </tr> <tr> <td> Islandia</td> <td>IS</td> </tr> <tr> <td> Islas Caimán</td> <td>CI</td> </tr> <tr> <td> Islas De Sotavento</td> <td>LE</td> </tr> <tr> <td> Islas Falkland (malvinas)</td> <td>FA</td> </tr> <tr> <td> Islas Faroe</td> <td>FE</td> </tr> <tr> <td> Islas Pitcairn</td> <td>PS</td> </tr> <tr> <td> Islas Reunión</td> <td>RE</td> </tr> <tr> <td> Islas Santa Cruz</td> <td>ST</td> </tr> <tr> <td> Islas Salmón</td> <td>SI</td> </tr> <tr> <td> Islas Virgenes Inglesas</td> <td>VG</td> </tr> <tr> <td> Israel</td> <td>IG</td> </tr> <tr> <td> Italia</td> <td>IT</td> </tr> <tr> <td> Jamaica</td> <td>JM</td> </tr> <tr> <td> Japón</td> <td>JP</td> </tr> <tr> <td> Jordania</td> <td>JO</td> </tr> <tr> <td> Kampuchea</td> <td>KA</td> </tr> <tr> <td> Katar</td> <td>OA</td> </tr> <tr> <td> Kenya</td> <td>KE</td> </tr> <tr> <td> Kiribati</td> <td>KI</td> </tr> <tr> <td> Kuwait</td> <td>KW</td> </tr> <tr> <td> Laos</td> <td>LO</td> </tr> <tr> <td> Lesotho</td> <td>LS</td> </tr> <tr> <td> Letonia</td> <td>LX</td> </tr> <tr> <td> Libano</td> <td>LB</td> </tr> <tr> <td> Liberia</td> <td>LR</td> </tr> <tr> <td> Libia</td> <td>LV</td> </tr> <tr> <td> Liechtenstein</td> <td>CH</td> </tr> <tr> <td> Lituania</td> <td>LT</td> </tr> <tr> <td> Luxemburgo</td> <td>LU</td> </tr> <tr> <td> Macao</td> <td>MJ</td> </tr> <tr> <td> Macedonia</td> <td>MH</td> </tr> <tr> <td> Madagascar</td> <td>MG</td> </tr> <tr> <td> Madeira</td> <td>MD</td> </tr> <tr> <td> Malasia</td> <td>MY</td> </tr> <tr> <td> Malawi</td> <td>MW</td> </tr> <tr> <td> Maldivias</td> <td>MV</td> </tr> <tr> <td> Mali</td> <td>ML</td> </tr> <tr> <td> Malta</td> <td>MT</td> </tr> <tr> <td> Marruecos</td> <td>RC</td> </tr> <tr> <td> Martinico</td> <td>MQ</td> </tr> <tr> <td> Mauricio</td> <td>MU</td> </tr> <tr> <td> Mauritania</td> <td>MR</td> </tr> <tr> <td> Afganistán</td> <td>AF</td> </tr> <tr> <td> Mongolia</td> <td>MC</td> </tr> <tr> <td> Montenegro</td> <td>MM</td> </tr> <tr> <td> Montserrat</td> <td>MK</td> </tr> <tr> <td> Mozambique</td> <td>MZ</td> </tr> <tr> <td> Nauru</td> <td>NA</td> </tr> <tr> <td> Nepal</td> <td>NP</td> </tr> <tr> <td> Nicaragua</td> <td>NI</td> </tr> <tr> <td> Nigeria</td> <td>NR</td> </tr> <tr> <td> Noruega</td> <td>NO</td> </tr> <tr> <td> Nueva Caledonia</td> <td>NW</td> </tr> <tr> <td> Nueva Zelanda</td> <td>NZ</td> </tr> <tr> <td> Oman</td> <td>OM</td> </tr> <tr> <td> Pakistan</td> <td>PK</td> </tr> <tr> <td> Panamá</td> <td>PM</td> </tr> <tr> <td> Papua Nueva Guinea</td> <td>PG</td> </tr> <tr> <td> Paraguay</td> <td>PY</td> </tr> <tr> <td> Perú</td> <td>PU</td> </tr> <tr> <td> Polonia</td> <td>PL</td> </tr> <tr> <td> Polinesia</td> <td>FP</td> </tr> <tr> <td> Portugal</td> <td>PT</td> </tr> <tr> <td> Reino Unido</td> <td>UK</td> </tr> <tr> <td> Rep. Central Africana</td> <td>CF</td> </tr> <tr> <td> República Checa Eslovaca</td> <td>CS</td> </tr> <tr> <td> República De Georgia</td> <td>GX</td> </tr> <tr> <td> República Dominicana</td> <td>DO</td> </tr> <tr> <td> Rumanía</td> <td>RO</td> </tr> <tr> <td> Rusia</td> <td>RU</td> </tr> <tr> <td> Rwanda</td> <td>RW</td> </tr> <tr> <td> Samoa Oeste</td> <td>WS</td> </tr> <tr> <td> San Cristóbal De Nevais</td> <td>KN</td> </tr> <tr> <td> San Kitts</td> <td>SS</td> </tr> <tr> <td> San Pierre Y Miquelon</td> <td>SP</td> </tr> <tr> <td> San Vincent Y Las Granadas</td> <td>SF</td> </tr> <tr> <td> Santa Helena</td> <td>SH</td> </tr> <tr> <td> Santa Lucia</td> <td>LC</td> </tr> <tr> <td> Sao Tome Y Principado</td> <td>MP</td> </tr> <tr> <td> Senegal</td> <td>SN</td> </tr> <tr> <td> Serbia</td> <td>SX</td> </tr> <tr> <td> Siria</td> <td>SY</td> </tr> <tr> <td> Somalia</td> <td>SO</td> </tr> <tr> <td> Sri Lanka</td> <td>LK</td> </tr> <tr> <td> Sudan</td> <td>SB</td> </tr> <tr> <td> Suecia</td> <td>SE</td> </tr> <tr> <td> Suiza</td> <td>SW</td> </tr> <tr> <td> Surinam</td> <td>SR</td> </tr> <tr> <td> Swazilandia</td> <td>SZ</td> </tr> <tr> <td> Tailandia</td> <td>TH</td> </tr> <tr> <td> Taiwan</td> <td>TW</td> </tr> <tr> <td> Tanzania</td> <td>TZ</td> </tr> <tr> <td> Timor Oriental</td> <td>EM</td> </tr> <tr> <td> Togo</td> <td>TG</td> </tr> <tr> <td> Tonga</td> <td>TA</td> </tr> <tr> <td> Trinidad Y Tobago</td> <td>TT</td> </tr> <tr> <td> Tristan De Cunha</td> <td>TD</td> </tr> <tr> <td> Tunez</td> <td>TU</td> </tr> <tr> <td> Turcos Y Islas Caicos</td> <td>TC</td> </tr> <tr> <td> Turquia </td> <td>TR</td> </tr> <tr> <td> Tuvala</td> <td>TV</td> </tr> <tr> <td> Uganda</td> <td>UG</td> </tr> <tr> <td> Ucrania</td> <td>UA</td> </tr> <tr> <td> Uruguay</td> <td>UY</td> </tr> <tr> <td> Vanuatu</td> <td>VU</td> </tr> <tr> <td> Venezuela</td> <td>VE</td> </tr> <tr> <td> Vietnam</td> <td>VN</td> </tr> <tr> <td> Yemen (del Norte)</td> <td>YS</td> </tr> <tr> <td> Yemen (del Sur)</td> <td>YE</td> </tr> <tr> <td> Zaire</td> <td>ZR</td> </tr> <tr> <td> Zambia</td> <td>ZM</td> </tr> <tr> <td> Zimbabwe</td> <td>ZW</td> </tr> <tr> <td> No Definido</td> <td>ND</td> </tr> </tbody> </table>'
    minLength: 2
    maxLength: 2
    example: 'MX'
    enum:
    - 'AD'
    - 'AF'
    - 'AG'
    - 'AI'
    - 'AN'
    - 'AO'
    - 'AS'
    - 'AT'
    - 'AU'
    - 'AW'
    - 'AX'
    - 'BB'
    - 'BD'
    - 'BE'
    - 'BF'
    - 'BG'
    - 'BH'
    - 'BI'
    - 'BJ'
    - 'BK'
    - 'BM'
    - 'BN'
    - 'BO'
    - 'BR'
    - 'BS'
    - 'BU'
    - 'BW'
    - 'BX'
    - 'BZ'
    - 'CB'
    - 'CC'
    - 'CD'
    - 'CF'
    - 'CG'
    - 'CH'
    - 'CI'
    - 'CJ'
    - 'CL'
    - 'CM'
    - 'CN'
    - 'CP'
    - 'CS'
    - 'CU'
    - 'CV'
    - 'CY'
    - 'DF'
    - 'DJ'
    - 'DK'
    - 'DM'
    - 'DO'
    - 'DW'
    - 'DZ'
    - 'EC'
    - 'EG'
    - 'EM'
    - 'ES'
    - 'ET'
    - 'FA'
    - 'FE'
    - 'FI'
    - 'FJ'
    - 'FP'
    - 'FR'
    - 'GB'
    - 'GD'
    - 'GE'
    - 'GF'
    - 'GH'
    - 'GI'
    - 'GM'
    - 'GN'
    - 'GP'
    - 'GQ'
    - 'GR'
    - 'GT'
    - 'GW'
    - 'GX'
    - 'GY'
    - 'HA'
    - 'HK'
    - 'HN'
    - 'HR'
    - 'HU'
    - 'HX'
    - 'IB'
    - 'IC'
    - 'IE'
    - 'IF'
    - 'IG'
    - 'IQ'
    - 'IR'
    - 'IS'
    - 'IT'
    - 'JM'
    - 'JO'
    - 'JP'
    - 'KA'
    - 'KE'
    - 'KI'
    - 'KN'
    - 'KR'
    - 'KW'
    - 'KX'
    - 'LB'
    - 'LC'
    - 'LE'
    - 'LK'
    - 'LO'
    - 'LR'
    - 'LS'
    - 'LT'
    - 'LU'
    - 'LV'
    - 'LX'
    - 'MC'
    - 'MD'
    - 'MG'
    - 'MH'
    - 'MJ'
    - 'MK'
    - 'ML'
    - 'MM'
    - 'MP'
    - 'MQ'
    - 'MR'
    - 'MT'
    - 'MU'
    - 'MV'
    - 'MW'
    - 'MX'
    - 'MY'
    - 'MZ'
    - 'NA'
    - 'ND'
    - 'NI'
    - 'NL'
    - 'NN'
    - 'NO'
    - 'NP'
    - 'NR'
    - 'NW'
    - 'NZ'
    - 'OA'
    - 'OM'
    - 'PG'
    - 'PH'
    - 'PK'
    - 'PL'
    - 'PM'
    - 'PS'
    - 'PT'
    - 'PU'
    - 'PY'
    - 'RC'
    - 'RE'
    - 'RO'
    - 'RU'
    - 'RW'
    - 'SA'
    - 'SB'
    - 'SE'
    - 'SF'
    - 'SH'
    - 'SI'
    - 'SN'
    - 'SO'
    - 'SP'
    - 'SR'
    - 'SS'
    - 'ST'
    - 'SU'
    - 'SV'
    - 'SW'
    - 'SX'
    - 'SY'
    - 'SZ'
    - 'TA'
    - 'TC'
    - 'TD'
    - 'TG'
    - 'TH'
    - 'TR'
    - 'TT'
    - 'TU'
    - 'TV'
    - 'TW'
    - 'TZ'
    - 'UA'
    - 'UG'
    - 'UK'
    - 'UM'
    - 'US'
    - 'UY'
    - 'VC'
    - 'VE'
    - 'VG'
    - 'VN'
    - 'VU'
    - 'WS'
    - 'WT'
    - 'XN'
    - 'YE'
    - 'YS'
    - 'ZA'
    - 'ZM'
    - 'ZR'
    - 'ZW'
  Domicilio:
    type: 'object'
    description: 'Datos del domicilio de la persona a consultar'
    required:
      - 'direccion'
      - 'CP'
      - 'estado'
      - 'pais'
    properties:
      direccion:
        type: 'string'
        description: 'Domicilio de la persona incluyendo nombre de la calle, número exterior y/o interior. Deben considerarse avenida, cerrada, manzana, lote, edificio, departamento, entre otros.'
        maxLength: 85
        example: 'INGENIEROS MILITARES NO. 65'
      coloniaPoblacion:
        type: 'string'
        description: 'Colónia o población a la cual pertenece el domicilio de la persona.'
        maxLength: 65
        example: 'LOMAS DE SOTELO'
      delegacionMunicipio:
        type: 'string'
        description: 'Delegación o municipio a la cual pertenece el domicilio de la persona.'
        maxLength: 65
        example: 'MIGUEL HIDALGO'
      ciudad:
        type: 'string'
        description: 'Ciudad a la cual pertenece el domicilio de la persona.'
        maxLength: 65
        example: 'CIUDAD DE MEXICO'
      estado:
        $ref: '#/definitions/CatalogoEstados'
      CP:
        type: 'string'
        description: 'Código postal debe estar compuesto por 5 dígitos; para que éste sea válido deberá corresponder al rango que se maneja dentro del Estado donde pertenece el domicilio de la persona. En caso de una longitud de 4 dígitos deberá completar con un cero a la izquierda (Ejemplo 08564).'
        maxLength: 5
        example: '11200'
      pais:
        $ref: '#/definitions/CatalogoPais'
  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:
      - 'folioOtorgante'
      - 'persona'
    properties:
      folioOtorgante:
        type: 'string'
        description: 'Folio interno del otorgante, número único generado por el otorgante para su seguimiento'
        example: '20210304'
      persona:
        $ref: '#/definitions/Persona'
    description: 'Datos generales de la persona a consultar.'
  PeticionFolio:
    type: 'object'
    required:
      - 'folioOtorgante'
      - 'folioConsulta'
    properties:
      folioOtorgante:
        type: 'string'
        description: 'Folio interno del otorgante, número único generado por el otorgante para su seguimiento'
        example: '20210304'
      folioConsulta:
        type: 'string'
        description: 'Folio interno de Consulta, número único generado por la consulta para su seguimiento'
        example: '20210304'
  Persona:
    type: 'object'
    required:
      - 'primerNombre'
      - 'apellidoPaterno'
      - 'fechaNacimiento'
      - 'domicilio'
    properties:
      apellidoPaterno:
        type: 'string'
        description: 'Apellido Paterno del cliente. No usar abreviaturas, iniciales y/o puntos.'
        maxLength: 30
        example: 'PRUEBA'
      apellidoMaterno:
        type: 'string'
        description: 'Apellido Materno del cliente. No usar abreviaturas, iniciales y/o puntos.'
        maxLength: 30
        example: 'RUIZ'
      primerNombre:
        type: 'string'
        description: 'Primer nombre del cliente. No usar abreviaturas, iniciales y/o puntos.'
        maxLength: 50
        example: 'JUAN'
      segundoNombre:
        type: 'string'
        description: 'Segundo nombre del cliente. No usar abreviaturas, iniciales y/o puntos.'
        maxLength: 50
        example: 'PABLO'        
      fechaNacimiento:
        type: 'string'
        description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)'
        format: 'yyyy-MM-dd'
        example: '1974-10-28'
      RFC:
        type: 'string'
        description: 'RFC con homoclave de la persona'
        example: 'PURJ741028PL2'
      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'
      folioOtorgante:
        type: 'string'
        description: 'Folio de la consulta con relación al otorgante'
        example: '20210304'
      score:
        $ref: '#/definitions/Score'
  Score:
    type: 'object'
    description: 'Contiene los elementos Score.'
    properties:
      valor:
        type: 'integer'
        format: 'int32'
        description: 'Valor numerico de Score'
        minimum: 0
        maximum: 999
        example: 0
      razon:
        $ref: '#/definitions/CatalogoRazones'        

