Creation

Signature Creation

Qué hace

Crea un proceso de firma asociado a uno o mas firmantes y documentos.

Cuándo usarlo

Usalo cuando el comercio necesita iniciar firma simple o avanzada para documentos contractuales o autorizaciones.

Endpoint

POST /signature

Autenticación

Requiere x-api-key y Authorization: Bearer <JWT>, salvo endpoints publicos de autenticacion o contratos de webhook receptor del cliente.

Campos principales para probar en OpenAPI

CampoUso
process.processNameNombre del proceso de firma.
process.externalProcessIdID externo del proceso definido por el comercio.
process.requestUserUsuario solicitante del proceso.
signatories[].userId o signatories[].internalUserIdFirmantes usando IDs externos o internos.
signatories[].orderOrden de firma.
signatories[].typeTipo de firma, por ejemplo FAO o FES.
documents[].documentNameNombre del documento.
documents[].signatureData[]Posicion/reglas de firma por firmante.

Variantes soportadas

  • Firmantes por userId externo.
  • Firmantes por internalUserId interno Forpay.

Reglas de negocio

  • En cada firmante usa userId o internalUserId, no ambos.
  • Cada documento debe incluir datos suficientes para ubicar las firmas.
  • Si usas posiciones manuales, valida pagina y coordenadas antes de enviar.

Respuesta exitosa

Retorna confirmacion del proceso de firma creado y datos necesarios para seguimiento segun el contrato.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body Params para crear un proceso de firma. Requiere firmantes, documentos, metadata del proceso y URLs de callback/webhook.

signatories
array of objects
required

Firmantes del proceso (1 o más).

signatories*
documents
array of objects
required

Documentos a firmar (1 o más).

documents*
process
object
required

Metadata del proceso.

urls
object
required

URLs de callback y webhook del cliente.

Headers
string
enum
required

Identificador de país donde proviene la solicitud

Allowed:
string
required

Identificador único del comercio asociado definido por forpay

string
required

Tipo de plataforma usada por el comercio para integrarse con Forpay

date-time
required
Defaults to 2026-07-09T14:35:12.500Z

Fecha y hora de la solicitud en formato ISO 8601. En esta documentación se muestra un ejemplo precargado; al consumir la API debe enviarse la fecha/hora real de la solicitud.

string
required

Identificador único para la trazabilidad de la solicitud

string
enum
required

Identificador único del proceso interno de Forpay que realiza la solicitud

Allowed:
string
required

Identificador del ejecutivo que realiza la venta

string
required

Clave x-api-key

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json