Referencia API · Firmantes

Firmantes registrados

Creá y consultá firmantes desde tu sistema. Usá externalId para mantener la relación con tu propio registro de usuarios.

POST/api/v1/registered-signersCrear firmante

Requiere `registered-signers:write`. En producción, la respuesta incluye el enlace de enrolamiento.

bashFirmARDigital API

curl --request POST https://www.firmardigital.com/api/v1/registered-signers \
  --header "Authorization: Bearer fmr_live_TU_CLAVE" \
  --header "Content-Type: application/json" \
  --data '{
    "externalId": "cliente-4821",
    "fullName": "María González",
    "email": "maria@ejemplo.com"
  }'

JSON body

Campo	Tipo	Obligatorio	Descripción
fullName	string	Sí	Nombre completo del firmante.
externalId	string	No	ID propio. Conviene persistirlo: la creación es idempotente por este valor.
email	email	No	Destino del enlace de enrolamiento.
phone	string	No	Teléfono del firmante, hasta 30 caracteres.
dni	integer \| null	No	Identificador local opcional del firmante.

201

Firmante creado o recuperado por externalId

jsonFirmARDigital API

{
  "success": true,
  "data": {
    "id": "cme0s9s8r0001s6a1wz6w2d4f",
    "externalId": "cliente-4821",
    "status": "PENDING",
    "enrollmentUrl": "https://www.firmardigital.com/enroll/…",
    "expiresAt": "2026-08-02T15:00:00.000Z",
    "alreadyEnrolled": false
  }
}

GET/api/v1/registered-signersListar firmantes

Requiere `registered-signers:read`. Devuelve únicamente los datos operativos del workspace.

bashFirmARDigital API

curl "https://www.firmardigital.com/api/v1/registered-signers" \
  --header "Authorization: Bearer fmr_live_TU_CLAVE"

Filtros opcionales de coincidencia exacta: `externalId`, `email`, `dni` y `status`. Los estados válidos son `PENDING`, `ENROLLED` y `SUSPENDED`.

200

Listado de firmantes

jsonFirmARDigital API

{
  "success": true,
  "data": [
    {
      "id": "cme0s9s8r0001s6a1wz6w2d4f",
      "externalId": "cliente-4821",
      "fullName": "María González",
      "email": "maria@ejemplo.com",
      "dni": null,
      "status": "ENROLLED",
      "enrolledAt": "2026-08-01T12:10:00.000Z",
      "enrollmentExpiresAt": "2026-08-02T15:00:00.000Z",
      "createdAt": "2026-08-01T12:00:00.000Z"
    }
  ]
}

GET/api/v1/registered-signers/:idConsultar firmante

Requiere `registered-signers:read`. El `id` es el identificador interno devuelto por la API.