Regcheq

Autenticación

Ficha

Crear/actualizar ficha

Consultar ficha

Errores

Operación

Crear operación

Consultar operación

Listas y riesgo

Listas

Riesgo

Lista de Interés

Diccionarios

Países

Tipos de transacción

Default

External API Chile

Production

Sanbox

<p class="slate-p " >Para consumir los servicios de esta API, cada cliente debe contar un con una <code class="slate-code">API_KEY</code> única que habilita el acceso a los distintos endpoints disponibles.</p><p class="slate-p " >Cada solicitud debe apuntar a la siguiente estructura URL:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">HTTP</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-http keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">https://external-api.regcheq.com/{endpoint}/{API_Key}</div></div></code></pre></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">{endpoint}</code> puede ser: <code class="slate-code">record</code>, <code class="slate-code">operation</code> o <code class="slate-code">interest-list</code>.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">{API_KEY}</code> es la clave única que identifica al cliente y autoriza la solicitud.</div></li></ul><h2 class="slate-h2 " >Método de solicitud</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">El método HTTP dependerá del tipo de operación (<code class="slate-code">POST</code>, <code class="slate-code">GET</code>, <code class="slate-code">PATCH</code>, etc.), y está especificado en cada endpoint</div></li><li class="slate-li " ><div style="position:relative">En todos los casos, la <code class="slate-code">API_KEY</code> debe incluirse como parte del path en la URL.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Ejemplo de solicitud</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Método: <code class="slate-code">POST</code> (creación o actualización de una ficha)</div></li><li class="slate-li " ><div style="position:relative">Endpoint: Ficha (<code class="slate-code">/record</code>)</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">API_KEY</code>: <code class="slate-code">abc123xyz456</code></div></li></ul><p class="slate-p " >Método y URL de solicitud:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">HTTP</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-http keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">POST https://external-api.regcheq.com/record/abc123xyz456</div></div></code></pre></div><p class="slate-p " >Body (<code class="slate-code">JSON</code>):</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;dni&quot;: &quot;none&quot;,
  &quot;personType&quot;: &quot;natural&quot;,
  &quot;name&quot;: &quot;JUAN ANDRÉS&quot;,
  &quot;fatherName&quot;: &quot;PEREZ&quot;,
  &quot;motherName&quot;: &quot;PEREIRA&quot;
}</div></div></code></pre></div><p class="slate-p " >Notas:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">dni</code> puede ser <code class="slate-code">“none”</code> si no se cuenta con ese dato en el momento o la persona no tiene un número de identificación válido.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">personType</code> debe ser <code class="slate-code">“natural”</code> o <code class="slate-code">“legal”</code>, dependiendo del tipo de registro ingresado (persona natural o empresa).</div></li><li class="slate-li " ><div style="position:relative">Este ejemplo crea una ficha básica de persona natural sin número de identificación con nombre completo: <code class="slate-code">JUAN ANDRÉS PEREZ PEREIRA</code>.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Para consumir los servicios de esta API, cada cliente debe contar un con una 

 única que habilita el acceso a los distintos endpoints disponibles.

Cada solicitud debe apuntar a la siguiente estructura URL:

JUAN ANDRÉS

<p class="slate-p " >La sección de <strong class="slate-bold">Ficha</strong> 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.</p><h2 class="slate-h2 " >Endpoints disponibles</h2><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Método</div><div style="width:100px;">URL</div><div style="width:100px;">Descripción</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">POST</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/record/{API_KEY}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Crear o actualizar una ficha</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">GET</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/record/{dni}/{API_KEY}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Consultar ficha utlizando el <code class="slate-code">dni</code> como parametro de busqueda</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

 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.

Método

Descripción

<p class="slate-p " >El módulo <strong class="slate-bold">Operación</strong> 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.</p><p class="slate-p " >Endpoints disponibles</p><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Método</div><div style="width:100px;">URL</div><div style="width:100px;">Descripción</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">POST</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/operation/{API_KEY}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Crea una nueva operación</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">GET</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/operation/{operationId}/{API_KEY}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Consulta una operación existente utilizando el <code class="slate-code">operationId</code> como parametro de busqueda</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

 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.

