Gesintel (v1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Licencia

Khipu Open Data API

Languages
Servers
Production

https://api.khipu.com/

AML Report

Request

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.

Security
JWT or Api-Key
Bodyapplication/jsonRequerido
RequestDataobjectrequerido

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.

Rutstring

Identificador a consultar (RUT).

Ejemplo: "1234567-8"
Namestring

Nombre a consultar.

Ejemplo: "Joe Bloggs"
Typestring

Tipo de entidad. Person: Proporciona resultados solo para Personas Físicas. Entity: Proporciona resultados solo para Personas Jurídicas y/o Sociedades.

Enum"Person""Entity"
Ejemplo: "Person"
TypeSearchstring

Á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.

Enum"exact""near""fuzzy"
Ejemplo: "near"
MinMatchedstring

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.

Ejemplo: "10"
Citizenshipstring

Nacionalidad. Filtra los resultados que coinciden con la nacionalidad introducida.

FecNacstring

Fecha de nacimiento para las personas físicas o fecha de registro para las empresas.

ResidentOfstring

País de residencia.

CallbackUrlstring<= 255 characters

URL para enviar el mensaje de respuesta utilizando un método POST.

Ejemplo: "https://my-api.my-business.com/api/open-data-response"
curl -i -X POST \
  https://api.khipu.com/v1/com/services/gesintel.com/aml-report \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "RequestData": {}
  }'

Responses

Operación exitosa. Retorna un objeto JSON con los datos solicitados.

Bodyapplication/json
OperationIdstring<= 36 charactersrequerido

Identificador único de la operación.

Ejemplo: "6baf6c19-e485-463b-ae24-a821b025c8a4"
Statusstringrequerido

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.

Enum"OK""ERROR"
Ejemplo: "OK"
Dataobject or nullrequerido

Contenedor para AMLReport

AMLReportobjectrequerido

Contenedor para AMLReport

Pdfb64stringrequerido

Certificado codificado en una cadena base64.

AdditionalInformationstring or nullrequerido

Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo Data está incompleto.

Ejemplo: null
Errorobject or nullrequerido

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

Ejemplo: null
Codestring

Código interno del sistema que identifica el error.

Ejemplo: "E201"
Typestring

Indica cómo tratar este código de error específico, en función del tipo de error.

Enum"RETRY_IMMEDIATELY""DO_NOT_RETRY""WAIT_4_HOURS_BEFORE_RETRY""RETRY_AFTER_NOTIFICATION"
Ejemplo: "RETRY_IMMEDIATELY"
Descriptionstring

Descripción asociada al código de error.

Ejemplo: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."
LifeSpanstring or nullrequerido

null en peticiones sincrónicas.

Ejemplo: null
Response
application/json
{
  "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4",
  "Status": "OK",
  "Data": {
    "AMLReport": {
      "rut": "string",
      "name": "string",
      "pepResults": [],
      "pepHResults": [],
      "pepCResults": [],
      "personResults": [],
      "negativeResults": [],
      "vipResults": [],
      "djResults": {
        "socResults": [],
        "ameResults": [],
        "wlResults": []
      },
      "pdfLink": "string",
      "fpResults": [],
      "pjudResults": [],
      "pepRelacionados": [],
      "pepHRelacionados": []
    },
    "Pdfb64": "string"
  },
  "AdditionalInformation": null,
  "Error": null,
  "LifeSpan": null
}