FirmARDigital

Developer documentation

Getting started

Authentication

Authenticate every API request with a private API key in the Authorization header.

Bearer token

Create the key from the dashboard and store it as a server secret. Never expose it in a browser, mobile app, or repository.

bashFirmARDigital API
curl https://www.firmardigital.com/api/v1/ping \
  -H "Authorization: Bearer fmr_live_..."
200

Valid credentials

jsonFirmARDigital API
{
  "success": true,
  "data": {
    "workspaceId": "cme0r6m1b0000s6a1gaq7pplw",
    "scopes": ["registered-signers:read", "signing-sessions:write"],
    "livemode": true
  }
}

Environments

TypePrefixBehavior
Sandboxfmr_test_Simulates resources without real-world effects.
Productionfmr_live_Operates on real documents and signers.

Scopes

Grant each integration only the permissions it needs.

registered-signers:readregistered-signers:writesigning-sessions:readsigning-sessions:write