openapi: 3.0.1
info:
  license:
    name: Khipu Open Data API
    url: https://khipu.com
  title: Boletín Concursal
  description: ''
  version: v1.0
servers:
  - url: https://api.khipu.com
    description: Production
security:
  - JWT: []
  - Api-Key: []
paths:
  /v1/cl/services/boletinconcursal.cl/publications-procedure:
    post:
      summary: Procedure
      description: >-
        Este método retorna datos de un procedimiento con sus publicaciones
        asociadas para un Rol Tributario Nacional (RUT) chileno, tipo de
        procedimiento y rango de fecha específico usando el sitio web de
        **Boletín Concursal**.


        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: PublicationsProcedure
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicationsProcedureRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicationsProcedureResponseSyncOk'
        '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/PublicationsProcedureResponseAsync'
        '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 :(
  /v1/cl/services/boletinconcursal.cl/publications:
    post:
      summary: Publications
      description: >-
        Este método retorna publicaciones para un Rol Tributario Nacional (RUT)
        chileno, usando el sitio web de **Boletín Concursal**.


        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: Publications
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicationsRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicationsResponseSyncOk'
        '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/PublicationsResponseAsync'
        '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:
    PublicationsProcedureRequest:
      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:
            DebtorIdentifier:
              type: string
              description: >-
                Rol Único Nacional chileno (RUN). Se puede pasar con o sin
                puntos.
              example: 11.222.333-k
              pattern: ^\d{1,2}(\.){0,1}\d{3}(\.){0,1}\d{3}[-][0-9kK]{1}$
            ProcedureType:
              type: string
              description: Tipo de procedimiento.
              example: Liquidación voluntaria
            DebtorName:
              type: string
              description: Nombre del deudor.
              example: SOCIEDAD COMERCIAL AA LIMITADA
            PublicationDateStart:
              type: string
              description: >-
                Fecha de inicio en formato ISO 8601 (YYYY-MM-DD) utilizada para
                obtener las publicaciones.
              example: '2024-01-01'
            PublicationDateEnd:
              type: string
              description: >-
                Fecha de término en formato ISO 8601 (YYYY-MM-DD) utilizada para
                obtener las publicaciones.
              example: '2024-03-01'
            Region:
              type: string
              description: Región.
              example: Región Metropolitana
            Court:
              type: string
              description: Nombre del tribunal.
              example: 1° Juzgado Civil de Puente Alto
            Rol:
              type: string
              description: Rol.
              example: C-19999-9999
          required:
            - DebtorIdentifier
            - ProcedureType
            - DebtorName
            - PublicationDateStart
            - PublicationDateEnd
          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
    PublicationsProcedureResponseSyncOk:
      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
          type: object
          description: Contenedor de procedure.
          required:
            - Procedure
          properties:
            Procedure:
              type: object
              required:
                - Court
                - DebtorIdentifier
                - DebtorName
                - ProcedureType
                - Publication
                - Rol
              description: Contenedor de procedure.
              properties:
                DebtorIdentifier:
                  type: string
                  description: >-
                    Identificador único e inmutable utilizado para identificar
                    al usuario (también conocido como 'RUT'). Corresponde al
                    valor enviado en la solicitud.
                  example: 76.111.111-1
                DebtorName:
                  type: string
                  description: Nombre del deudor.
                  example: SOCIEDAD COMERCIAL AAA LIMITADA
                Court:
                  type: string
                  description: Nombre del tribunal.
                  example: 1° Juzgado Civil de Puente Alto
                Rol:
                  type: string
                  description: Rol.
                  example: C-19999-9999
                ProcedureType:
                  type: string
                  description: Tipo de Procedimiento.
                  example: Liquidación voluntaria - Empresa Deudora
                Publication:
                  type: array
                  description: Contenedor de publicaciones.
                  items:
                    type: object
                    required:
                      - Overseer
                      - PublicationDate
                      - PublicationName
                    properties:
                      PublicationDate:
                        type: string
                        description: Fecha de la publicación.
                        example: '2022-02-13'
                      PublicationName:
                        type: string
                        description: Nombre de la publicación.
                        example: Cuenta provisoria del liquidador
                      Overseer:
                        type: string
                        description: Veedor.
                        example: John Doe
          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
    PublicationsProcedureResponseAsync:
      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
    PublicationsRequest:
      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:
            DebtorIdentifier:
              type: string
              description: >-
                Rol Único Nacional chileno (RUN). Se puede pasar con o sin
                puntos.
              example: 11.222.333-k
              pattern: ^\d{1,2}(\.){0,1}\d{3}(\.){0,1}\d{3}[-][0-9kK]{1}$
            ProcedureType:
              type: string
              description: Tipo de procedimiento.
              example: Liquidación voluntaria
            DebtorName:
              type: string
              description: Nombre del deudor.
              example: SOCIEDAD COMERCIAL AA LIMITADA
            PublicationDateStart:
              type: string
              description: >-
                Fecha de inicio en formato ISO 8601 (YYYY-MM-DD) utilizada para
                obtener las publicaciones.
              example: '2024-01-01'
            PublicationDateEnd:
              type: string
              description: >-
                Fecha de término en formato ISO 8601 (YYYY-MM-DD) utilizada para
                obtener las publicaciones.
              example: '2024-03-01'
            Region:
              type: string
              description: Región.
              example: Región Metropolitana
            Court:
              type: string
              description: Nombre del tribunal.
              example: 1° Juzgado Civil de Puente Alto
            Rol:
              type: string
              description: Rol.
              example: C-19999-9999
          required:
            - DebtorIdentifier
          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
    PublicationsResponseSyncOk:
      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
          type: object
          description: Contenedor de publicaciones.
          required:
            - Publication
          properties:
            Publication:
              type: array
              description: Contenedor de publicaciones.
              items:
                type: object
                required:
                  - DebtorIdentifier
                  - DebtorName
                  - PublicationName
                  - Overseer
                  - ProcedureType
                  - PublicationDate
                properties:
                  DebtorIdentifier:
                    type: string
                    description: >-
                      Identificador único e inmutable utilizado para identificar
                      al usuario (también conocido como 'RUT'). Corresponde al
                      valor enviado en la solicitud.
                    example: 76.111.111-1
                  ProcedureType:
                    type: string
                    description: Tipo de Procedimiento.
                    example: Liquidación voluntaria - Empresa Deudora
                  DebtorName:
                    type: string
                    description: Nombre del deudor.
                    example: SOCIEDAD COMERCIAL AAA LIMITADA
                  PublicationDate:
                    type: string
                    description: Fecha de la publicación.
                    example: '2022-02-13'
                  PublicationName:
                    type: string
                    description: Nombre de la publicación.
                    example: Cuenta provisoria del liquidador
                  Overseer:
                    type: string
                    description: Veedor.
                    example: John Doe
          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
    PublicationsResponseAsync:
      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
