External API Chile

## Sections
• [Autenticación](https://app.theneo.io/regcheq/external-api/autenticacion.md): Para consumir los servicios de esta API, cada cliente debe contar un con una API_KEY única que habilita el acceso a los distintos endpoints disponibles. Cada solicitud debe apuntar a la siguiente estructura URL: HTTP https://external-api.regcheq.com/{endpoint}/{API_Key} {endpoint} puede ser: record , operation o interest-list . {API_KEY} es la clave única que identifica al cliente y autoriza la solicitud. Método de solicitud El método HTTP dependerá del tipo de operación ( POST , GET , PATCH , etc.), y está especificado en cada endpoint En todos los casos, la API_KEY debe incluirse como parte del path en la URL. Ejemplo de solicitud Método: POST (creación o actualización de una ficha) Endpoint: Ficha ( /record ) API_KEY : abc123xyz456 Método y URL de solicitud: HTTP POST https://external-api.regcheq.com/record/abc123xyz456 Body ( JSON ): JSON { "dni": "none", "personType": "natural", "name": "JUAN ANDRÉS", "fatherName": "PEREZ", "motherName": "PEREIRA" } Notas: dni puede ser “none” si no se cuenta con ese dato en el momento o la persona no tiene un número de identificación válido. personType debe ser “natural” o “legal” , dependiendo del tipo de registro ingresado (persona natural o empresa). Este ejemplo crea una ficha básica de persona natural sin número de identificación con nombre completo: JUAN ANDRÉS PEREZ PEREIRA .
• [Ficha](https://app.theneo.io/regcheq/external-api/ficha.md): La sección de Ficha permite crear, actualizar y consultar los datos asociados a una persona o entidad. Se utiliza principalmente para registrar información que luego será evaluada dentro de una operación o monitoreo. Endpoints disponibles Método URL Descripción POST https://external-api.regcheq.com/record/{API_KEY} Crear o actualizar una ficha GET https://external-api.regcheq.com/record/{dni}/{API_KEY} Consultar ficha utlizando el dni como parametro de busqueda
  • [Crear/actualizar ficha](https://app.theneo.io/regcheq/external-api/ficha/crear-actualizar-ficha.md): Método: POST URL: https://external-api.regcheq.com/record/{API_KEY} Permite registrar una nueva ficha o actualizar una existente. Para el caso de actualización, utiliza el parametro dni para identificar si la ficha existe en el sistema. Al momento de crear una ficha, el tipo de persona se define con el campo personType que puede ser: “natural” para personas naturales “legal” para personas jurídicas Campos mínimos requeridos Campo Tipo Descripción dni string Número de identificación válido para la cuenta o “none” si no posee un número de identificación válido personType string “natural” o “legal” Al momento de enviar datos para crear o actualizar una ficha: No debes incluir propiedades con valor null . Esto puede provocar errores de validación o el rechazo de la solicitud. Si un campo no aplica o no tienes información para enviarlo, simplemente omite la propiedad en lugar de incluirla con valor null . Si envías campos con valor vacío ( "" ), el sistema actualizará ese campo. Es decir, el valor actual de la ficha c cambiará a vacío. Esto permite eliminar valores dentro de las propiedades almacenadas en la plataforma. Para no actualizar un valor, se recomienda no enviar ese valor en la petición. Campos permitidos por tipo de persona Persona natural Campo Tipo Obligatoriedad Descripción dni string Obligatorio Número de identificación válido para la cuenta o “none” si no posee un número de identificación válido dniType string Opcional Tipo de documento. Por defecto será el tipo de documento válido asociado a la cuenta. Para cuentas de Chile, por defecto es el RUT. personType string Obligatorio “natural” o “legal” name string Opcional Nombre o nombres de la persona natural fatherName string Opcional Primer apellido de la persona natural motherName string Opcional Segundo apellido de la persona natural email string Opcional Correo electrónico phone string Opcional Teléfono de contacto o celular nationality string Opcional País de nacionalidad (ver diccionario de países permitidos) country string Opcional País de residencia (ver diccionario de países permitidos) region string Opcional Región o estado city string Opcional Ciudad o comuna address string Opcional Dirección zipCode string Opcional Código postal birthDate string Opcional Fecha de cumpleaños en formato: aaaa-mm-dd gender string Opcional Género maritalStatus string Opcional Estado civil position string Opcional Profesión, ocupación u oficio employer string Opcional Empleador income string Opcional Ingreso de la persona natural comments string Opcional Comentarios adicionales sobre la persona natural tagFile array de strings Opcional Etiquetas Persona legal Campo Tipo Obligatoriedad Descripción dni string Obligatorio Número de identificación válido para la cuenta o “none” si no posee un número de identificación válido dniType string Opcional Tipo de documento. Por defecto será el tipo de documento válido asociado a la cuenta. Para cuentas de Chile, por defecto es el RUT. personType string Obligatorio “natural” o “legal” socialReason string Opcional Razón social fantasyName string Opcional Nombre de fantasía email string Opcional Correo electrónico phone string Opcional Teléfono de contacto o celular nationality string Opcional País de nacionalidad (ver diccionario de países permitidos) country string Opcional País de residencia (ver diccionario de países permitidos) region string Opcional Región o estado city string Opcional Ciudad o comuna address string Opcional Dirección zipCode string Opcional Código postal businessType string Opcional Tipo de negocio o Giro comercial sales string Opcional Ventas de la empresa comments string Opcional Comentarios adicionales sobre la persona natural tagFile array de strings Opcional Etiquetas personsRelations array de objetos Opcional Personas relacionadas Personas relacionadas Si bien las personsRelations es un array de objetos opcional dentro de la ficha de persona legal, una vez que se agrega, es obligatorio ingresar como mínimo: Un objeto dentro del array Dentro del objeto, los campos dni y type Parametros asociados a cada objeto dentro de personsRelations : Los parametros que se destacan como obligatorios dentro de la siguiente tabla, son obligatorios dentro de cada objeto. Pero no es obligatorio agregarlos al crear una ficha de persona legal, solo es obligatorio si va la propiedad personsRelations . Campos Tipo Obligatoriedad Descripción dni string Obligatorio Número de identificación válido para la cuenta. No se pueden crear personas relacionadas sin número de identificación . type array de strings Obligatorio String permitidos: beneficiary (beneficiario final) representant (representante legal) effectiveControl (control efectivo) declarant (declarante) manager (alta gerencia) name string Opcional Nombre o nombres de la persona relacionada fatherName string Opcional Primer apellido de la persona relacionada motherName string Opcional Segundo apellido de la persona relacionada percentage string Opcional Porcentaje de participación en el caso que el tipo de relación ( type ) sea beneficiario final ( beneficiary ) o control efectivo ( effectiveControl ) Al agregar una persona relacionada en una ficha de persona legal, en la plataforma se creará una relación en el apartado “Personas relacionadas” dentro de la ficha de persona legal, y se creará una ficha de persona natural asociada a la persona relacionada agregada.
  • [Consultar ficha](https://app.theneo.io/regcheq/external-api/ficha/consultar-ficha-1.md): Método: GET URL: https://external-api.regcheq.com/record/{dni}/{API_KEY} Permite obtener la información de una ficha previamente creada , ya sea persona natural o legal, utilizando su dni como identificador. Para consulta una creada con el parametro “none” en dni al no tener un número de identificación válido, puede utilizar el dni generado por el sistema para hacer la consulta. Respuestas posibles Ficha encontrada Si el dni consultado existe dentro de la cuenta asociada al API_KEY , se devuelve un objeto completo con toda la información de la ficha almacenada, incluyendo datos generales que informa el sistema, datos personales almacenados en la ficha, datos de listas y riesgo, datos asociados a formularios, entre otros. Ficha no encontrada Si el dni consultada no existe dentro de la cuenta asociada al API_KEY , se devuelve un array vacío. La información de las fichas están aisladas por cliente Asegurate que el dni enviado en la URL este correctamente formateado (sin espacios, guiones y letras en mayusculas).
  • [Errores](https://app.theneo.io/regcheq/external-api/ficha/errores-1.md): Al crear o actualizar una ficha, pueden ocurrir errores por validación de datos, campos inválidos o envíos mal estructurados. A continuación se detallan los errores más frecuentes, su causa y como corregirlos DNI inválido Este error ocurre cuando el valor del campo dni no cumple con el formato esperado o es un valor invalido (por ejemplo, incluye caracteres no válidos, una estructura incorrecta o esta mal escrito). Respuesta: JSON { "error": { "statusCode": 400, "name": "BadRequestError", "message": "undefined dni invalid-554" } } Tipo de persona invalido Este error ocurre cuando se envía un valor incorrecto en el campo personType (distinto a “natural” para persona natural, o “legal” para persona jurídica). Respuesta: JSON { "error": { "statusCode": 400, "name": "BadRequestError", "message": "Invalid personType name" } } País invalido Ocurre cuando el valor enviado en el campo country o nationality no corresponde a un país aceptado por el sistema. Ejemplo: “Chileno” en vez de “Chile” . Asegurate que el valor de país corresponda a alguno de los valores permitidos descritos en el diccionario de países: https://app.theneo.io/regcheq/external-api/diccionarios Respuesta: JSON { "error": { "statusCode": 400, "name": "BadRequestError", "message": "Create massive record-fs-166" } } Etiqueta inválida Este error se genera cuando se envían etiquetas invalidas en la propiedad tagFile . También, cuando se envían etiquetas que no existen o no están en la configuración, o cuando esta funcionalidad no está habilitada en la cuenta. Para habilitar la funcionalidad Etiquetas o agregar nuevos valores de etiquetas a la cuenta, puedes gestionar esto en el módulo Gestión de cuenta > Etiquetas utilizando los permisos de Super Administrador . Respuesta: JSON { "error": { "statusCode": 400, "name": "BadRequestError", "message": "BadRequestError: Some tag does not exist in the configuration. Check again." } } Tipo de persona relacionada invalida Este error se produce cuando el tipo de persona relacionada en el array type es invalido. Los valores aceptados para tipo de persona relacionada son: representant , beneficiary , manager , declarant y effectiveControl . Respuesta: JSON { "error": { "statusCode": 400, "name": "BadRequestError", "message": "139-persons relations only: representant, beneficiary, manager, declarant, effectiveControl" } } Request invalida Este error se produce cuando el cuerpo de la solicitud esta vacío o tiene una estructura invalida por falta de parametros obligatorios. Recuerda que los campos mínimos requeridos son dni y personType . Evita hacer solicitudes sin body Respuesta: JSON { "error": { "statusCode": 500, "message": "Internal Server Error" } } Recomendaciones generales: No enviar valores null ni vacíos si no se va a utilizar la propiedad. Omite estas propiedades si no tienes el valor o no quieres actualizar el campo. Usa siempre formatos estandarizados. Por ejemplo, para fecha utilizar la estructura “YYYY-MM-DD” . Revisa los valores permitidos en los diccionarios, como es el caso de países para los campos country y nationality. En caso de dudas sobre la activación de funcionalidades como etiquetas, puedes consultar con tu customer experience a cargo de tu cuenta.
• [Operación](https://app.theneo.io/regcheq/external-api/operaciones.md): El módulo Operación permite registrar y consultar transacciones en la plataforma. Una operación es un flujo donde distintos actores actuan como participantes, ya sea personas naturales o jurídicas, teniendo distintos indicadores sobre la traza de parametros asociados a la operación, como el tipo de transacción o la fecha de la transacción. También, permite realizar diligencias asociadas a las reglas de negocio configuradas en la cuenta, como el envío de formularios requeridos para la operación en curso. Cada operación puede involucrar a una o varias personas, y cada una de estas personas que actua como participante se crea en el sistema como ficha, por lo que es cruzado con distintas listas de sanciones, calculando el riesgo inherente del involucrado. En caso de existir la ficha, esta es actualizada con los nuevos parametros enviados o simplemente trae la información previamente cargada. Endpoints disponibles Método URL Descripción POST https://external-api.regcheq.com/operation/{API_KEY} Crea una nueva operación GET https://external-api.regcheq.com/operation/{operationId}/{API_KEY} Consulta una operación existente utilizando el operationId como parametro de busqueda
  • [Crear operación](https://app.theneo.io/regcheq/external-api/operaciones/crear-operacion-3.md): Método: POST URL: https://external-api.regcheq.com/operation/{API_KEY} Permite registrar una nueva operación en el sistema. Consideraciones Participantes : Una operación puede incluir entre 1 y 5 participantes, los cuales se agregan en el array operations como distintos objetos anidados. Información general de cada participante ( ficha ) : Aunque no es obligatorio, se recomienda incluir información extra en la ficha de cada participante, como lo es: nombres, apellidos, razón social, entre otros. Información propia de la operación : Aunque no es obligatorio, se recomienda incluir información extra de la operación, como lo es: tipo de transacción o fecha de transacción. llamado transactions para incluir información adicional sobre la operación. Sujeto Conductor : Si hay dinero en efectivo vinculado a la operación, se puede añadir información del sujeto conductor en un objeto opcional llamado transporter . Envío de Formularios : Para activar el envío de formularios, se debe agregar un objeto opcional llamado options , el cual configura el envío y permite añadir un perfil para el correo del formulario enviado. Campos mínimos requeridos Campo Tipo Descripción dni String Número de identificación válido para la cuenta type String “natural” o “legal” monto Number Monto total de la operación en base al tipo de moneda. Puede incluir decimales. efective Number Monto en efectivo de la operación en base al tipo de moneda. Puede incluir decimales. currency String Tipo de moneda usado en la operación: “$” para peso chileno, “USD” para dólar y “UF” para unidad de fomento chilena. ficha Objeto Objeto “ficha” . Puede ir vacío. Dentro de este objeto se listan todos los datos generales del participante. Las operaciones al ser flujos complejos en donde pueden participar distintos actores, o generar distintas interacciones dependiendo de la necesidad, es que contiene distintos componentes para poder suplir cada una de las interacciones necesarias u obligatorias del regulador. A continuación, en distintas páginas de la sub sección Crear operación , se detalla cada uno de los componentes disponibles en este endpoint.
    • [operations](https://app.theneo.io/regcheq/external-api/operaciones/crear-operacion-3/operation.md): El componente operations es un array de objetos , donde cada objeto representa un participante involucrado en la operación. Puede tratarse de una persona natural o jurídica. Cada participante tiene: Datos del asociado, es decir, información contextual de su rol en la operación (como los montos o tipo de moneda). Estos son los datos que están en la raíz de cada objeto dentro del array operations . Un objeto ficha con los datos generales de la persona. Para el caso de personas jurídicas, un array personsRelations con las personas físicas que actuan en representación o como beneficiarios de estas empresas. Estructura general: JSON "operations": [ { "dni": "...", "type": "...", "monto": ..., "efective": ..., "currency": "...", "ficha": { ... }, "personsRelations": [ ... ] } ] Campos del asociado Campo Tipo Obligatoriedad Descripción dni String Obligatorio Número de identificación válido para la cuenta. type String Obligatorio “natural” o “legal” monto Number Obligatorio Monto total de la operación en base al tipo de moneda. Puede incluir decimales. efective Number Obligatorio Monto en efectivo de la operación en base al tipo de moneda. Puede incluir decimales. currency String Obligatorio Tipo de moneda usado en la operación: “$” para peso chileno, “USD” para dólar y “UF” para unidad de fomento chilena. ficha Objeto Obligatorio Objeto “ficha” . Puede ir vacío. Dentro de este objeto se listan todos los datos generales del participante. personsRelations Array de objetos Opcional Lista de personas naturales que actúan como representantes o beneficiarios del participante (ej. representante legal de una empresa). Sobre el objeto ficha El objeto ficha dentro de cada objeto de participante contiene los datos generales de la persona o entidad. A continuación se adjuntan los campos permitidos según el tipo de persona Persona natural Campo Tipo Obligatoriedad Descripción name string Opcional Nombre o nombres de la persona natural fatherName string Opcional Primer apellido de la persona natural motherName string Opcional Segundo apellido de la persona natural email string Opcional Correo electrónico phone string Opcional Teléfono de contacto o celular nationality string Opcional País de nacionalidad (ver diccionario de países permitidos) country string Opcional País de residencia (ver diccionario de países permitidos) region string Opcional Región o estado city string Opcional Ciudad o comuna address string Opcional Dirección zipCode string Opcional Código postal birthDate string Opcional Fecha de cumpleaños en formato: aaaa-mm-dd gender string Opcional Género maritalStatus string Opcional Estado civil position string Opcional Profesión, ocupación u oficio employer string Opcional Empleador income string Opcional Ingreso de la persona natural comments string Opcional Comentarios adicionales sobre la persona natural tagFile array de strings Opcional Etiquetas Persona legal Campo Tipo Obligatoriedad Descripción socialReason string Opcional Razón social fantasyName string Opcional Nombre de fantasía email string Opcional Correo electrónico phone string Opcional Teléfono de contacto o celular nationality string Opcional País de nacionalidad (ver diccionario de países permitidos) country string Opcional País de residencia (ver diccionario de países permitidos) region string Opcional Región o estado city string Opcional Ciudad o comuna address string Opcional Dirección zipCode string Opcional Código postal businessType string Opcional Tipo de negocio o Giro comercial sales string Opcional Ventas de la empresa comments string Opcional Comentarios adicionales sobre la persona natural tagFile array de strings Opcional Etiquetas personsRelations array de objetos Opcional Personas relacionadas Sobre el array personsRelations Este campo representa personas relacionadas funcionalmente con un participante. Si bien se creará como persona relacionada en la ficha del participante al que este asociado este componente, este tiene como fin agregar un representante o beneficiario que actue en representación de la persona jurídica a la que este encabezando. Para el caso de las operaciones, personsRelations va en la raíz del objeto del participante (información asociada) y no dentro de la ficha (como en el endpoint /record ). Si bien personsRelations es un array de objetos opcional para los participantes de "type": "legal" , una vez que se agrega, es obligatorio ingresar como mínimo: Un objeto dentro del array Dentro de los objetos en el array personsRelations , los campos dni y type Parametros asociados a cada objeto dentro de personsRelations : Los parametros que se destacan como obligatorios dentro de la siguiente tabla, son obligatorios dentro de cada objeto. Pero no es obligatorio agregarlos al crear una ficha de persona legal, solo es obligatorio si va la propiedad personsRelations . Campos Tipo Obligatoriedad Descripción dni string Obligatorio Número de identificación válido para la cuenta. No se pueden crear personas relacionadas sin número de identificación . type array de strings Obligatorio String permitidos: beneficiary (beneficiario final) representant (representante legal) name string Opcional Nombre o nombres de la persona relacionada fatherName string Opcional Primer apellido de la persona relacionada motherName string Opcional Segundo apellido de la persona relacionada Ingresar multiplés participantes El array operations permite registrar más de un participante en una misma operación. Cada objeto dentro del array representa a una persona natural o jurídica, que cumple un rol específico en el contexto de la transacción. Este diseño es útil en escenarios donde participan varias personas en conjunto, como: Compras colectivas (ej: co-propiedades de inmueble o vehículos). Transferencias o remesas de dinero entre dos personas, donde un participante actua como “Emisor” y otro actua como “Receptor”. Polizas de seguros teniendo distintos roles en cada participante, como Contratante, Asegurado, Intermediario o Pagador. Estructura general para múltiples participantes: JSON "operations": [ { "dni": "...", "type": "natural", "monto": 1000000, "efective": 0, "currency": "UF", "ficha": { ... } }, { "dni": "...", "type": "natural", "monto": 0, "efective": 0, "currency": "UF", "ficha": { ... } }, { "dni": "...", "type": "legal", "monto": 0, "efective": 0, "currency": "UF", "ficha": { ... }, "personsRelations": [ ... ] } ] ] Puedes incluir tantos participantes como requiera la operación. Cada participante y persona relacionada incluido en el array operations será creado como ficha en el sistema. El orden de los participantes no define un rol formal dentro de la operación. Solo lo hará si la lógica de negocio de cada cliente detrás de esta estructura define un orden, como el caso Emisor/Receptor.
    • [transactions](https://app.theneo.io/regcheq/external-api/operaciones/crear-operacion-3/transactions.md): El componente transactions es un objeto dentro del objeto general de la operación, que contiene información complementaria y contextual sobre la operación. Esta información no es obligatoria para crear una operación, pero permite enriquecer los datos registrados con detalles relevantes para el negocio del cliente. Si decides enviar el objeto transactions , el campo transactionDate se vuelve obligatorio. Estructura general: JSON "transactions": { "referenceNumber": "A123456789", "transactionComments": "ASD123", "transactionType": "Automotora", "transactionDate": "2024-02-14", "tagOperation": ["Online"] } Descripción de campos: Campo Tipo Obligatoriedad Descripción referenceNumber string No Número de referencia único del negocio del cliente. Puede ser usado para correlacionar con sistemas internos. transactionComments string No Comentarios adicionales sobre la operación. Útil para dejar observaciones como estados, roles o antecedentes relevantes. transactionType string No Tipo de transacción. Este campo debe coincidir con alguno de los valores definidos en el Diccionario de Tipos de Transacción. transactionDate string Condicional Obligatorio solo si se envía transactions . Fecha de la operación en formato YYYY-MM-DD . Se recomienda usar la fecha actual si no se conoce la real. tagOperation array de strings No Etiquetas de la operación. Deben estar previamente configuradas en la cuenta del cliente. Consideraciones importantes: El objeto transactions es opcional, pero si lo incluyes, transactionDate es obligatorio . Si no conoces la fecha exacta de la transacción, usa la fecha del día en que se crea la operación. Las tagOperation funcionan igual que las tagFile de la ficha: deben estar configuradas previamente en la cuenta, ya que la validación se hace contra estos valores. Para la correcta visualización dentro de la plataforma, el valor de transactionType debe ser uno de los listados en el diccionario de Tipos de transacción.
    • [options](https://app.theneo.io/regcheq/external-api/operaciones/crear-operacion-3/options.md): El objeto options permite configurar el comportamiento de las diligencias o formularios que pueden ser requeriso según las reglas de negocio asociadas a la cuenta del cliente. Este componente es útil para gatillar automaticamente los formularios requeridos por regulación o por flujos internos definidos en la plataforma Regcheq. Este objeto es completamente opcional . Si no se incluye, no se gatilla niguna diligencia y se utilizará la configuración por defecto de la cuenta. Para que se pueda realizar el envío automatico de formularios, es requisito que la ficha de los participantes tengan un mail valido como valor en la propiedad email Estructura general: JSON "options": { "sendForms": true, "template": "Perfil 1", "urlFormsResponse": false } Descripción de campos: Campo Tipo Obligatoriedad Descripción sendForms boolean No Si se establece en true , se gatilla el envío automático de formularios a todos los participantes que lo requieran según las reglas de negocio. Por defecto es false . template string No Nombre del template de correo configurado en la cuenta. Si no se envía, se usará el template activo. Si no hay uno activo, se usará el template por defecto de Regcheq. urlFormsResponse boolean No Si se establece en true , no se enviará el formulario por correo . En su lugar, se entregará una URL en la respuesta HTTP al crear la operación. Por defecto es false . Requiere que sendForms sea true . Consideraciones importantes: Antes de gatillar el envio automatico de formularios, asegurate de que los participantes tengan como valor en el campo email dentro de la ficha, un correo electronico valido. options es un campo opcional. Si sendForms = false (valor por defecto), no se envía ningún formulario , incluso si existen diligencias pendientes según las reglas de negocio. Si no se envía template , el sistema usará el template activo en la cuenta. Si no hay ninguno activo, se aplicará el template base de Regcheq. Si urlFormsResponse = true , entonces sendForms debe estar en true. De lo contrario, el sistema ignorará urlFormsResponse . Cuando urlFormsResponse = true , la URL del formulario se entrega dentro de la respuesta 200 OK del endpoint de creación de operación.
    • [transporter](https://app.theneo.io/regcheq/external-api/operaciones/crear-operacion-3/transporter.md): El objeto transporter permite registrar a la persona que físicamente transporta el dinero en efectivo involucrado en la operación, mejor conocida como Sujeto Conductor . Es útil en escenarios donde se requiere identificar claramente al portador del efectivo, ya sea para fines regulatorios o de trazabilidad interna. Este campo solo se recomienda utilizar cuando la operación incluya monto en efectivo ( efective > 0 ) ¿Quien es el transporter? Puede ser un participante de la operación , que actúa en nombre propio o de su empresa. También puede ser un tercero (por ejemplo, un funcionario de una empresa) que actúa como representante físico en la entrega del efectivo. Su incluisión permite dejar constancia explícita de quién llevó el dinero presencialmente , una práctica importante en el cumplimiento normativo. Estructura general: JSON "transporter": { "transportDni": "176145870", "transportName": "PEDRO", "transportFatherName": "PEREZ", "transportMotherName": "PEREIRA", "nationality": "Chile" } Descripción de campos: Campo Tipo Obligatoriedad Descripción transportDni string No Documento de identidad del transportador. Debe ser un documento nacional de identidad para la cuenta. transportName string No Nombre o nombres del transportador. transportFatherName string No Apellido paterno. transportMotherName string No Apellido materno. nationality string No Nacionalidad del transportador. Debe coincidir con un país del diccionario de países configurado. Consideraciones: El objeto transporter es completamente opcional . Si no hay monto en efectivo ( efective = 0 ), no es necesario incluirlo. La validación de transportDni se realiza con las mismas reglas que los dni usados en otros campos. El valor de nationality debe coincidir con un país valido. Puedes revisar el Diccionario de países. Este campo no reemplaza a personsRelations . Si el transporter también cumple funciones formales (ej: representante legal), se debe registrar como tal.
  • [Consultar operación](https://app.theneo.io/regcheq/external-api/operaciones/consultar-operacion-1.md): Método: GET URL: https://external-api.regcheq.com/operation/{idOperacion}/{API_KEY} Permite obtener la información completa de una operación previamente creada, utilizando el id de la operación como identificador único. Este id se entrega en la raíz del objeto de respuesta al momento de crear una operación. Consideraciones: Incluye toda la información de los participantes asociados (personas naturales y/o jurídicas), incuyendo sus montos, datos de ficha y personas relacionadas. Se incluye el estado actual de los formularios generados por la operación. Si estos han sido firmados, se incluye una URL para descargar el documento firmado . El riesgo calculado para cada asociado, así como la información de listas, también viene incluida en la respuesta de cada asociado. Se entregan detalles de coincidencias encontradas durante la búsqueda de listas. Respuestas posibles Operación encontrada Si el idOperacion existe y pertenece a la cuenta asociada al API_KEY , se devuelve un objeto completo con toda la información de la operación almacenada. Esto incluye: Participantes y sus montos Datos generales y personales de cada ficha Estados de formularios Riesgo individual de cada participante Detalle de coincidencias encontradas Operación no encontrada Si el idOperacion no existe o no pertenece a la cuenta asociada al API_KEY , el sistema devolverá una respuesta de error ( statusCode: 401 ) indicando que no esta autorizado a acceder esa información. Recomendaciones Asegurate de conservar y tulizar correctamente el idOperacion retornado al momento de crear la operación. La información de las operaciones esta aislada por cliente . El idOperacion debe ser enviado sin espacios ni caracteres especiales .
• [Listas y riesgo](https://app.theneo.io/regcheq/external-api/listas.md): Si quieres saber más sobre las listas disponibles, comunicate con tu CX a cargo. Advertencia: El campo risk de cada lista solo tiene validez cuando el campo coincidence es true . En caso contrario, el valor mostrado en risk no debe considerarse para la evaluación del riesgo. Por lo tanto, siempre es necesario validar primero que coincidence sea true antes de interpretar el nivel de riesgo asociado.
• [Lista de Interés](https://app.theneo.io/regcheq/external-api/lista-de-interes.md): La Lista de Interés es una funcionalidad que permite gestionar registros relevantes para una empresa, como personas o entidades, asegurando un control eficiente mediante la validación con una API Key . Este módulo implementa un CRUD (Crear, Leer, Actualizar y Eliminar) sobre los registros dentro de la lista de interés. Endpoints disponibles Title Description Método Endpoint Descripción GET https://external-api.regcheq.com/interest-list/{{api-key}} Recupera todos los registros actuales de la lista de interés. GET https://external-api.regcheq.com/interest-list/{{id-interest-list}}/{{api-key}} Recupera la información de un registro específico usando su ID. POST https://external-api.regcheq.com/interest-list/{{api-key}} Crea un nuevo registro en la lista de interés, y actualiza un registro existente utilizando el parametro “dni” como base de referencia para saber si crear o actualizar. Nota: Todos los endpoints requieren la inclusión de la {{api-key}} para autenticar las solicitudes. Crear o actualizar un registro Permite agregar una persona o entidad a la lista de interés de la empresa, o actualizar una persona o entidad ya creada en la cuenta. Para poder identificar si la petición debe crear o actualizar un registro dentro de la lista de interés, el sistema utiliza el valor del parametro dni para saber que acción realizar. Si no existe un registro con el valor que se está enviando en la petición, el sistema creará un registro. Si el valor existe dentro de la lista de interés, el sistema actualizará el registro con el valor de dni enviado. Endpoint: POST https://external-api.regcheq.com/interest-list/{{api-key}} Propiedad Descripción Obligatoriedad Tipo de dato dni Digito nacional de identificación de la persona que se este registrando o actualizando Si String name Nombre completo o razón social de la persona que se este registrando o actualizando Si String personType Tipo de persona para identificar si es una persona o entidad el registro que se está enviando en la petición Si String. Valores permitidos: natural legal reason Razón por la que se esta agregando la persona o entidad dentro de la lista de interés Si String status Estado para activar o eliminar un registro de la lista de interés. En caso de no enviar esta propiedad, el valor por defecto será active No String. Valores permitidos: active inactive Body ejemplo: JSON { "dni": "765319471", "name": "Empresa SA", "reason": "Estafa: Acusado", "personType": "legal", "status": "inactive" } Respuesta ejemplo: JSON { "companyId": "62df497c774c00cbefa6f695", "id": "67599f44e09aa1dce52425c7", "dni": "765319471", "name": "Empresa SA", "reason": "Estafa: Acusado", "status": "active", "created_at": "2024-12-11T14:18:44.442Z" } Errores : DNI inválido (422): JSON { "error": { "statusCode": 422, "message": "Person DNI is invalid" } } Solicitar información de un registro Recupera los datos completos de un registro en la lista usando su ID. Endpoint: GET https://external-api.regcheq.com/interest-list/{{id-interest-list}}/{{api-key}} Ejemplo de respuesta exitosa (200): JSON { "companyId": "62df497c774c00cbefa6f695", "id": "62ea2ae38ffddfaabce9584", "dni": "765319471", "name": "Pedro Pérez", "reason": "Estafa: Acusado", "status": "active", "created_at": "2022-08-03T07:59:31.061Z" } Errores: Registro no encontrado (404): JSON { "error": { "statusCode": 404, "message": "Registro no encontrado" } } Consultar todos los registros Recupera todos los registros de la lista de interés de la empresa como un array de objetos, donde cada objeto corresponde a un registro. Endpoint: GET https://external-api.regcheq.com/interest-list/{{api-key}} Ejemplo de respuesta: JSON [ { "companyId": "62df497c774c00cbefa6f695", "id": "64d5a16eff032d78c4183865", "dni": "141245562", "name": "Pedro Pérez", "reason": "Estafa: Acusado", "status": "active", "created_at": "2023-08-11T02:48:14.265Z" } ]
• [Diccionarios](https://app.theneo.io/regcheq/external-api/diccionarios.md): En esta sección se listan los diccionarios de valores aceptados por distintos campos dependiendo de la naturaleza del dato.
  • [Países](https://app.theneo.io/regcheq/external-api/diccionarios/paises.md): Campos asociados: nationality y country Documento con valores: https://images-clientes.s3.us-west-2.amazonaws.com/paises.xlsx Los nombre de los países no son sensible a mayusculas y minuscula, por lo que se pueden enviar en distintas combinaciones. Ejemplo : Chile puede ser enviado como CHILE o chile. Los nombres de los países son sensibles a caracteres especiales, también conocidos como caracteres con signos diacríticos. Entre estos se encuentran las letras con tílde, diéresis, cedilla, acentos o virgulilla.
  • [Tipos de transacción](https://app.theneo.io/regcheq/external-api/diccionarios/tipos-de-transaccion.md): Campos asociados: transactionType Documento con valores: https://images-clientes.s3.us-west-2.amazonaws.com/transactionType.xlsx Los tipos de transacción son sensible a mayusculas y minuscula. Asegurate de enviar el dato con el valor correcto del diccionario.