operations

Campos mínimos de una operación

transactions

options

transporter

Ejemplo todos los componentes

<ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Método: POST</div></li><li class="slate-li " ><div style="position:relative">URL: <code class="slate-code">https://external-api.regcheq.com/operation/{API_KEY}</code></div></li></ul><p class="slate-p " >Permite registrar una nueva operación en el sistema.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><span style="background-color:rgb(237, 242, 251);color:rgb(36, 44, 64)"><strong class="slate-bold">Consideraciones</strong></span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Participantes</strong>: Una operación puede incluir entre 1 y 5 participantes, los cuales se agregan en el array <code class="slate-code">operations</code> como distintos objetos anidados.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Información general de cada participante (</strong><code class="slate-code"><strong class="slate-bold">ficha</strong></code><strong class="slate-bold">)</strong>: 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.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Información propia de la operación</strong>: 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.</div></li></ul><p class="slate-p " >llamado <code class="slate-code">transactions</code> para incluir información adicional sobre la operación.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Sujeto Conductor</strong>: Si hay dinero en efectivo vinculado a la operación, se puede añadir información del sujeto conductor en un objeto opcional llamado <code class="slate-code">transporter</code>.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Envío de Formularios</strong>: Para activar el envío de formularios, se debe agregar un objeto opcional llamado <code class="slate-code">options</code>, </div></li></ul><p class="slate-p " >el cual configura el envío y permite añadir un perfil para el correo del formulario enviado.</p></div></div><h2 class="slate-h2 " >Campos mínimos requeridos</h2><p class="slate-p " ></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Campo</div><div style="width:100px;">Tipo</div><div style="width:100px;">Descripción</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >dni</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Número de identificación válido para la cuenta</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">“natural”</code> o <code class="slate-code">“legal”</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >monto</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Monto total de la operación en base al tipo de moneda. Puede incluir decimales.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >efective</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Monto en efectivo de la operación en base al tipo de moneda. Puede incluir decimales.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >currency</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tipo de moneda usado en la operación: <code class="slate-code">“$”</code> para peso chileno, <code class="slate-code">“USD”</code> para dólar y <code class="slate-code">“UF”</code>para unidad de fomento chilena.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ficha</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Objeto</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Objeto <code class="slate-code">“ficha”</code>. Puede ir vacío. Dentro de este objeto se listan todos los datos generales del participante.</p></td></div></tr></tbody></table></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >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.</p></div></div><p class="slate-p " >A continuación, en distintas páginas de la sub sección <strong class="slate-bold">Crear operación</strong>, se detalla cada uno de los componentes disponibles en este endpoint.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Permite registrar una nueva operación en el sistema.

Campo

Tipo

A continuación, en distintas páginas de la sub sección 

, se detalla cada uno de los componentes disponibles en este endpoint.

Operación persona natural

Operación persona legal

Operación legal con persona relacionada

Multiplés participantes

 involucrado en la operación. Puede tratarse de una persona natural o jurídica.

Obligatoriedad

 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

 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.

 es un array de objetos opcional para los participantes de 

, una vez que se agrega, es obligatorio ingresar como mínimo:

Parametros asociados a cada objeto dentro de 

Campos

 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:

Estructura general para múltiples participantes:

Operación con transactions

Operación con transactions 2

Operación con transactions 3

