Listado del catálogo (JWT o token MCP de resolveByPhone), búsqueda semántica, formulario agrupado y envío a firma. El backend rellena el HTML, genera el PDF y cobra wallet.
Lista plantillas master
GET{URL}/template/getAll
Lista las plantillas master del partner autenticado (entity del JWT).
La entidad se toma de `customer_id` del JWT. No enviar HTML.
Headers
idrequired
string
API key de integración.
Example: {api-key}
Authorizationrequired
string
Bearer token de integración.
Example: Bearer {token}
Lista plantillas por token MCP
POST{URL}/template/getAllByToken
Lista las plantillas master del partner contenido en un access_token MCP (`pf_mcp_at_*`), el mismo que entrega resolveByPhone.
`token` es el `access_token` de `POST /api/session/resolveByPhone`.
Si el token es inválido, expirado o revocado: 401.
Headers
idrequired
string
API key de integración.
Example: {api-key}
Authorizationrequired
string
Bearer token de integración.
Example: Bearer {token}
Request body
tokenrequired
string
access_token de POST /api/session/resolveByPhone.
Example
{
token: string
}
Busca plantillas por intención
POST{URL}/template/searchByToken
Búsqueda semántica + DocIA. Devuelve hasta 3 plantillas listas (mismo shape que getAll).
`token` es el `access_token` de `POST /api/session/resolveByPhone`.
`message` es la intención del usuario (mín. 2 caracteres).
Pipeline: RAG sobre plantillas de la empresa del token y el catálogo de Notaría virtual → DocIA → hidrata al catálogo (máx. 3).
Si el token es inválido, expirado o revocado: 401.
Headers
idrequired
string
API key de integración.
Example: {api-key}
Authorizationrequired
string
Bearer token de integración.
Example: Bearer {token}
Request body
tokenrequired
string
access_token de POST /api/session/resolveByPhone.
messagerequired
string
Intención del usuario (mínimo 2 caracteres).
Example
{
token: string,
message: string
}
Campos de una plantilla
GET{URL}/template/:template_version_id/forms
Devuelve los grupos de campos a completar (signer / nosigner), con campos sintéticos de firmante si faltan.
`template_version_id` sale de getAll, getAllByToken, searchByToken o de MCP search.
Los `id` de cada variable son las keys de `values` en sendSign.
Las variables con `kind: "image"` / `input_type: "image"` se envían en sendSign como data URL base64 (`data:image/png;base64,...`). Otro formato devuelve "Debes subir una imagen válida".
En grupos signer se agregan RUT, correo, teléfono y nombre completo si no están en el HTML.
Con `property_id`, las variables del grupo `propiedad` se completan con los datos guardados de la propiedad: si se completan todas, el grupo no viene; si falta alguna, viene solo con los campos pendientes.
Si usas `property_id` en forms, envía el mismo `property_id` en sendSign.
Sin `property_id` o si la plantilla no tiene grupo `propiedad`, la respuesta es la de siempre. Si la propiedad no existe: 404.
No se exige que la plantilla pertenezca al partner del JWT.
Query parameters
property_idoptional
string | null
UUID de la propiedad (sale de property/getAllByToken). Si se envía, los campos que se completan con la propiedad no se devuelven.
Path parameters
template_version_idrequired
string
UUID de la versión de plantilla (sale de getAll, getAllByToken o searchByToken).
Headers
idrequired
string
API key de integración.
Example: {api-key}
Authorizationrequired
string
Bearer token de integración.
Example: Bearer {token}
Envía una plantilla a firmar
POST{URL}/template/sendSign
Rellena la plantilla con `values`, genera el PDF, cobra wallet y envía a firmar.
No enviar HTML ni PDF. El backend aplica `values` al HTML y genera el PDF.
Los firmantes se derivan de los grupos `signer`.
Con `property_id`, `values` solo necesita los campos que devolvió forms; los de la propiedad se completan en el servidor. Un valor enviado en `values` tiene prioridad sobre el de la propiedad.
Si el wallet no cubre el total: `Error saldo insuficiente`.
Headers
idrequired
string
API key de integración.
Example: {api-key}
Authorizationrequired
string
Bearer token de integración.
Example: Bearer {token}
Request body
template_version_idrequired
string
UUID de la versión de plantilla.
valuesrequired
object
Mapa id → valor. Los id salen de GET .../forms.
property_idoptional
string | null
UUID de la propiedad usada en forms. El backend vuelve a completar los campos de la propiedad.