API v1 · Technical documentation

Add electronic signing to your product.

Automate enrollment, identity verification, and document signing from your backend. This documentation reflects the current REST API contract.

Quickstart

From zero to a signing session in a few steps.

Authentication

API keys, scopes, environments, and best practices.

API reference

Signers, sessions, schemas, responses, and statuses.

Webhooks

Signed events, retries, and HMAC verification.

First request

Test your API key

Use an `fmr_test_` key to validate authentication and connectivity without touching production data.

No real-world effects

bashFirmARDigital API

curl https://www.firmardigital.com/api/v1/ping \
  -H "Authorization: Bearer fmr_test_TU_CLAVE"

Core contract

REST, JSON, and predictable responses.

All routes live under `/api/v1`. Keys are sent as Bearer tokens, and create operations accept `Idempotency-Key` for safe retries.

View responses and errors

Stable contract

JSON responses always use `success`. When it is `false`, the `error` property includes a stable `code` so your backend can make decisions without parsing text.

View error catalog

200

Success envelope

jsonFirmARDigital API

{
  "success": true,
  "data": { "…": "respuesta del recurso" }
}

Node.js example

A minimal backend integration

javascriptFirmARDigital API

const response = await fetch(
  "https://www.firmardigital.com/api/v1/ping",
  { headers: { Authorization: `Bearer ${process.env.FIRMAR_API_KEY}` } }
);

const { data } = await response.json();