<p class="slate-p " >El componente <code class="slate-code">transactions</code> es un objeto dentro del objeto general de la operación, que contiene información <strong class="slate-bold">complementaria y contextual </strong>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.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >Si decides enviar el objeto <code class="slate-code">transactions</code>, el campo <code class="slate-code">transactionDate</code> se vuelve obligatorio.</p></div></div><p class="slate-p " ><strong class="slate-bold">Estructura general:</strong></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&quot;transactions&quot;: {
   &quot;referenceNumber&quot;: &quot;A123456789&quot;,
   &quot;transactionComments&quot;: &quot;ASD123&quot;,
   &quot;transactionType&quot;: &quot;Automotora&quot;,
   &quot;transactionDate&quot;: &quot;2024-02-14&quot;,
   &quot;tagOperation&quot;: [&quot;Online&quot;]
}</div></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Descripción de campos:</strong></p><p class="slate-p " ></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:206px;">Campo</div><div style="width:167px;">Tipo</div><div style="width:146px;">Obligatoriedad</div><div style="width:0px;">Descripción</div></div><colgroup ><col style="width:206px"><col style="width:167px"><col style="width:146px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">referenceNumber</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Número de referencia único del negocio del cliente. Puede ser usado para correlacionar con sistemas internos.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transactionComments</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Comentarios adicionales sobre la operación. Útil para dejar observaciones como estados, roles o antecedentes relevantes.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transactionType</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tipo de transacción. Este campo debe coincidir con alguno de los valores definidos en el Diccionario de Tipos de Transacción.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transactionDate</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Condicional</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Obligatorio <strong class="slate-bold">solo si se envía </strong><code class="slate-code"><strong class="slate-bold">transactions</strong></code>. Fecha de la operación en formato <code class="slate-code">YYYY-MM-DD</code>. Se recomienda usar la fecha actual si no se conoce la real.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">tagOperation</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >array de strings</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Etiquetas de la operación. Deben estar previamente configuradas en la cuenta del cliente.</p></td></div></tr></tbody></table></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Consideraciones importantes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">El objeto <code class="slate-code">transactions</code> es opcional, pero si lo incluyes, transactionDate es <strong class="slate-bold">obligatorio</strong>.</div></li><li class="slate-li " ><div style="position:relative">Si no conoces la fecha exacta de la transacción, usa la fecha del día en que se crea la operación.</div></li><li class="slate-li " ><div style="position:relative">Las <code class="slate-code">tagOperation</code> funcionan igual que las <code class="slate-code">tagFile</code> de la ficha: deben estar configuradas previamente en la cuenta, ya que la validación se hace contra estos valores.</div></li><li class="slate-li " ><div style="position:relative">Para la correcta visualización dentro de la plataforma, el valor de <code class="slate-code">transactionType</code> debe ser uno de los listados en el diccionario de Tipos de transacción.</div></li></ul></div></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

 es un objeto dentro del objeto general de la operación, que contiene información 

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.

Envio formularios

Ejemplo formularios 2 

Ejemplo formularios 3

<p class="slate-p " >El objeto <code class="slate-code">options</code> permite configurar el <strong class="slate-bold">comportamiento de las diligencias o formularios</strong> que pueden ser requeriso según las reglas de negocio asociadas a la cuenta del cliente.</p><p class="slate-p " >Este componente es útil para gatillar automaticamente los formularios requeridos por regulación o por flujos internos definidos en la plataforma Regcheq.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Este objeto es completamente <strong class="slate-bold">opcional</strong>. Si no se incluye, no se gatilla niguna diligencia y se utilizará la configuración por defecto de la cuenta.</div></li><li class="slate-li " ><div style="position:relative">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 <code class="slate-code">email</code></div></li></ul></div></div><p class="slate-p " ><strong class="slate-bold">Estructura general:</strong></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&quot;options&quot;: {
   &quot;sendForms&quot;: true,
   &quot;template&quot;: &quot;Perfil 1&quot;,
   &quot;urlFormsResponse&quot;: false
}</div></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Descripción de campos:</strong></p><p class="slate-p " ></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:196px;">Campo</div><div style="width:95px;">Tipo</div><div style="width:122px;">Obligatoriedad</div><div style="width:440px;">Descripción</div></div><colgroup ><col style="width:196px"><col style="width:95px"><col style="width:122px"><col style="width:440px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">sendForms</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >boolean</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Si se establece en <code class="slate-code">true</code>, 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 <code class="slate-code">false</code>.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">template</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >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.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">urlFormsResponse</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >boolean</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Si se establece en <code class="slate-code">true</code>, <strong class="slate-bold">no se enviará el formulario por correo</strong>. En su lugar, se entregará una URL en la respuesta HTTP al crear la operación. Por defecto es <code class="slate-code">false</code>. <strong class="slate-bold">Requiere que</strong> sendForms sea <code class="slate-code">true</code>.</p></td></div></tr></tbody></table></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Consideraciones importantes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Antes de gatillar el envio automatico de formularios, asegurate de que los participantes tengan como valor en el campo <code class="slate-code">email</code> dentro de la ficha, un correo electronico valido.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">options</code> es un campo opcional.</div></li><li class="slate-li " ><div style="position:relative">Si <code class="slate-code">sendForms = false</code> (valor por defecto), <strong class="slate-bold">no se envía ningún formulario</strong>, incluso si existen diligencias pendientes según las reglas de negocio.</div></li><li class="slate-li " ><div style="position:relative">Si no se envía <code class="slate-code">template</code>, el sistema usará el template activo en la cuenta. Si no hay ninguno activo, se aplicará el template base de Regcheq.</div></li><li class="slate-li " ><div style="position:relative">Si <code class="slate-code">urlFormsResponse = true</code>, entonces <code class="slate-code">sendForms</code><strong class="slate-bold"> debe estar en</strong> <code class="slate-code">true.</code> De lo contrario, el sistema ignorará <code class="slate-code">urlFormsResponse</code>.</div></li><li class="slate-li " ><div style="position:relative">Cuando <code class="slate-code">urlFormsResponse = true</code>, la URL del formulario se entrega dentro de la respuesta <code class="slate-code">200 OK</code> del endpoint de creación de operación.</div></li></ul></div></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p>

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.

