> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Información de integración

> Aprenda a configurar la integración con sus sistemas, incluyendo API keys, webhooks, return URLs, skip result page y dynamic fields.

La configuración de información de integración permite la integración de datos en tiempo real con los sistemas del cliente. Puede construir una integración fluida con sistemas de negocio mediante gestión de API keys, configuración de webhooks, configuración de return URL, configuración de dynamic fields, etc.

<Frame caption="Página de configuración de información de integración">
  <img src="https://mintcdn.com/argosidentity/SCyJH7SnZdUydn0h/images/dashboard/new/pj/project-setting/integration-info/main_en.png?fit=max&auto=format&n=SCyJH7SnZdUydn0h&q=85&s=47178fa8acb7333b5d7d77b00c2e448c" alt="Configuración de información de integración" width="1864" height="712" data-path="images/dashboard/new/pj/project-setting/integration-info/main_en.png" />
</Frame>

***

## API Key

Puede consultar y gestionar la API key del proyecto.

<Frame caption="Configuración de API Key">
  <img src="https://mintcdn.com/argosidentity/SCyJH7SnZdUydn0h/images/dashboard/new/pj/project-setting/integration-info/api_key_en.png?fit=max&auto=format&n=SCyJH7SnZdUydn0h&q=85&s=85b93d3bade789145f212743312c4a95" alt="Configuración de API key" width="1864" height="133" data-path="images/dashboard/new/pj/project-setting/integration-info/api_key_en.png" />
</Frame>

La API key es una clave única utilizada para autenticación al llamar a la ARGOS ID Check API. Debe incluirse en el header `x-api-key` en todas las solicitudes API.

<Warning>
  **Seguridad de la API Key**

  Tenga cuidado de no exponer las API keys externamente. Si una API key se filtra, se pueden acceder a todos los datos del proyecto, por lo que debe gestionarse de forma segura.
</Warning>

<Info>
  **Uso de la API Key**

  Puede usar diversas funciones API como consulta de submissions, procesamiento de aprobación/rechazo, gestión de tokens, etc. usando la API key.
</Info>

***

## Configuración de Webhook

La función Webhook permite la integración de datos en tiempo real con sistemas del cliente. Cuando ocurren eventos específicos, envía solicitudes HTTP POST al endpoint (Endpoint URL) configurado por el cliente, permitiendo notificaciones y procesamiento de datos en tiempo real sin llamadas API separadas.

<Frame caption="Configuración de Webhook">
  <img src="https://mintcdn.com/argosidentity/SCyJH7SnZdUydn0h/images/dashboard/new/pj/project-setting/integration-info/webhook-setting_en.png?fit=max&auto=format&n=SCyJH7SnZdUydn0h&q=85&s=e3c037d7c75472e9c48742ebba12938c" alt="Configuración de webhook" width="927" height="505" data-path="images/dashboard/new/pj/project-setting/integration-info/webhook-setting_en.png" />
</Frame>

### Configuración de Webhook URL

Configure la endpoint URL donde el sistema del cliente recibirá los datos del webhook.

Las solicitudes HTTP POST se envían a la URL configurada cuando ocurren eventos de webhook.

<Warning>
  **Seguridad y estabilidad del Webhook**

  Los endpoints de webhook deben usar HTTPS para asegurar la transmisión segura de datos. También se recomienda implementar mecanismos de verificación de firma para verificar la autenticidad de las solicitudes de webhook.
</Warning>

<Warning>
  **Se requiere configuración de firewall**

  La dirección IP usada por ARGOS al enviar webhooks es **52.78.194.237**. Para recibir webhooks normalmente, debe configurar el firewall para permitir solicitudes desde esta dirección IP.
</Warning>

<Info>
  **Método de configuración del firewall**

  Agregue la siguiente dirección IP a la allow list en la configuración del firewall o security group del cliente:

  * **Webhook IP**: `52.78.194.237`

  Si no se permiten las solicitudes HTTP POST desde esta dirección IP, los webhooks serán bloqueados y no podrán recibirse.
</Info>

<Note>
  **Gestión de IP y URL de Webhook**

  Las IPs fijas de webhook para cada proyecto solo pueden consultarse en esta página, y el historial de cambios de URL de webhook no se almacena, así que tenga cuidado con la gestión de URLs de webhook.
</Note>

### Gestión de usuarios de notificación

Al agregar nombres y emails mediante la gestión de usuarios de notificación, puede recibir información sobre webhooks enviados el día anterior vía email a la mañana siguiente.

**Método de configuración:**

1. Ingrese nombre y dirección de email.
2. Haga clic en el botón agregar para registrar usuarios de notificación.
3. Los usuarios registrados reciben información de webhooks enviados el día anterior vía email cada mañana.

<Info>
  **Reporte diario de Webhook**

  Un resumen de todos los eventos webhook enviados el día anterior (00:00 \~ 23:59 UTC) se envía vía email a los usuarios de notificación registrados cada mañana. Esto le permite monitorear el estado de transmisión de webhooks.
