PortalFirma

api-integration · Document

Documentos

Envío a firma, consulta por proceso, operación o teléfono, listados por fecha y reenvíos.

Envía un PDF a firma

POST{URL}/document/sendToSign

Envía un PDF (base64) a firma con firmantes y coordenadas.

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Request body

signatoriesrequired

array

Firmantes con datos personales y coordenadas de firma.

documentrequired

string

PDF en base64.

withProtocolizationrequired

boolean

Si el documento se protocoliza.

Example
{
  signatories: [
    {
      signatory: {
        rut: string,
        name: string,
        paternalLastName: string,
        maternalLastName: string,
        address: string,
        district: string,
        email: string,
        phone: string
      },
      signature: {
        xCoordinate: number,
        yCoordinate: number,
        pageNumber: number,
        type: number,
        alias: string
      }
    }
  ],
  document: base64,
  withProtocolization: boolean
}

Detalle de proceso por UUID

GET{URL}/document/getByProcessId/:processId

Obtiene el detalle de un proceso de firma a partir de su UUID.

  • Ya no se retorna `document` (base64). Usa `files.signed` u otros archivos por `id`.
  • `files.signed` corresponde al documento firmado (antes `url` en el contrato).

Path parameters

processIdrequired

string

UUID del proceso.

Example: <uuid>

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Detalle de proceso por operación

GET{URL}/document/getByOperation/:operation

Obtiene el detalle de un proceso a partir del número de operación.

  • Misma forma de respuesta que `getByProcessId`.
  • `:operation` es el número de operación (string), no un UUID.
  • Ya no se retorna `document` (base64). Usa `files.signed` u otros archivos por `id`.

Path parameters

operationrequired

string

Número de operación (no es un UUID).

Example: 123456

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Lista documentos por rango de fechas

GET{URL}/document/getAll/:startDate/:endDate

Lista documentos del customer en un rango de fechas.

  • Fechas en formato aceptado por el pipe de la API (YYYY-MM-DD).

Path parameters

startDaterequired

string

Inicio del rango (YYYY-MM-DD).

Example: 2026-01-01

endDaterequired

string

Fin del rango (YYYY-MM-DD).

Example: 2026-01-31

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Busca operaciones por teléfono

POST{URL}/document/getOperationsByPhone

Busca procesos creados por el usuario del portal cuyo teléfono coincide (resuelve entity_id vía partnerUser), filtrados por rango de fechas.

  • Resuelve el teléfono a un usuario de `app.user` con join a `partnerUser` (obtiene `entity_id`) y lista procesos vía `contractPartner.userId` (no por firmante).
  • El teléfono se normaliza a dígitos (se ignoran espacios, `+` y guiones).
  • `startDate` y `endDate` son ISO (`YYYY-MM-DD`). El rango no puede superar 366 días.
  • `limit` es obligatorio, entre 1 y 100. `totalInRange` es el total del rango; `operations` viene recortado por `limit`.

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Request body

phonerequired

string

Teléfono del usuario del portal. Se normaliza a dígitos.

startDaterequired

string

Inicio del rango ISO (YYYY-MM-DD).

endDaterequired

string

Fin del rango ISO (YYYY-MM-DD). El rango no puede superar 366 días.

limitrequired

number

Cantidad máxima de operaciones a devolver (1–100).

Example
{
  phone: string,
  startDate: "YYYY-MM-DD",
  endDate: "YYYY-MM-DD",
  limit: number
}

Reenvía notificaciones de firma

POST{URL}/document/resendToSign

Reenvía notificaciones de firma del proceso.

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Request body

processIdrequired

string

UUID del proceso.

Example
{
  processId: uuid
}

Reenvía a un firmante

POST{URL}/document/resendSignatoryToSign

Reenvía la notificación de firma a un firmante específico.

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Request body

processIdrequired

string

UUID del proceso.

signatoryIdrequired

string

UUID del firmante.

Example
{
  processId: uuid,
  signatoryId: uuid
}

Cambia el tipo de firma

POST{URL}/document/changeSignatureType

Cambia tipo de firma del firmante (1 | 2 | 3).

Headers

idrequired

string

API key de integración.

Example: {api-key}

Authorizationrequired

string

Bearer token de integración.

Example: Bearer {token}

Request body

processIdrequired

string

UUID del proceso.

signatoryIdrequired

string

UUID del firmante.

signatureTyperequired

number

Tipo de firma: 1, 2 o 3.

Example
{
  processId: uuid,
  signatoryId: uuid,
  signatureType: 1 | 2 | 3
}