Sujeto conductor

<p class="slate-p " >El objeto <strong class="slate-bold">transporter</strong> permite registrar a la persona que físicamente transporta el dinero en efectivo involucrado en la operación, mejor conocida como <strong class="slate-bold">Sujeto Conductor</strong>. Es útil en escenarios donde se requiere identificar claramente al portador del efectivo, ya sea para fines regulatorios o de trazabilidad interna.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Este campo <strong class="slate-bold">solo se recomienda</strong> utilizar cuando la operación incluya <strong class="slate-bold">monto en efectivo </strong>(<code class="slate-code">efective &gt; 0</code>)</p></div></div><p class="slate-p " ><strong class="slate-bold">¿Quien es el transporter?</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Puede ser <strong class="slate-bold">un participante de la operación</strong>, que actúa en nombre propio o de su empresa.</div></li><li class="slate-li " ><div style="position:relative">También puede ser <strong class="slate-bold">un tercero</strong> (por ejemplo, un funcionario de una empresa) que actúa como <strong class="slate-bold">representante físico</strong> en la entrega del efectivo.</div></li><li class="slate-li " ><div style="position:relative">Su incluisión permite dejar constancia explícita de <strong class="slate-bold">quién llevó el dinero presencialmente</strong>, una práctica importante en el cumplimiento normativo.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Estructura general:</strong></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&quot;transporter&quot;: {
   &quot;transportDni&quot;: &quot;176145870&quot;,
   &quot;transportName&quot;: &quot;PEDRO&quot;,
   &quot;transportFatherName&quot;: &quot;PEREZ&quot;,
   &quot;transportMotherName&quot;: &quot;PEREIRA&quot;,
   &quot;nationality&quot;: &quot;Chile&quot;
}</div></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Descripción de campos:</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:205px;">Campo</div><div style="width:130px;">Tipo</div><div style="width:158px;">Obligatoriedad</div><div style="width:0px;">Descripción</div></div><colgroup ><col style="width:205px"><col style="width:130px"><col style="width:158px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transportDni</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Documento de identidad del transportador. Debe ser un documento nacional de identidad para la cuenta.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transportName</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Nombre o nombres del transportador.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transportFatherName</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Apellido paterno.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">transportMotherName</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Apellido materno.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">nationality</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >string</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Nacionalidad del transportador. Debe coincidir con un país del diccionario de países configurado.</p></td></div></tr></tbody></table></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Consideraciones:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">El objeto <code class="slate-code">transporter</code> es <strong class="slate-bold">completamente opcional</strong>.</div></li><li class="slate-li " ><div style="position:relative">Si no hay monto en efectivo (<code class="slate-code">efective = 0</code>), no es necesario incluirlo.</div></li><li class="slate-li " ><div style="position:relative">La validación de <code class="slate-code">transportDni</code> se realiza con las mismas reglas que los <code class="slate-code">dni</code> usados en otros campos.</div></li><li class="slate-li " ><div style="position:relative">El valor de <code class="slate-code">nationality</code> debe coincidir con un país valido. Puedes revisar el Diccionario de países.</div></li><li class="slate-li " ><div style="position:relative">Este campo no reemplaza a <code class="slate-code">personsRelations</code>. Si el transporter también cumple funciones formales (ej: representante legal), se debe registrar como tal.</div></li></ul></div></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

 permite registrar a la persona que físicamente transporta el dinero en efectivo involucrado en la operación, mejor conocida como 

