Signature Fields

Los endpoints de Signature Fields te permiten posicionar campos de firma en tus PDFs. Puedes usar coordenadas absolutas, texto de referencia (anchorString), o colocar campos en todas las páginas.

En los tres modos de POST /v2/documents puedes mandar los campos en el mismo request con el array fields y ahorrarte estas llamadas. Ver objeto Document.

En compound, mandar fields[] en el create es además lo que habilita sendInvitations en esa misma llamada. Si prefieres colocar los campos después, usa los endpoints de esta página. Colocar un campo para alguien que todavía no es firmante del documento devuelve 400 E1700: da de alta al firmante con add-signer primero. Ver Modo compound.

POST/v2/documents/{document_id}/signature-fields

Add field

Añade un campo de firma a un documento.

Request body

Name
signerEmail
Type
string | null
Description
Email del firmante asignado a este campo. Se requiere signerEmail o signerPhone (al menos uno; no ambos obligatorios).
Name
signerPhone
Type
string | null
Description
Teléfono de WhatsApp del firmante asignado a este campo. Debe iniciar con + (ej. +525512345678). Se requiere signerEmail o signerPhone (al menos uno).
Name
pageNumber
Type
integer
Description
Número de página donde colocar el campo (1-indexed). Requerido para colocación por coordenadas (x/y); opcional con anchorString (si lo omites, busca el texto ancla en todo el documento).
Name
x
Type
number
Description
Coordenada X del campo.
Name
y
Type
number
Description
Coordenada Y del campo.
Name
width
Type
number
Description
Ancho del campo. Default: 200.
Name
height
Type
number
Description
Alto del campo. Default: 100.
Name
anchorString
Type
string
Description
Texto exacto del PDF para usar como referencia de posición.
Name
anchorHorizontalAlignment
Type
string
Description
Cómo se alinea el campo en horizontal sobre el texto ancla. Solo aplica con anchorString (se ignora en colocación por coordenadas). Valores: left (default; el borde izquierdo del campo queda sobre el borde izquierdo del ancla), center (el campo queda centrado sobre el ancla) o right (el borde derecho del campo queda sobre el borde derecho del ancla).
Name
anchorVerticalAlignment
Type
string
Description
Cómo se alinea el campo en vertical sobre el texto ancla. Solo aplica con anchorString. Valores: center (default; centrado sobre el ancla), top o bottom (borde superior/inferior del campo alineado al del ancla).
Name
includeInAllPages
Type
boolean
Description
Si true, el campo aparece en todas las páginas. Default: false.
Name
totalPages
Type
integer
Description
Total de páginas del documento. Requerido cuando includeInAllPages=true.
Name
excludeFromPages
Type
array
Description
Páginas a excluir cuando includeInAllPages=true (1-indexed).
Name
type
Type
string
Description
Tipo de campo. Default: signatureField.

Request

POST

/v2/documents/{id}/signature-fields

curl -X POST "https://api.allsign.io/v2/documents/DOC_UUID/signature-fields" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK" \
  -H "Content-Type: application/json" \
  -d '{
    "signerEmail": "firmante@empresa.com",
    "pageNumber": 2,
    "x": 100,
    "y": 650,
    "width": 200,
    "height": 100
  }'

PUT/v2/documents/{document_id}/signature-fields

Update field

Actualiza la posición, página o configuración de un campo de firma existente.

Request body

Name
fieldId
Type
string
Description
ID del campo a actualizar (UUID).
Name
signerEmail
Type
string | null
Description
Email del firmante dueño del campo. Se requiere signerEmail o signerPhone (al menos uno).
Name
signerPhone
Type
string | null
Description
Teléfono de WhatsApp del firmante dueño del campo. Debe iniciar con + (ej. +525512345678). Se requiere signerEmail o signerPhone (al menos uno).
Name
x
Type
number
Description
Nueva coordenada X.
Name
y
Type
number
Description
Nueva coordenada Y.
Name
pageNumber
Type
integer
Description
Nuevo número de página.
Name
anchorString
Type
string
Description
Reubica el campo sobre este texto ancla. Cuando se envía sin x/y, el campo se mueve a la posición resuelta del ancla. x/y explícitos tienen prioridad.
Name
anchorHorizontalAlignment
Type
string
Description
Alineación horizontal al reubicar por anchorString: left (default), center o right. Se ignora si envías x/y.
Name
anchorVerticalAlignment
Type
string
Description
Alineación vertical al reubicar por anchorString: center (default), top o bottom. Se ignora si envías x/y.
Name
includeInAllPages
Type
boolean
Description
Cambiar si aparece en todas las páginas.

curl -X PUT "https://api.allsign.io/v2/documents/DOC_UUID/signature-fields" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK" \
  -H "Content-Type: application/json" \
  -d '{
    "fieldId": "FIELD_UUID",
    "signerEmail": "firmante@empresa.com",
    "x": 200,
    "y": 700
  }'

DELETE/v2/documents/{document_id}/signature-fields

Delete field

Elimina un campo de firma de un documento.

Request body

Name
fieldId
Type
string
Description
ID del campo a eliminar (UUID).
Name
signerEmail
Type
string | null
Description
Email del firmante dueño del campo. Se requiere signerEmail o signerPhone (al menos uno).
Name
signerPhone
Type
string | null
Description
Teléfono de WhatsApp del firmante dueño del campo. Debe iniciar con + (ej. +525512345678). Se requiere signerEmail o signerPhone (al menos uno).
Name
deleteLinkedFields
Type
boolean
Description
Si true, elimina también campos vinculados (ej. campos en todas las páginas). Default: false.

curl -X DELETE "https://api.allsign.io/v2/documents/DOC_UUID/signature-fields" \
  -H "Authorization: Bearer ALLSIGN_LIVE_SK" \
  -H "Content-Type: application/json" \
  -d '{
    "fieldId": "FIELD_UUID",
    "signerEmail": "firmante@empresa.com",
    "deleteLinkedFields": false
  }'