API reference · Signers

Registered signers

Create and retrieve signers from your system. Use externalId to keep the link with your own user records.

POST/api/v1/registered-signersCreate signer

Requires `registered-signers:write`. In production, the response includes the enrollment link.

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í	The signer's full name.
externalId	string	No	Your own ID. Persist it: creation is idempotent on this value.
email	email	No	Destination for the enrollment link.
phone	string	No	The signer's phone number, up to 30 characters.
dni	integer \| null	No	Optional local identifier for the signer.

201

Signer created or retrieved by 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-signersList signers

Requires `registered-signers:read`. Returns only operational data for the workspace.

bashFirmARDigital API

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

Optional exact-match filters: `externalId`, `email`, `dni`, and `status`. Valid statuses are `PENDING`, `ENROLLED`, and `SUSPENDED`.

200

Signer list

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/:idRetrieve signer

Requires `registered-signers:read`. The `id` is the internal identifier returned by the API.