. Es útil en escenarios donde se requiere identificar claramente al portador del efectivo, ya sea para fines regulatorios o de trazabilidad interna.

status

asociados

codigo

totalAmount

totalEfective

amountFormated

companyId

created_by

deleted_by

updated_by

leido

referenceNumber

operation

requiredFile

fileStatus

signatures

generalFormStatus

deleted_at

created_at

updated_at

personsRUTS

personsPepablesRUTS

efectivo

divisa

transactionComments

transactionType

transactionDate

hasPep

finished

asociadosQuery

valorDolar

valorUF

Consulta exitosa

error

UnauthorizedError

Consulta fallida

<ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Método: <code class="slate-code">GET</code></div></li><li class="slate-li " ><div style="position:relative">URL: <code class="slate-code">https://external-api.regcheq.com/operation/{idOperacion}/{API_KEY}</code></div></li></ul><p class="slate-p " >Permite obtener la información completa de una operación previamente creada, utilizando el <code class="slate-code">id</code> de la operación como identificador único. Este <code class="slate-code">id</code> se entrega en la raíz del objeto de respuesta al momento de crear una operación.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Consideraciones:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Incluye toda la información de los participantes asociados (personas naturales y/o jurídicas), incuyendo sus montos, datos de ficha y personas relacionadas.</div></li><li class="slate-li " ><div style="position:relative">Se incluye el estado actual de los formularios generados por la operación. Si estos han sido firmados, se incluye una <strong class="slate-bold">URL para descargar el documento firmado</strong>.</div></li><li class="slate-li " ><div style="position:relative">El riesgo calculado para cada asociado, así como la información de listas, también viene incluida en la respuesta de cada asociado.</div></li><li class="slate-li " ><div style="position:relative">Se entregan detalles de coincidencias encontradas durante la búsqueda de listas.</div></li></ul></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Respuestas posibles</h2><h3 class="slate-h3 " >Operación encontrada</h3><p class="slate-p " >Si el <code class="slate-code">idOperacion</code> existe y pertenece a la cuenta asociada al <code class="slate-code">API_KEY</code>, se devuelve un objeto completo con toda la información de la operación almacenada. Esto incluye:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Participantes y sus montos</div></li><li class="slate-li " ><div style="position:relative">Datos generales y personales de cada ficha</div></li><li class="slate-li " ><div style="position:relative">Estados de formularios</div></li><li class="slate-li " ><div style="position:relative">Riesgo individual de cada participante</div></li><li class="slate-li " ><div style="position:relative">Detalle de coincidencias encontradas</div></li></ul><h3 class="slate-h3 " >Operación no encontrada</h3><p class="slate-p " >Si el <code class="slate-code">idOperacion</code> no existe o no pertenece a la cuenta asociada al <code class="slate-code">API_KEY</code>, el sistema devolverá una respuesta de error (<code class="slate-code">statusCode: 401</code>) indicando que no esta autorizado a acceder esa información.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Recomendaciones</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Asegurate de conservar y tulizar correctamente el <code class="slate-code">idOperacion</code> retornado al momento de crear la operación.</div></li><li class="slate-li " ><div style="position:relative">La información de las operaciones esta <strong class="slate-bold">aislada por cliente</strong>.</div></li><li class="slate-li " ><div style="position:relative">El <code class="slate-code">idOperacion</code> debe ser enviado <strong class="slate-bold">sin espacios ni caracteres especiales</strong>.</div></li></ul><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Permite obtener la información completa de una operación previamente creada, utilizando el 

 de la operación como identificador único. Este 

 se entrega en la raíz del objeto de respuesta al momento de crear una operación.

 existe y pertenece a la cuenta asociada al 

