swagger: '2.0'
info:
  title: 'Loan Amount Estimator'
  version: '1.0.0'
  description: "<p>Predice el desempeño crediticio futuro para una cuenta específica aprobada previamente. Contiene un conjunto de Scores para cada cuenta representados por un puntaje numérico en un rango definido.<br><br><img src='https://developer.circulodecredito.com.mx/sites/default/files/2020-10/circulo_de_credito-apihub.png' width='240'/></p><br/>"
  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: 'Loan Amount Estimator'
schemes:
- 'https'
paths:
  '/v1/lae/persona':
    post:
      tags:
      - 'Loan Amount Estimator'
      summary: 'Consulta por datos generales de la persona'
      operationId: 'getLAEByPerson'
      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: 'header'
          name: 'x-signature'
          required: true
          type: 'string'
          description: 'Firma generada con la llave privada'
        - in: 'header'
          name: 'username'
          required: true
          type: 'string'
          description: 'Usuario de Círculo de Crédito'
        - name: 'password'
          in: 'header'
          required: true
          type: 'string'
          description: 'Contraseña de Círculo de Crédito'
        - in: 'body'
          name: 'request'
          schema:
            $ref: '#/definitions/PeticionPersona'
      responses:
        '200':
          description: 'OK'
          schema:
            $ref: '#/definitions/Respuesta'
        '204':
          description: 'NO CONTENT'
        '400':
          description: 'BAD REQUEST'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                  codigo: '400.1'
                  mensaje: 'El campo "primerNombre" no puede estar vacío.'
        '401':
          description: 'UNAUTHORIZED'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '401.1'
                  mensaje: 'Acceso no autorizado, x-api-key no válida.'
                - codigo: '401.2'
                  mensaje: 'Acceso no autorizado.'
                - codigo: '401.4'
                  mensaje: 'Acceso no autorizado, no tiene el producto asociado.'
                - codigo: '401.5'
                  mensaje: 'Acceso no autorizado, no tiene acceso al recurso.'
        '403':
          description: 'FORBIDDEN'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '403.1'
                  mensaje: 'No se pudo autenticar, x-signature no es válida.'
        '404':
          description: 'NOT FOUND'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '404.1'
                  mensaje: 'No se encontró a la persona.'
        '429':
          description: 'TOO MANY REQUESTS'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '429.1'
                  mensaje: 'Se han enviado demasiadas solicitudes. Se debe esperar antes de realizar una nueva solicitud.'
        '500':
          description: 'INTERNAL SERVER ERROR'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '500.1'
                  mensaje: 'Ocurrio un problema, inténtelo nuevamente más tarde.'
        '503':
          description: 'SERVICE UNAVAILABLE'
  '/v1/lae/folioConsulta':
    post:
      tags:
      - 'Loan Amount Estimator'
      summary: 'Consulta por folioConsulta'
      operationId: 'getLAEByFolioConsulta'
      parameters:
        - in: 'header'
          name: 'x-api-key'
          required: true
          type: 'string'
          description: 'ConsumerKey obtenido desde el portal de desarrolladores'
        - in: 'header'
          name: 'x-signature'
          required: true
          type: 'string'
          description: 'Firma generada con la llave privada'
        - in: 'header'
          name: 'username'
          required: true
          type: 'string'
          description: 'Usuario de Círculo de Crédito'
        - name: 'password'
          in: 'header'
          required: true
          type: 'string'
          description: 'Contraseña de Círculo de Crédito'
        - in: 'body'
          name: 'request'
          schema:
            $ref: '#/definitions/PeticionFolioConsulta'
      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 "folioConsulta" 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ó el folioConsulta.'
        '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>'
    maxLength: 1
    enum:
      - 'D'
      - 'L'
      - 'C'
      - 'S'
      - 'V'
      - 'E'
  CatalogoTipoAsentamiento:
    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'
  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>'
    minLength: 0
    maxLength: 4
    example: 'JAL'
    enum:
      - 'AGS'
      - 'BC'
      - 'BCS'
      - 'CAMP'
      - 'COAH'
      - 'COL'
      - 'CHIS'
      - 'CHIH'
      - 'DF'
      - 'CDMX'
      - 'DGO'
      - 'GTO'
      - 'GRO'
      - 'HGO'
      - 'JAL'
      - 'MEX'
      - 'MICH'
      - 'MOR'
      - 'NAY'
      - 'NL'
      - 'OAX'
      - 'PUE'
      - 'QRO'
      - 'QROO'
      - 'SLP'
      - 'SIN'
      - 'SON'
      - 'TAB'
      - 'TAMP'
      - 'TLAX'
      - 'VER'
      - 'YUC'
      - 'ZAC'
  CatalogoNacionalidad:
    type: 'string'
    description: '<p>Debe contener la clave de la nacionalidad del consumidor los valores posibles son los siguientes:</p><p><table><thead><tr><th>Clave</th><th>Nacionalidad</th><th>País</th></tr></thead><tbody><tr><td>AD</td><td>Andorra</td><td>Andorra</td></tr><tr><td>AF</td><td>Afgana</td><td>Afganistán</td></tr><tr><td>AG</td><td>Antigua y Barbado</td><td>Antigua y Barbado</td></tr><tr><td>AI</td><td>Anguila</td><td>Anguila</td></tr><tr><td>AN</td><td>Albania</td><td>Albania</td></tr><tr><td>AO</td><td>Angola</td><td>Angola</td></tr><tr><td>AS</td><td>Ascensión</td><td>Ascensión</td></tr><tr><td>AT</td><td>Argentina</td><td>Argentina</td></tr><tr><td>AU</td><td>Australiana</td><td>Australia</td></tr><tr><td>AW</td><td>Árabe</td><td>Arabia</td></tr><tr><td>AX</td><td>Azores</td><td>Azores</td></tr><tr><td>BB</td><td>Barbados</td><td>Barbados</td></tr><tr><td>BD</td><td>Bangladesh</td><td>Bangladesh</td></tr><tr><td>BE</td><td>Belga</td><td>Bélgica</td></tr><tr><td>BF</td><td>Burkina</td><td>Burkina</td></tr><tr><td>BG</td><td>Búlgara</td><td>Bulgaria</td></tr><tr><td>BH</td><td>Bahrein</td><td>Bahrein</td></tr><tr><td>BI</td><td>Burundi</td><td>Burundi</td></tr><tr><td>BJ</td><td>Benin</td><td>Benin</td></tr><tr><td>BK</td><td>Birmania</td><td>Birmania</td></tr><tr><td>BM</td><td>Bután</td><td>Bután</td></tr><tr><td>BN</td><td>Brunei</td><td>Brunei</td></tr><tr><td>BO</td><td>Boliviana</td><td>Bolivia</td></tr><tr><td>BR</td><td>Brasileño</td><td>Brasil</td></tr><tr><td>BS</td><td>Bahamas</td><td>Bahamas</td></tr><tr><td>BU</td><td>Bermudas</td><td>Bermudas</td></tr><tr><td>BW</td><td>Botswana</td><td>Botswana</td></tr><tr><td>BX</td><td>Bosnia Herzegovina</td><td>Bosnia Herzegovina</td></tr><tr><td>BZ</td><td>Belice</td><td>Belice</td></tr><tr><td>CB</td><td>Colombiana</td><td>Colombia</td></tr><tr><td>CC</td><td>Córcega</td><td>Córcega</td></tr><tr><td>CD</td><td>Chad</td><td>Chad</td></tr><tr><td>CF</td><td>Rep. Central Africana</td><td>Rep. Central Africana</td></tr><tr><td>CG</td><td>Congo</td><td>Congo</td></tr><tr><td>CH</td><td>Liechtenstein</td><td>Liechtenstein</td></tr><tr><td>CI</td><td>Islas Caimán</td><td>Islas Caimán</td></tr><tr><td>CJ</td><td>Comoros</td><td>Comoros</td></tr><tr><td>CL</td><td>Chilena</td><td>Chile</td></tr><tr><td>CM</td><td>Camerunés</td><td>Camerún</td></tr><tr><td>CN</td><td>Canadiense</td><td>Canadá</td></tr><tr><td>CP</td><td>China</td><td>China (Pekín)</td></tr><tr><td>CS</td><td>República Checa Eslovaca</td><td>República Checa Eslovaca</td></tr><tr><td>CU</td><td>Cariacou</td><td>Cariacou</td></tr><tr><td>CV</td><td>Cabo Verde</td><td>Cabo Verde</td></tr><tr><td>CY</td><td>Chipre</td><td>Chipre</td></tr><tr><td>DF</td><td>Austriaca</td><td>Austria</td></tr><tr><td>DJ</td><td>Djibouti</td><td>Djibouti</td></tr><tr><td>DK</td><td>Danés</td><td>Dinamarca</td></tr><tr><td>DM</td><td>Dominicana</td><td>Dominicana</td></tr><tr><td>DO</td><td>Dominicana</td><td>República Dominicana</td></tr><tr><td>DW</td><td>Alemana</td><td>Alemania</td></tr><tr><td>DZ</td><td>Argelia</td><td>Argelia</td></tr><tr><td>EC</td><td>Ecuatoriana</td><td>Ecuador</td></tr><tr><td>EG</td><td>Egipcia</td><td>Egipto</td></tr><tr><td>EM</td><td>Timor Oriental</td><td>Timor Oriental</td></tr><tr><td>ES</td><td>Española</td><td>España</td></tr><tr><td>ET</td><td>Etiopia</td><td>Etiopia</td></tr><tr><td>FA</td><td>Islas Falkland (Malvinas)</td><td>Islas Falkland (Malvinas)</td></tr><tr><td>FE</td><td>Islas Faroe</td><td>Islas Faroe</td></tr><tr><td>FI</td><td>Finlandia</td><td>Finlandia</td></tr><tr><td>FJ</td><td>Fiji</td><td>Fiji</td></tr><tr><td>FP</td><td>Polinesia</td><td>Polinesia</td></tr><tr><td>FR</td><td>Francesa</td><td>Francia</td></tr><tr><td>GB</td><td>Gabón</td><td>Gabón</td></tr><tr><td>GD</td><td>Granada</td><td>Granada</td></tr><tr><td>GE</td><td>Groenlandia</td><td>Groenlandia</td></tr><tr><td>GF</td><td>Guayana Francesa</td><td>Guayana Francesa</td></tr><tr><td>GH</td><td>Ghana</td><td>Ghana</td></tr><tr><td>GI</td><td>Gibraltar</td><td>Gibraltar</td></tr><tr><td>GM</td><td>Gambia</td><td>Gambia</td></tr><tr><td>GN</td><td>Guinea</td><td>Guinea</td></tr><tr><td>GP</td><td>Guadalupe</td><td>Guadalupe</td></tr><tr><td>GQ</td><td>Guinea Ecuatorial</td><td>Guinea Ecuatorial</td></tr><tr><td>GR</td><td>Griega</td><td>Grecia</td></tr><tr><td>GT</td><td>Guatemalteca</td><td>Guatemala</td></tr><tr><td>GW</td><td>Guinea Bissau</td><td>Guinea Bissau</td></tr><tr><td>GX</td><td>República De Georgia</td><td>República De Georgia</td></tr><tr><td>GY</td><td>Guyana</td><td>Guyana</td></tr><tr><td>HA</td><td>Haitiana</td><td>Haití</td></tr><tr><td>HK</td><td>Hong Kong</td><td>Hong Kong</td></tr><tr><td>HN</td><td>Hondureña</td><td>Honduras</td></tr><tr><td>HR</td><td>Cubano</td><td>Cuba</td></tr><tr><td>HU</td><td>Húngara</td><td>Húngara</td></tr><tr><td>HX</td><td>Croata</td><td>Croacia</td></tr><tr><td>IB</td><td>India</td><td>India</td></tr><tr><td>IC</td><td>Costa De Marfil</td><td>Costa De Marfil</td></tr><tr><td>IE</td><td>Irlandesa</td><td>Irlandesa</td></tr><tr><td>IF</td><td>Indonesia</td><td>Indonesia</td></tr><tr><td>IG</td><td>Israelí</td><td>Israelí</td></tr><tr><td>IQ</td><td>Iraquí</td><td>Iraquí</td></tr><tr><td>IR</td><td>Iraní</td><td>Iraní</td></tr><tr><td>IS</td><td>Islandia</td><td>Islandia</td></tr><tr><td>IT</td><td>Italiano</td><td>Italiano</td></tr><tr><td>JM</td><td>Jamaicano</td><td>Jamaicano</td></tr><tr><td>JO</td><td>Jordano</td><td>Jordano</td></tr><tr><td>JP</td><td>Japonesa</td><td>Japonesa</td></tr><tr><td>KA</td><td>Kampuchea</td><td>Kampuchea</td></tr><tr><td>KE</td><td>Kenya</td><td>Kenya</td></tr><tr><td>KI</td><td>Kiribati</td><td>Kiribati</td></tr><tr><td>KN</td><td>San Cristóbal De Neváis</td><td>San Cristóbal De Neváis</td></tr><tr><td>KR</td><td>Corea Del Sur</td><td>Corea Del Sur</td></tr><tr><td>KW</td><td>Kuwait</td><td>Kuwait</td></tr><tr><td>KX</td><td>Corea Del Norte</td><td>Corea Del Norte</td></tr><tr><td>LB</td><td>Libanes</td><td>Libanes</td></tr><tr><td>LC</td><td>Santa Lucia</td><td>Santa Lucia</td></tr><tr><td>LE</td><td>Islas De Sotavento</td><td>Islas De Sotavento</td></tr><tr><td>LK</td><td>Sri Lanka</td><td>Sri Lanka</td></tr><tr><td>LO</td><td>Laos</td><td>Laos</td></tr><tr><td>LR</td><td>Liberia</td><td>Liberia</td></tr><tr><td>LS</td><td>Lesotho</td><td>Lesotho</td></tr><tr><td>LT</td><td>Lituania</td><td>Lituania</td></tr><tr><td>LU</td><td>Luxemburgo</td><td>Luxemburgo</td></tr><tr><td>LV</td><td>Libia</td><td>Libia</td></tr><tr><td>LX</td><td>Letonia</td><td>Letonia</td></tr><tr><td>MC</td><td>Mongolia</td><td>Mongolia</td></tr><tr><td>MD</td><td>Madeira</td><td>Madeira</td></tr><tr><td>MG</td><td>Madagascar</td><td>Madagascar</td></tr><tr><td>MH</td><td>Macedonia</td><td>Macedonia</td></tr><tr><td>MJ</td><td>Macao</td><td>Macao</td></tr><tr><td>MK</td><td>Montserrat</td><td>Montserrat</td></tr><tr><td>ML</td><td>Mali</td><td>Mali</td></tr><tr><td>MM</td><td>Montenegro</td><td>Montenegro</td></tr><tr><td>MP</td><td>Sao Tome y Principado</td><td>Sao Tome y Principado</td></tr><tr><td>MQ</td><td>Martinico</td><td>Martinico</td></tr><tr><td>MR</td><td>Mauritania</td><td>Mauritania</td></tr><tr><td>MT</td><td>Malta</td><td>Malta</td></tr><tr><td>MU</td><td>Mauricio</td><td>Mauricio</td></tr><tr><td>MV</td><td>Maldivas</td><td>Maldivas</td></tr><tr><td>MW</td><td>Malawi</td><td>Malawi</td></tr><tr><td>MX</td><td>Mexicana</td><td>México</td></tr><tr><td>MY</td><td>Malasia</td><td>Malasia</td></tr><tr><td>MZ</td><td>Mozambique</td><td>Mozambique</td></tr><tr><td>NA</td><td>Nauru</td><td>Nauru</td></tr><tr><td>ND</td><td>No Definido</td><td>No Definido</td></tr><tr><td>NI</td><td>Nicaragua</td><td>Nicaragua</td></tr><tr><td>NL</td><td>Holandesa</td><td>Holanda</td></tr><tr><td>NN</td><td>Antillas Holandesas</td><td>Antillas Holandesas</td></tr><tr><td>NO</td><td>Noruega</td><td>Noruega</td></tr><tr><td>NP</td><td>Nepal</td><td>Nepal</td></tr><tr><td>NR</td><td>Nigeriano</td><td>Nigeria</td></tr><tr><td>NW</td><td>Nueva Caledonia</td><td>Nueva Caledonia</td></tr><tr><td>NZ</td><td>Nueva Zelandia</td><td>Nueva Zelandia</td></tr><tr><td>OA</td><td>Katar</td><td>Katar</td></tr><tr><td>OM</td><td>Omán</td><td>Omán</td></tr><tr><td>PG</td><td>Papúa Nueva Guinea</td><td>Papúa Nueva Guinea</td></tr><tr><td>PH</td><td>Filipinas</td><td>Filipinas</td></tr><tr><td>PK</td><td>Pakistán</td><td>Pakistán</td></tr><tr><td>PL</td><td>Polaco</td><td>Polonia</td></tr><tr><td>PM</td><td>Panameño</td><td>Panamá</td></tr><tr><td>PS</td><td>Islas Pitcairn</td><td>Islas Pitcairn</td></tr><tr><td>PT</td><td>Portugués</td><td>Portugal</td></tr><tr><td>PU</td><td>Peruana</td><td>Perú</td></tr><tr><td>PY</td><td>Paraguayo</td><td>Paraguay</td></tr><tr><td>RC</td><td>Marroquí</td><td>Marruecos</td></tr><tr><td>RE</td><td>Islas Reunión</td><td>Islas Reunión</td></tr><tr><td>RO</td><td>Rumana</td><td>Rumania</td></tr><tr><td>RU</td><td>Rusa</td><td>Rusia</td></tr><tr><td>RW</td><td>Ruanda</td><td>Ruanda</td></tr><tr><td>SA</td><td>Saudí Árabe</td><td>Arabia Saudita</td></tr><tr><td>SB</td><td>Sudan</td><td>Sudan</td></tr><tr><td>SE</td><td>Sueco</td><td>Suecia</td></tr><tr><td>SF</td><td>San Vencen y Las Granadas</td><td>San Vencen y Las Granadas</td></tr><tr><td>SH</td><td>Santa Helena</td><td>Santa Helena</td></tr><tr><td>SI</td><td>Islas Salmon</td><td>Islas Salmon</td></tr><tr><td>SN</td><td>Senegal</td><td>Senegal</td></tr><tr><td>SO</td><td>Somalia</td><td>Somalia</td></tr><tr><td>SP</td><td>San Pierre y Miquelón</td><td>San Pierre y Miquelón</td></tr><tr><td>SR</td><td>Surinam</td><td>Surinam</td></tr><tr><td>SS</td><td>San Kitts</td><td>San Kitts</td></tr><tr><td>ST</td><td>Islas Santa Cruz</td><td>Islas Santa Cruz</td></tr><tr><td>SU</td><td>Estonia</td><td>Estonia</td></tr><tr><td>SV</td><td>Salvadoreña</td><td>El Salvador</td></tr><tr><td>SW</td><td>Suiza</td><td>Suiza</td></tr><tr><td>SX</td><td>Serbia</td><td>Serbia</td></tr><tr><td>SY</td><td>Siria</td><td>Siria</td></tr><tr><td>SZ</td><td>Swazilandia</td><td>Swazilandia</td></tr><tr><td>TA</td><td>Tonga</td><td>Tonga</td></tr><tr><td>TC</td><td>Turcos e Islas Caicos</td><td>Turcos e Islas Caicos</td></tr><tr><td>TD</td><td>Tristán De Cunha</td><td>Tristán De Cunha</td></tr><tr><td>TG</td><td>Togo</td><td>Togo</td></tr><tr><td>TH</td><td>Tailandia</td><td>Tailandia</td></tr><tr><td>TR</td><td>Turca</td><td>Turquía </td></tr><tr><td>TT</td><td>Trinidad y Tobago</td><td>Trinidad y Tobago</td></tr><tr><td>TU</td><td>Túnez</td><td>Túnez</td></tr><tr><td>TV</td><td>Tuvala</td><td>Tuvala</td></tr><tr><td>TW</td><td>Taiwán</td><td>Taiwán</td></tr><tr><td>TZ</td><td>Tanzania</td><td>Tanzania</td></tr><tr><td>UA</td><td>Ucraniano</td><td>Ucrania</td></tr><tr><td>UG</td><td>Uganda</td><td>Uganda</td></tr><tr><td>UK</td><td>Reino Unido</td><td>Reino Unido</td></tr><tr><td>UM</td><td>Árabe</td><td>Emiratos Árabes Unidos</td></tr><tr><td>US</td><td>Estadounidense</td><td>Estados Unidos</td></tr><tr><td>UY</td><td>Uruguayo</td><td>Uruguay</td></tr><tr><td>VC</td><td>Ciudad Del Vaticano</td><td>Ciudad Del Vaticano</td></tr><tr><td>VE</td><td>Venezolana</td><td>Venezuela</td></tr><tr><td>VG</td><td>Islas Vírgenes Inglesas</td><td>Islas Vírgenes Inglesas</td></tr><tr><td>VN</td><td>Vietnami</td><td>Vietnam</td></tr><tr><td>VU</td><td>Vanuatu</td><td>Vanuatu</td></tr><tr><td>WS</td><td>Samoa Oeste</td><td>Samoa Oeste</td></tr><tr><td>WT</td><td>Gales / Isla Futura</td><td>Gales / Isla Futura</td></tr><tr><td>XN</td><td>Eslovenia</td><td>Eslovenia</td></tr><tr><td>YE</td><td>Yemen (Del Sur)</td><td>Yemen (Del Sur)</td></tr><tr><td>YS</td><td>Yemen (Del Norte)</td><td>Yemen (Del Norte)</td></tr><tr><td>ZA</td><td>Sudafricana</td><td>África Del Sur</td></tr><tr><td>ZM</td><td>Zambia</td><td>Zambia</td></tr><tr><td>ZR</td><td>Zaire</td><td>Zaire</td></tr><tr><td>ZW</td><td>Zimbabwe</td><td>Zimbabwe</td></tr></tbody></table></p'
    minLength: 2
    maxLength: 2
    example: 'MX'
  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: 0
    maximum: 1
    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>'
    maxLength: 1
    enum:
      - 'F'
      - 'M'
  CatalogoSegmento:
    type: 'string'
    description: '<table><thead><tr><th>Clave</th><th>Descripción</th></tr></thead><tbody><tr><td>PP</td><td>PRESTAMO PERSONAL</td></tr><tr><td>TC</td><td>TARJETA DE CREDITO</td></tr><tr><td>TD</td><td>TARJETA DEPARTAMENTAL</td></tr></tbody></table>'
    maxLength: 2
    enum:
      - 'PP'
      - 'TC'
      - 'TD'
  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>'
    maxLength: 1
    example: 'C'
    enum:
      - 'N'
      - 'O'
      - 'C'
      - 'P'
      - 'E'
  DomicilioPeticion:
    type: 'object'
    description: 'Datos del domicilio de la persona a consultar'
    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.'
        minLength: 5
        maxLength: 5
        example: '47917'
      fechaResidencia:
        type: 'string'
        description: 'Debe de reportarse la fecha desde cuando el consumidor vive en la  dirección reportada.'
        format: 'yyyy-MM-dd'
        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'
      pais:
        $ref: '#/definitions/CatalogoNacionalidad'
  Persona:
    type: 'object'
    description: 'Datos generales de la persona a consultar.'
    required:
      - 'apellidoPaterno'
      - 'apellidoMaterno'
      - 'primerNombre'
      - 'fechaNacimiento'
    properties:
      apellidoPaterno:
        type: 'string'
        description: 'Apellido paterno de la persona. Sin abreviaturas o iniciales'
        maxLength: 30
        example: 'SAHAGUN'
      apellidoMaterno:
        type: 'string'
        description: 'Apellido materno de la persona'
        maxLength: 30
        example: 'ZARAGOZA'
      apellidoAdicional:
        type: 'string'
        description: 'Apellido adicional de la persona, si tuviere'
        maxLength: 30
        example: "TORRES"
      primerNombre:
        type: 'string'
        description: 'Primer nombre de la persona'
        maxLength: 50
        example: 'ROBERTO'
      segundoNombre:
        type: 'string'
        description: 'Segundo nombre de la persona'
        maxLength: 50
        example: "MIGUEL"      
      fechaNacimiento:
        type: 'string'
        description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)'
        format: 'yyyy-MM-dd'
        example: '2001-01-01'
      RFC:
        type: 'string'
        maxLength: 13
        description: 'RFC con homoclave de la persona'
        example: 'SAZR010101'
      CURP:
        type: 'string'
        maxLength: 18
        description: 'CURP de la persona, emitida por RENAPO'
        example: 'SAZR010101HCMLNS09'
      nacionalidad:
        type: 'string'
        description: 'Debe contener la clave de la nacionalidad del consumidor los valores posibles son los siguientes: MX = México.'
        maxLength: 2
        example: 'MX'
      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
        example: '000000000000'
      numeroDependientes:
        type: 'integer'
        format: 'int32'
        description: 'Número de personas que dependen de la persona.'
        example: 0
      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/DomicilioPeticion'
  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'
  LaeScore:
    type: 'object'
    properties:
      numero:
        type: 'string'
      valor:
        type: 'string'
      minimo:
        type: 'string'
      maximo:
        type: 'string'
  PeticionFolioConsulta:
    type: 'object'
    required:
      - 'folioOtorgante'
      - 'segmento'
      - 'folioConsulta'
    properties:
      folioOtorgante:
        type: 'string'
      segmento:
        $ref: '#/definitions/CatalogoSegmento'
      folioConsulta:
        type: 'string'
        description: 'Folio de la consulta'
    example:
      folioOtorgante: '1'
      segmento: 'PP'
      folioConsulta: '386636538'
  PeticionPersona:
    type: 'object'
    required:
      - 'folioOtorgante'
      - 'segmento'
      - 'persona'
    properties:
      folioOtorgante:
        type: 'string'
      segmento:
         $ref: '#/definitions/CatalogoSegmento'
      persona:
        $ref: '#/definitions/Persona'
    example: 
      folioOtorgante: '1'
      segmento: 'PP'
      persona:
        primerNombre: 'JUAN'
        apellidoPaterno: 'PRUEBA'
        apellidoMaterno: 'CUATRO'
        fechaNacimiento: '1980-01-04'
        RFC: 'PUAC800104'
        domicilio:
          direccion: 'INSURGENTES SUR 1004'
          colonia: 'INSURGENTES SUR'
          municipio: 'CIUDAD DE MEXICO'
          ciudad: 'CIUDAD DE MEXICO'
          estado: 'DF'
          CP: '11230'
  Respuesta:
    type: 'object'
    properties:
      folioOtorgante:
        type: 'string'
      folioConsultaLAE:
        type: 'string'
      scores:
        type: 'array'
        items:
          $ref: '#/definitions/LaeScore'
    example:
      folioOtorgante: '1'
      folioConsultaLAE: '389829467'
      scores:
        - numero: '1'
          valor: '1595'
          minimo: '1'
          maximo: '39'
        - numero: '2'
          valor: '1594'
          minimo: '40'
          maximo: '59'
        - numero: '3'
          valor: '1593'
          minimo: '60'
          maximo: '79'
        - numero: '4'
          valor: '1592'
          minimo: '80'
          maximo: '99'
        - numero: '5'
          valor: '1591'
          minimo: '100'
          maximo: '119'
        - numero: '6'
          valor: '1589'
          minimo: '120'
          maximo: '139'
        - numero: '7'
          valor: '1587'
          minimo: '140'
          maximo: '169'
        - numero: '8'
          valor: '1586'
          minimo: '170'
          maximo: '199'
        - numero: '9'
          valor: '1584'
          minimo: '220'
          maximo: '229' 