openapi: 3.0.1
info:
  license:
    name: Khipu Open Data API
    url: https://khipu.com
  title: Gesintel
  description: ''
  version: v1.0
servers:
  - url: https://api.khipu.com
    description: Production
security:
  - JWT: []
  - Api-Key: []
paths:
  /v1/com/services/gesintel.com/aml-report:
    post:
      summary: AML Report
      description: >-
        Este método retorna el Informe AML para un Rol Único Tributario (RUT)
        chileno o un nombre dado, utilizando **Gesintel**.


        El uso del campo `CallbackUrl` desencadenará un proceso asíncrono y los
        datos resultantes se enviarán más tarde al webhook especificado. Esta es
        la forma preferida de interactuar con nuestros servicios, ya que asegura
        que se harán todos los esfuerzos para extraer los datos y cumplir  con
        su solicitud dentro de un plazo razonable. Si desea la respuesta de
        inmediato, omita el campo `CallbackUrl` pero tenga en cuenta que puede
        provocar tiempos de espera dependiendo del tamaño del resultado de los
        datos y las condiciones de la red.
      operationId: AmlReport
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmlReportRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReportResponseSyncOk'
        '202':
          description: >-
            Operación exitosa. Retorna un mensaje JSON informando el resultado
            de la operación solicitada. La respuesta completa, con el mismo
            esquema que la versión síncrona, se enviará al URL de callback
            proporcionado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmlReportResponseAsync'
        '400':
          description: Solicitud incorrecta
        '401':
          description: No autorizado - Credenciales inválidas o faltantes
        '404':
          description: No encontrado - Recurso no disponible
        '500':
          description: Error en el servicio remoto :(
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
    Api-Key:
      type: apiKey
      in: header
      name: x-api-key
  schemas:
    AmlReportRequest:
      additionalProperties: false
      description: Objeto para realizar una solicitud al servicio OpenData.
      properties:
        RequestData:
          additionalProperties: false
          description: >-
            Información necesaria para conectarse a la cuenta del usuario en el
            sitio web y extraer datos. Los campos obligatorios indican los
            valores necesarios para identificar la cuenta deseada.
          properties:
            Rut:
              description: Identificador a consultar (RUT).
              example: 1234567-8
              type: string
            Name:
              description: Nombre a consultar.
              example: Joe Bloggs
              type: string
            Type:
              description: >-
                Tipo de entidad. `Person`: Proporciona resultados solo para
                Personas Físicas. `Entity`: Proporciona resultados solo para
                Personas Jurídicas y/o Sociedades.
              example: Person
              enum:
                - Person
                - Entity
              type: string
            TypeSearch:
              description: >-
                Ámbito de búsqueda. `exact`: Busca coincidencias exactas con el
                nombre introducido. `near`: Permite buscar palabras cercanas al
                nombre introducido, hasta un 20% de distancia por cada palabra
                coincidente (Valor por defecto). `fuzzy`: Permite buscar
                palabras con hasta un 40% de distancia por cada palabra
                coincidente.
              example: near
              enum:
                - exact
                - near
                - fuzzy
              type: string
            MinMatched:
              description: >-
                Número entre 1-100 para indicar el porcentaje mínimo de
                confianza. Filtra los resultados que tienen al menos el
                porcentaje especificado en cada resultado.
              example: '10'
              type: string
            Citizenship:
              description: >-
                Nacionalidad. Filtra los resultados que coinciden con la
                nacionalidad introducida.
              type: string
            FecNac:
              description: >-
                Fecha de nacimiento para las personas físicas o fecha de
                registro para las empresas.
              type: string
            ResidentOf:
              description: País de residencia.
              type: string
          required: []
          type: object
        CallbackUrl:
          description: URL para enviar el mensaje de respuesta utilizando un método POST.
          example: https://my-api.my-business.com/api/open-data-response
          type: string
          maxLength: 255
      required:
        - RequestData
      type: object
    AmlReportResponseSyncOk:
      additionalProperties: false
      description: >-
        Objeto con la respuesta desde el servicio OpenData, en modo Sincrónico,
        cuando `Status` es "OK"
      properties:
        OperationId:
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
          type: string
          maxLength: 36
        Status:
          description: >-
            Estado de la operación. `OK` significa que el servicio se ha
            ejecutado correctamente aunque no devuelva datos. `ERROR` indica que
            ha ocurrido algo que ha impedido la finalización con éxito del
            proceso.
          example: OK
          type: string
          enum:
            - OK
            - ERROR
        Data:
          additionalProperties: false
          description: Contenedor para AMLReport
          required:
            - AMLReport
            - Pdfb64
          type: object
          properties:
            AMLReport:
              description: Contenedor para AMLReport
              type: object
              properties:
                rut:
                  type: string
                  description: Rut/DNI entró a consultar.
                name:
                  type: string
                  description: Nombre introducido para consulta.
                pepResults:
                  description: Lista de titulares actuales del registro PEP.
                  type: array
                pepHResults:
                  description: >-
                    Lista de inscripciones históricas en el registro PEP
                    (Personas Políticamente Expuestas).
                  type: array
                pepCResults:
                  description: >-
                    Lista de candidatos al registro PEP (Personas Políticamente
                    Expuestas).
                  type: array
                personResults:
                  description: Lista de registros de la base de personas de interés.
                  type: array
                negativeResults:
                  description: Lista de Registros Base de Negatividad (Listas Propias).
                  type: array
                vipResults:
                  description: Lista de registros de base para personas VIP.
                  type: array
                djResults:
                  description: Ofrece información de las bases internacionales DJ.
                  type: object
                  properties:
                    socResults:
                      description: >-
                        Lista de resultados de la base de datos de empresas
                        estatales.
                      type: array
                    ameResults:
                      description: Lista de resultados de la base de datos Adverse Media.
                      type: array
                    wlResults:
                      description: Lista de resultados de la base de datos Watchlist.
                      type: array
                pdfLink:
                  description: Enlace para descargar el informe AML en PDF.
                  type: string
                fpResults:
                  description: >-
                    Lista de resultados de la base de datos de Funcionarios
                    Públicos.
                  type: array
                pjudResults:
                  description: Lista de resultados de la base de datos del Poder Judicial.
                  type: array
                pepRelacionados:
                  type: array
                pepHRelacionados:
                  type: array
            Pdfb64:
              description: Certificado codificado en una cadena base64.
              type: string
          nullable: true
        AdditionalInformation:
          description: >-
            Este campo puede utilizarse para mostrar información relevante
            específica de la respuesta, por ejemplo indicando que el campo
            `Data` está incompleto.
          example: null
          type: string
          nullable: true
        Error:
          description: >-
            Objeto con los detalles del error, utilizado cuando `Status=ERROR`.
            Si `Status=OK` este campo será nulo. Puede leer una explicación
            completa de este objeto visitando [este
            enlace](https://docs.khipu.com/portal/en/errors/)
          example: null
          properties:
            Code:
              description: Código interno del sistema que identifica el error.
              example: E201
              type: string
            Type:
              description: >-
                Indica cómo tratar este código de error específico, en función
                del tipo de error.
              example: RETRY_IMMEDIATELY
              type: string
              enum:
                - RETRY_IMMEDIATELY
                - DO_NOT_RETRY
                - WAIT_4_HOURS_BEFORE_RETRY
                - RETRY_AFTER_NOTIFICATION
            Description:
              description: Descripción asociada al código de error.
              example: >-
                El servicio destino utilizado para la extracción de datos no se
                encuentra disponible.
              type: string
          required: []
          type: object
          nullable: true
        LifeSpan:
          description: '`null` en peticiones sincrónicas.'
          example: null
          type: string
          nullable: true
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      type: object
    AmlReportResponseAsync:
      type: object
      description: Objeto con la respuesta del servicio OpenData, en modo asíncrono.
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      properties:
        OperationId:
          maxLength: 36
          type: string
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
        Status:
          type: string
          description: >-
            Estado de la operación. Al realizar solicitudes asíncronas, siempre
            devolverá `OK`.
          example: OK
        Data:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        AdditionalInformation:
          type: string
          description: >-
            Mensaje de la operación, puede usarse para mostrar información
            adicional.
          example: Data will be sent to the callback URL.
        Error:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        LifeSpan:
          type: string
          format: date-time
          description: >-
            Fecha máxima estimada de entrega para solicitudes asíncronas, en
            formato de fecha y hora ISO 8601, zona horaria UTC.
          example: 2017-07-22T00:00:00-0400