, se devuelve un objeto completo con toda la información de la operación almacenada. Esto incluye:

 no existe o no pertenece a la cuenta asociada al 

, el sistema devolverá una respuesta de error (

) indicando que no esta autorizado a acceder esa información.

Ejemplo 1 listas

<p class="slate-p " ></p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Si quieres saber más sobre las listas disponibles, comunicate con tu CX a cargo.</p></div></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Advertencia:</strong> El campo <code class="slate-code"><strong class="slate-bold">risk</strong></code> de cada lista solo tiene validez cuando el campo <code class="slate-code">coincidence</code> es <code class="slate-code">true</code>. En caso contrario, el valor mostrado en <code class="slate-code"><strong class="slate-bold">risk</strong></code> no debe considerarse para la evaluación del riesgo. Por lo tanto, siempre es necesario validar primero que <code class="slate-code">coincidence</code> sea <code class="slate-code">true</code> antes de interpretar el nivel de riesgo asociado.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >La <strong class="slate-bold">Lista de Interés</strong> 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 <strong class="slate-bold">API Key</strong>. Este módulo implementa un CRUD (Crear, Leer, Actualizar y Eliminar) sobre los registros dentro de la lista de interés.</p></p><h2 class="slate-h2 " ><strong class="slate-bold">Endpoints disponibles</strong></h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:100px"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Método</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Endpoint</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Descripción</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code"><strong class="slate-bold">GET</strong></code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/interest-list/{{api-key}}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">Recupera todos los registros actuales de la lista de interés.</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code"><strong class="slate-bold">GET</strong></code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/interest-list/{{id-interest-list}}/{{api-key}}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">Recupera la información de un registro específico usando su ID.</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code"><strong class="slate-bold">POST</strong></code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://external-api.regcheq.com/interest-list/{{api-key}}</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">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.</code></p></td></div></tr></tbody></table></div><p class="slate-p " ><strong class="slate-bold">Nota:</strong> Todos los endpoints requieren la inclusión de la {{api-key}} para autenticar las solicitudes.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Crear o actualizar un registro</h2><p class="slate-p " >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.</p><p class="slate-p " >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 <code class="slate-code">dni</code> 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 <code class="slate-code">dni</code> enviado.</p><p class="slate-p " ><strong class="slate-bold">Endpoint:</strong></p><p class="slate-p " ><strong class="slate-bold">POST </strong><code class="slate-code">https://external-api.regcheq.com/interest-list/{{api-key}}</code></p><p class="slate-p " ></p><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:0px;">Propiedad</div><div style="width:0px;">Descripción</div><div style="width:374px;">Obligatoriedad</div><div style="width:0px;">Tipo de dato</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:374px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >dni</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Digito nacional de identificación de la persona que se este registrando o actualizando</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Si</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Nombre completo o razón social de la persona que se este registrando o actualizando</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Si</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >personType</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tipo de persona para identificar si es una persona o entidad el registro que se está enviando en la petición</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Si</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String. Valores permitidos: </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">natural  </code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">legal</code></div></li></ul></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >reason</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Razón por la que se esta agregando la persona o entidad dentro de la lista de interés</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Si</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >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á <code class="slate-code">active</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >String. Valores permitidos: </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">active  </code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">inactive</code></div></li></ul></td></div></tr></tbody></table></div><p class="slate-p " ><strong class="slate-bold">Body ejemplo:</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;dni&quot;: &quot;765319471&quot;,
    &quot;name&quot;: &quot;Empresa SA&quot;,
    &quot;reason&quot;: &quot;Estafa: Acusado&quot;,
    &quot;personType&quot;: &quot;legal&quot;,
    &quot;status&quot;: &quot;inactive&quot;
}</div></div></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Respuesta ejemplo:</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;companyId&quot;: &quot;62df497c774c00cbefa6f695&quot;,
    &quot;id&quot;: &quot;67599f44e09aa1dce52425c7&quot;,
    &quot;dni&quot;: &quot;765319471&quot;,
    &quot;name&quot;: &quot;Empresa SA&quot;,
    &quot;reason&quot;: &quot;Estafa: Acusado&quot;,
    &quot;status&quot;: &quot;active&quot;,
    &quot;created_at&quot;: &quot;2024-12-11T14:18:44.442Z&quot;
}</div></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Errores :</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">DNI inválido (422):</div></li></ul><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;error&quot;: {
        &quot;statusCode&quot;: 422,
        &quot;message&quot;: &quot;Person DNI is invalid&quot;
    }
}</div></div></code></pre></div><p class="slate-p " ></p><h2 class="slate-h2 " >Solicitar información de un registro</h2><p class="slate-p " >Recupera los datos completos de un registro en la lista usando su ID.</p><p class="slate-p " ><strong class="slate-bold">Endpoint:</strong></p><p class="slate-p " ><strong class="slate-bold">GET </strong><code class="slate-code">https://external-api.regcheq.com/interest-list/{{id-interest-list}}/{{api-key}}</code></p><p class="slate-p " ><strong class="slate-bold">Ejemplo de respuesta exitosa (200):</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;companyId&quot;: &quot;62df497c774c00cbefa6f695&quot;,
    &quot;id&quot;: &quot;62ea2ae38ffddfaabce9584&quot;,
    &quot;dni&quot;: &quot;765319471&quot;,
    &quot;name&quot;: &quot;Pedro Pérez&quot;,
    &quot;reason&quot;: &quot;Estafa: Acusado&quot;,
    &quot;status&quot;: &quot;active&quot;,
    &quot;created_at&quot;: &quot;2022-08-03T07:59:31.061Z&quot;
}</div></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Errores:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Registro no encontrado (404):</div></li></ul><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;error&quot;: {
        &quot;statusCode&quot;: 404,
        &quot;message&quot;: &quot;Registro no encontrado&quot;
    }
}
</div></div></code></pre></div><p class="slate-p " ></p><h2 class="slate-h2 " >Consultar todos los registros</h2><p class="slate-p " >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.</p><p class="slate-p " ><strong class="slate-bold">Endpoint:</strong>
<strong class="slate-bold">GET </strong><code class="slate-code">https://external-api.regcheq.com/interest-list/{{api-key}}</code></p><p class="slate-p " ><strong class="slate-bold">Ejemplo de respuesta:</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">[
    {
        &quot;companyId&quot;: &quot;62df497c774c00cbefa6f695&quot;,
        &quot;id&quot;: &quot;64d5a16eff032d78c4183865&quot;,
        &quot;dni&quot;: &quot;141245562&quot;,
        &quot;name&quot;: &quot;Pedro Pérez&quot;,
        &quot;reason&quot;: &quot;Estafa: Acusado&quot;,
        &quot;status&quot;: &quot;active&quot;,
        &quot;created_at&quot;: &quot;2023-08-11T02:48:14.265Z&quot;
    }
]
</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Title

Description

 Todos los endpoints requieren la inclusión de la {{api-key}} para autenticar las solicitudes.

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 

 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 

https://external-api.regcheq.com/interest-list/{{api-key}}

Propiedad

Tipo de dato

Empresa SA

Recupera los datos completos de un registro en la lista usando su ID.

https://external-api.regcheq.com/interest-list/{{id-interest-list}}/{{api-key}}

Pedro Pérez

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.

<p class="slate-p " >En esta sección se listan los diccionarios de valores aceptados por distintos campos dependiendo de la naturaleza del dato.</p><p class="slate-p " ></p>

En esta sección se listan los diccionarios de valores aceptados por distintos campos dependiendo de la naturaleza del dato.

Sections