</Info>

***

## Return URL

Los usuarios son redirigidos a la URL configurada cuando se completa el KYC o **cuando acceden a una página de error**.

<Frame caption="Configuración de Return URL">
  <img src="https://mintcdn.com/argosidentity/bSOR6O7Y3jW8lg8K/images/dashboard/new/pj/project-setting/integration-info/return_url_en.png?fit=max&auto=format&n=bSOR6O7Y3jW8lg8K&q=85&s=008eb64366d5da7899b41ad14ae5fdfb" alt="Configuración de return URL" width="779" height="470" data-path="images/dashboard/new/pj/project-setting/integration-info/return_url_en.png" />
</Frame>

Cuando se completa el proceso KYC y el remitente selecciona el botón "Ok" o espera 5 segundos, es redirigido a la return URL con los parámetros de los campos dinámicos seleccionados. A partir de la actualización de 2026-04, **incluso después de acceder a una página de error** se puede redirigir a la return URL; en este caso, el parámetro `errorCode` se transmite junto con la URL para que el cliente pueda identificar el motivo del bloqueo.

**Ejemplo de Return URL (finalización normal):**

```
https://yourapp.com/verification-complete?userid=user123&email=user@example.com&kycStatus=approved&submissionId=sub_abc123&cf1=campaign_summer
```

**Ejemplo de Return URL (página de error → Return URL):**

```
https://yourapp.com/verification-complete?kycStatus=rejected&errorCode=DE-20000
```

### Cifrado de Return URL

Cuando se activa la función de cifrado de return URL, los parámetros de la return URL se cifran y entregan.

<Frame caption="Configuración de cifrado de Return URL">
  <img src="https://mintcdn.com/argosidentity/SCyJH7SnZdUydn0h/images/dashboard/new/pj/project-setting/integration-info/return_url_encryption_en.png?fit=max&auto=format&n=SCyJH7SnZdUydn0h&q=85&s=7f56bc884555347803ba4f46214ce9eb" alt="Configuración de cifrado de return URL" width="927" height="395" data-path="images/dashboard/new/pj/project-setting/integration-info/return_url_encryption_en.png" />
</Frame>

Cuando el cifrado de return URL está activado, los parámetros seleccionados en dynamic fields se cifran e incluyen en el parámetro `encrypted`.

**Ejemplo de Return URL cifrada:**

```
https://yourapp.com/verification-complete?encrypted={encrypted_data}
```

<Info>
  **Uso del cifrado de Return URL**

  Cuando usa return URLs que contienen información sensible (email, user ID, etc.), puede reforzar la seguridad activando la función de cifrado. Se usa el método AES-256-ECB para el descifrado.
</Info>

<Card title="Guía de cifrado" icon="lock" href="/es/idcheck/getting-started/encrypt-and-decrypt-data/overview#3-3-api-data-decryption-aes-256-ecb">
  Aprenda a descifrar datos de cifrado de return URL.
</Card>

<Info>
  **Uso de Return URL**

  Después de completar el KYC, los usuarios pueden ser redirigidos automáticamente a la página de servicio del cliente, proporcionando páginas de guía personalizadas según el estado de aprobación/rechazo.
</Info>

***

## Skip Result Page

Puede omitir que los usuarios vean los resultados de KYC y redirigirlos a la URL deseada.

Cuando se activa la función skip result page, se omite la página de resultados de KYC y se mueve directamente a la return URL.

**Escenarios de uso:**

* Cuando los clientes quieren proporcionar su propia página de resultados
* Cuando desea proporcionar resultados de forma flexible mediante parámetros de dynamic fields en la return URL

<Info>
  **Combinación de Skip Result Page y Dynamic Fields**

  Cuando activa la función skip result page y selecciona parámetros como `kycStatus`, `submissionId` en dynamic fields, la información del resultado KYC se incluye en la return URL. Esto permite a los clientes configurar sus propias páginas de resultados.
</Info>

***

## Campos Dinámicos

Puede seleccionar los elementos que se transmitirán como parámetros de consulta a la Return URL haciendo clic en las casillas de los Campos Dinámicos. Los valores configurados se reflejan automáticamente en la vista previa de la **Return URL final** en la parte inferior de la pantalla.

| Campo                                                                                                                                                                                                 | Clave de parámetro  | Descripción                                                                                |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------ |
| **User ID**                                                                                                                                                                                           | `userid`            | ID del usuario                                                                             |
| **Email**                                                                                                                                                                                             | `email`             | Dirección de email del usuario                                                             |
| **Submission ID**                                                                                                                                                                                     | `submissionId`      | ID de submission                                                                           |
| **Custom Field #1·#2·#3**                                                                                                                                                                             | `cf1`, `cf2`, `cf3` | Campos personalizados                                                                      |
| **KYC Result**                                                                                                                                                                                        | `kycStatus`         | Estado del resultado KYC (`approved`, `pending`, `rejected`)                               |
| **Error Code** <span style={{backgroundColor: '#EEF4FF', color: '#0064FF', padding: '2px 8px', borderRadius: '12px', fontSize: '12px', fontWeight: '600', marginLeft: '6px'}}>Nuevo en 2026-04</span> | `errorCode`         | Código de error transmitido al acceder a una página de error (ej.: `DE-20000`, `TK-10001`) |

