swagger: '2.0'
info:
  title: 'Auditoría de Firma Simulacion'
  description: "API de simulacion para la auditoría de firmas.<br><br><img src='https://developer.circulodecredito.com.mx/sites/default/files/2020-10/circulo_de_credito-apihub.png' height='40' width='220'/></p><br/>" 
  version: 1.0.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: 'Auditoría de Firma'
    description: ''
    externalDocs:
      description: 'Portal de desarrolladores'
      url: 'https://developer.circulodecredito.com.mx/productos/auditoriafirma'
schemes:
  - 'https'
paths:
  '/v1/auth-nip/': 
    post:
      summary: 'Auditoría de Firma'
      description: '
      <p>Retorna el folio de consulta de circulo de crédito de la entrega del soporte de la autorización de consulta </p><p>Toda peticion fuera de la lista sera exitosa siempre y cuando cumpla con los campos obligatorios y reglas establecidas en este documento.</p><table border="1"><tr align="center"><td><h4>folioCDC</h4></td><td width="10%"><h4>Status</h4></td><td ><h4>Response</h4></td></tr><tr align="center"><td><h4>99999999</h4></td><td width="10%"><h4>400</h4></td><td align="left">{
        "errores": [       
          {
            "codigo": "400.6",
            "mensaje": "El folio consulta ya existe."
          },
          {
            "codigo": "400.7",
            "mensaje": "La fecha aprobación no puede ser mayor a la fecha de la consulta."
          },
          {
            "codigo": "400.8",
            "mensaje": "El campo \"{Campo}\" de la petición no coincide con los datos que están registados en Circulo de Crédito."
          },
          {
            "codigo": "400.9",
            "mensaje": "El número de otorgante del usuario \"{Usuario}\" no coincide con los datos que están registados en Circulo de Crédito."
          }
        ]
      }</td></tr> <tr align="center"><td><h4>99999998</h4></td><td width="10%"><h4>404</h4></td><td align="left">{
        "errores": [       
          {
            "codigo": "404.1",
            "mensaje": "No se encontró el folio"
          },
          {
            "codigo": "404.2",
            "mensaje": "No se encontraron datos de la consulta."
          }
        ]
      }</td></tr><tr align="center"><td><h4>99999997</h4></td><td width="10%"><h4>429</h4></td><td align="left">{
        "errores": [       
          {
            "codigo": "404.1",
            "mensaje": "No se encontró el folio"
          },
          {
            "codigo": "404.2",
            "mensaje": "No se encontraron datos de la consulta."
          }
        ]
      }</td></tr>
        <tr align="center"><td><h4>99999996</h4></td><td width="10%"><h4>500</h4></td><td align="left">{
        "errores": [       
              {
              "codigo": "500.1",
              "mensaje": "Ocurrio un problema, inténtelo nuevamente más tarde."
            }
        ]
      }</td></tr>
        <tr align="center"><td><h4>99999995</h4></td><td width="10%"><h4>503</h4></td><td align="left">{
        "errores": [       
           {
            "codigo": "503.1",
            "mensaje": "Servicio no disponible."
          }
        ]
      }</td></tr>
        </table>'
      tags:
      - 'Auditoría de Firma'
      operationId: 'nip'
      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'
        - in: 'body'
          name: 'body'
          description: 'Solicitud para NIP.'
          required: true
          schema:
           $ref: '#/definitions/SustitucionNIPPeticion'
      responses:
        '200':
          description: 'OK'
          schema:
            $ref: '#/definitions/SustitucionNIPRespuesta'
        '400':
          description: 'BAD REQUEST'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '400.1'
                  mensaje: 'El campo "{Campo}" no puede estar vacío.'
                - codigo: '400.2'
                  mensaje: 'El campo "{Campo}" es incorrecto.'
                - codigo: '400.3'
                  mensaje: 'La longitud del "{Campo}" es incorrecto.'
                - codigo: '400.4'
                  mensaje: 'El campo "{Campo}" debe ser mayor a cero.'
                - codigo: '400.5'
                  mensaje: 'El formato de fecha del "{Campo}" es incorrecto.'
                - codigo: '400.6'
                  mensaje: 'El folio consulta ya existe.'
                - codigo: '400.7'
                  mensaje: 'La fecha aprobación no puede ser mayor a la fecha de la consulta.'
                - codigo: '400.8'
                  mensaje: 'El campo "{Campo}" de la petición no coincide con los datos que están registados en Circulo de Crédito.'
                - codigo: '400.9'
                  mensaje: 'El número de otorgante del usuario "{Usuario}" no coincide con los datos que están registados en Circulo de Crédito.'
        '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.3'
                  mensaje: 'Acceso no autorizado, no tiene el producto asociado.'
                - codigo: '401.4'
                  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 folio'
                - codigo: '404.2'
                  mensaje: 'No se encontraron datos de la consulta.'
                  
        '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'
          schema:
            $ref: '#/definitions/Errores'
          examples:
            application/json:
              errores:
                - codigo: '503.1'
                  mensaje: 'Servicio no disponible.'
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>Aguascalientes</td><td>AGS</td></tr> <tr><td>Morelos</td><td>MOR</td></tr> <tr><td>Baja California Norte</td><td>BCN</td></tr> <tr><td>Nayarit</td><td>NAY</td></tr> <tr><td>Baja California Sur</td><td>BCS</td></tr> <tr><td>Nuevo León</td><td>NL</td></tr> <tr><td>Campeche</td><td>CAM</td></tr> <tr><td>Oaxaca</td><td>OAX</td></tr> <tr><td>Chiapas</td><td>CHS</td></tr> <tr><td>Puebla</td><td>PUE</td></tr> <tr><td>Chihuahua</td><td>CHI</td></tr> <tr><td>Querétaro</td><td>QRO</td></tr> <tr><td>Coahuila</td><td>COA</td></tr> <tr><td>Quintana Roo</td><td>QR</td></tr> <tr><td>Colima</td><td>COL</td></tr> <tr><td>San Luis Potosí</td><td>SLP</td></tr> <tr><td>Distrito Federal</td><td>DF</td></tr><tr><td>Ciudad de México</td><td>CDMX</td></tr> <tr><td>Sinaloa</td><td>SIN</td></tr> <tr><td>Durango</td><td>DGO</td></tr> <tr><td>Sonora</td><td>SON</td></tr> <tr><td>Estado de México</td><td>EM</td></tr> <tr><td>Tabasco</td><td>TAB</td></tr> <tr><td>Guanajuato</td><td>GTO</td></tr> <tr><td>Tamaulipas</td><td>TAM</td></tr> <tr><td>Guerrero</td><td>GRO</td></tr> <tr><td>Tlaxcala</td><td>TLAX</td></tr> <tr><td>Hidalgo</td><td>HGO</td></tr> <tr><td>Veracruz</td><td>VER</td></tr> <tr><td>Jalisco</td><td>JAL</td></tr> <tr><td>Yucatán</td><td>YUC</td></tr> <tr><td>Michoacán</td><td>MICH</td></tr> <tr><td>Zacatecas</td><td>ZAC</td></tr> </tbody> </table>'
    minLength: 2
    maxLength: 4
    example: 'AGS'
    enum:
      - 'AGS'
      - 'MOR'
      - 'BCN'
      - 'NAY'
      - 'BCS'
      - 'NL'
      - 'CAM'
      - 'OAX'
      - 'CHS'
      - 'PUE'
      - 'CHI'
      - 'QRO'
      - 'COA'
      - 'QR'
      - 'COL'
      - 'SLP'
      - 'DF'
      - 'CDMX'
      - 'SIN'
      - 'DGO'
      - 'SON'
      - 'EM'
      - 'TAB'
      - 'GTO'
      - 'TAM'
      - 'GRO'
      - 'TLAX'
      - 'HGO'
      - 'VER'
      - 'JAL'
      - 'YUC'
      - 'MICH'
      - 'ZAC'
  CatalogoTipoPersona:
    type: 'string'
    description: '<table> <thead> <tr> <th>Clave</th> <th>Descripción</th> </tr> </thead> <tr> <td>PF</td> <td>Persona Física</td> </tr> <tr> <td>PM</td> <td>Persona Moral</td> </table>'
    minLength: 2
    maxLength: 2
    example: 'PF'
    enum:
    - 'PF'
    - 'PM'
  SustitucionNIPRespuesta:
    description: 'Datos de respuesta para NIP.'
    type: 'object'
    properties:
      folioCDC: 
        type: 'integer'
        format: 'int32'
        example: '763211111'
        description: 'Número de folio de consulta generado por Circulo de Crédito al concluir la consulta.'
        minLength: 4
        maxLength: 25
  SustitucionNIPPeticion:
    description: 'Datos para NIP.'
    type: 'object'
    required:
      - 'folioCDC'
      - 'fechaConsulta'
      - 'horaConsulta'
      - 'tipoConsulta'
      - 'usuario'
      - 'fechaAprobacionConsulta'
      - 'horaAprobacionConsulta'
      - 'ingresoNuevamenteNIP'
      - 'respuestaLeyendaAutorizacion'
      - 'aceptaTerminosCondiciones'
      - 'numeroFirma'
      - 'persona'
    properties:
      folioCDC: 
        type: 'integer'
        format: 'int32'
        example: '763211111'
        description: 'Número de folio de consulta generado por Circulo de Crédito al concluir la consulta.'
        minLength: 4
        maxLength: 25
      fechaConsulta: 
        type: 'string'
        example: '2021/04/15'
        description: 'Fecha en la que se realizo la consulta en Circulo de Crédito.'
        minLength: 10
        maxLength: 10
      horaConsulta: 
        type: 'string'
        example: '10/12/35'
        description: 'Se refiere a la hora en la que se realizó la consulta en Circulo de Crédito. (Formato de 24 horas).'
        minLength: 8
        maxLength: 8
      tipoConsulta:
        $ref: '#/definitions/CatalogoTipoPersona'
      usuario: 
        type: 'string'
        example: 'NGA9915CC5'
        description: 'Se refiere al usuario de consulta del otorgante que realizo la consulta a Circulo de Crédito.'
        minLength: 10
        maxLength: 13
      fechaAprobacionConsulta: 
        type: 'string'
        example: '2021/04/15'
        description: 'Se refiere a la fecha en la que el cliente aprueba ser consultado en Circulo de Crédito.'
        minLength: 10
        maxLength: 10
      horaAprobacionConsulta: 
        type: 'string'
        example: '10/12/35'
        description: 'Se refiere a la hora en la que el cliente aprueba ser consultado en Circulo de Crédito. (Formato de 24 horas).'
        minLength: 8
        maxLength: 8
      ingresoNuevamenteNIP:
        type: 'boolean'
        description: 'Se refiere a sí el ciente confirmo el NIP para la aprobación de la consulta en Circulo de Crédito'
        example: true
      respuestaLeyendaAutorizacion:
        type: 'boolean'
        description: 'Se refiere a la respuesta que el ciente da a la leyenda de autorización de consulta en Circulo de Crédito'
        example: true
      aceptaTerminosCondiciones:
        type: 'boolean'
        description: 'Aceptación que compruebe la relación jurídica antes de la consulta'
        example: true
      numeroFirma:
        minLength: 2
        maxLength: 30
        type: 'string'
        description: 'Se refiere al nip o número de firma'
        example: '1234F'
      persona:
        $ref: '#/definitions/Persona'
  Domicilio:
    type: 'object'
    required:
      - 'calleNumero'
      - 'estado'
    properties:
      calleNumero: 
        type: 'string'
        example: 'LOPE DE VEGA 39'
        description: 'Se refiere a calle y numero del cliente como se capturo en su consulta.'
        minLength: 1
        maxLength: 80
      colonia: 
        type: 'string'
        example: 'SAN RAFAEL'
        description: 'Se refiere a la colonia del domicilio del cliente como se capturo en su consulta.'
        minLength: 1
        maxLength: 65
      ciudad: 
        type: 'string'
        example: 'CDMX'
        description: 'Se refiere a la ciudad del domicilio del cliente como se capturo en su consulta.'
        minLength: 1
        maxLength: 65
      estado:
        $ref: '#/definitions/CatalogoEstados'
    
  Persona:
    type: 'object'
    required:
      - 'primerNombre'
      - 'apellidoPaterno'
      - 'apellidoMaterno'
      - 'domicilio'
    properties:
      primerNombre: 
        type: 'string'
        example: 'MARGARITO'
        description: 'Primer nombre del cliente como se consulto.'
        minLength: 2
        maxLength: 30 
      segundoNombre: 
        type: 'string'
        example: 'FLORENCIO'
        description: 'Segundo nombre del cliente como se consulto.'
        minLength: 2
        maxLength: 30
      apellidoPaterno: 
        type: 'string'
        example: 'LOPEZ'
        description: 'Apellido paterno del cliente como se consulto.'
        minLength: 2
        maxLength: 30
      apellidoMaterno: 
        type: 'string'
        example: 'CALIXTO'
        description: 'Apellido materno del cliente como se consulto.'
        minLength: 2
        maxLength: 30
      apellidoAdicional: 
        type: 'string'
        example: 'PEREZ'
        description: 'Apellido adicional del cliente como se consulto.'
        minLength: 2
        maxLength: 30
      RFC: 
        type: 'string'
        example: 'LOCM840804'
        description: 'Se refiere al RFC del cliente.'
        minLength: 10
        maxLength: 13
      domicilio:
        $ref: '#/definitions/Domicilio'
  Error:
    type: 'object'
    description: 'error'
    properties:
      codigo:
        type: 'string'
        example: '400.1'
        description: 'Código de error.'
      mensaje:
        type: 'string'
        example: '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'