# Twarz

> Twarz es una plataforma de identidad verificada para Uruguay y Argentina. Una persona se registra en la app de
> Twarz con su documento y una verificación facial; una empresa le envía solicitudes para identificarse, aprobar,
> firmar o compartir datos, y la persona responde desde su celular. Los sistemas de las empresas se integran por una
> API HTTP con clave API y reciben los resultados por webhooks firmados con HMAC-SHA256.

- Base de la API: `https://api.twarz.uy/api`. Autenticación: header `X-Api-Key`.
- Las claves API y las suscripciones de webhook las crea un supervisor de la empresa en la Web Agente
  (`https://agente.twarz.uy`, sección Acceso API). La clave y el secreto de firma se muestran una sola vez.
- Una clave solo puede llamar las operaciones del documento OpenAPI de integración de abajo, que las lista todas y
  ninguna más; el resto de la API es de las apps de Twarz y no acepta clave.
- El webhook nunca trae datos de la persona: los datos compartidos se leen después con la API y un token de 2 minutos.

## Guía

- [Conectar tu sistema con Twarz: API y webhooks](https://www.twarz.uy/llms/acceso-api.md): crear una clave, crear
  una solicitud, verificar y recibir webhooks (eventos, headers, firma, reintentos, duplicados) y leer los datos
  compartidos. Incluye un receptor de ejemplo en Node.js.

## Referencia OpenAPI

- [Integration v1](https://api.twarz.uy/api/swagger/Integration%20v1/swagger.json): todo lo que una clave puede
  llamar, en inglés: plantillas y solicitudes (`/v1/coreo/templates`, `/v1/coreo/petitions`), catálogo de accesos
  (`/v1/coreo/access/catalog`), suscripciones de webhook (`/v1/tenant/webhooks`) y lectura de datos compartidos
  (`/v1/biometric/records/shared`).

## Optional

- [Referencia interactiva](https://api.twarz.uy/api/docs): el mismo documento, para leerlo y probar cada operación
  con una clave.
- [Ayuda de la Web Agente](https://www.twarz.uy/ayuda/agente/general): la consola donde se gestionan claves,
  webhooks, plantillas y solicitudes.