**Vista previa de la Return URL final:**

```
https://argosidentity.com?kycStatus={kycStatus}&errorCode={errorCode}
```

<Info>
  **Uso del parámetro Error Code (`errorCode`)**

  Al marcar `Error Code` en los Campos Dinámicos, los usuarios que accedan a una página de error podrán regresar al servicio del cliente a través del botón de Return URL. En ese momento, el valor `errorCode` se incluirá en el query string de la URL, permitiendo al cliente identificar el motivo del bloqueo (ej.: fallo en Device Verification, token expirado). Consulte el documento [Códigos de error y páginas de error](/es/idcheck/reference_tables/Error-codes-and-pages) para el mapeo completo de códigos de error.
</Info>

<Warning>
  **Precauciones de Campos Dinámicos**

  Los parámetros `kycStatus` y `errorCode` siguen camelCase, por lo que las mayúsculas y minúsculas deben distinguirse con precisión. `kycStatus` devuelve uno de `approved`, `pending` o `rejected` según el resultado.
</Warning>

***

## Tipos de evento Webhook

Los principales tipos de evento enviados vía webhook son los siguientes:

| Evento          | Descripción                                               |
| --------------- | --------------------------------------------------------- |
| **approved**    | Ocurre cuando la autenticación KYC es aprobada            |
| **rejected**    | Ocurre cuando la autenticación KYC es rechazada           |
| **pending**     | Ocurre cuando el estado cambia a requerir revisión manual |
| **retry**       | Ocurre cuando hay un reintento                            |
| **updated**     | Ocurre cuando se actualiza la información del submission  |
| **delete**      | Ocurre cuando se elimina un submission                    |
| **submit**      | Ocurre cuando se completa un nuevo submission             |
| **token**       | Cuando ocurren eventos relacionados con token             |
| **injection**   | Cuando ocurre inyección de datos                          |
| **aml**         | Cuando ocurren resultados de comprobación AML             |
| **aml-ongoing** | Cuando ocurren resultados de ongoing monitoring AML       |

***

## Casos de uso

<AccordionGroup>
  <Accordion title="Automatización del proceso de onboarding de clientes" icon="rocket">
    Cuando se completa la autenticación KYC de un nuevo cliente de una institución financiera, pueden recibir notificaciones inmediatas vía webhook y proceder automáticamente con procesos de seguimiento como apertura de cuenta, emisión de tarjeta y activación de servicio. Usando return URLs y dynamic fields, se pueden proporcionar páginas de guía personalizadas según el estado de aprobación/rechazo.
  </Accordion>

  <Accordion title="Monitoreo y respuesta en tiempo real del equipo de operaciones" icon="chart-line">
    Cuando los submissions KYC son rechazados o se detectan factores de riesgo específicos, se pueden enviar notificaciones inmediatas al equipo de operaciones vía webhook para respuesta rápida. Puede verificar el estado de transmisión de webhooks del día anterior cada mañana mediante la función de gestión de usuarios de notificación.
  </Accordion>

  <Accordion title="Provisión de páginas de resultados personalizadas" icon="window">
    Los clientes pueden configurar sus propias páginas de resultados usando la función skip result page y dynamic fields. Como la información del resultado KYC se incluye en la return URL, los resultados pueden procesarse inmediatamente sin llamadas API separadas.
  </Accordion>
</AccordionGroup>

***

## Documentación relacionada

<CardGroup cols={2}>
  <Card title="Información del proyecto" icon="sliders" href="/dashboard/es/project-management/project-settings/project-info">
    Consulte la configuración de información básica del proyecto.
  </Card>

  <Card title="Descripción general de eventos Webhook" icon="webhook" href="/es/idcheck/webhooks/overview">
    Consulte la descripción general completa de eventos webhook.
  </Card>

  <Card title="Guía de Return URL" icon="arrow-right" href="/es/idcheck/getting-started/liveform-url/return-url-guide">
    Aprenda a usar return URLs en detalle.
  </Card>

  <Card title="Webhook aprobado" icon="circle-check" href="/es/idcheck/webhooks/idcheck-approved">
    Consulte el payload del webhook aprobado.
  </Card>

  <Card title="Webhook rechazado" icon="circle-xmark" href="/es/idcheck/webhooks/idcheck-rejected">
    Consulte el payload del webhook rechazado.
  </Card>

  <Card title="Referencia de API" icon="code" href="/es/idcheck/api-reference/api-reference-guide/overview">
    Aprenda a usar las APIs.
  </Card>
</CardGroup>
