FirmARDigital

Developer documentation

Getting started

Sandbox

Test your full integration flow with test keys before connecting real users or documents.

What you can test

Authentication and scopes

Simulated signer creation

Session creation and polling

Response and error handling

Webhook integration

Create a test session

The response returns a simulated URL and a `documentId` prefixed with `sandbox_document_`.

bashFirmARDigital API
curl --request POST https://www.firmardigital.com/api/v1/signing-sessions \
  --header "Authorization: Bearer fmr_test_TU_CLAVE" \
  --header "Idempotency-Key: demo-001" \
  --form "file=@contrato.pdf;type=application/pdf" \
  --form 'data={"externalId":"cliente-4821","title":"Demo","recipient":{"name":"Test User","email":"test@example.com"}}'
201

Simulated response

jsonFirmARDigital API
{
  "success": true,
  "data": {
    "documentId": "sandbox_document_5c2e…",
    "sessionUrl": "http://localhost:3000/sandbox/signing-sessions/sandbox_session_…",
    "expiresAt": "2026-08-01T18:00:00.000Z",
    "reused": false,
    "sandbox": true
  }
}

Sandbox reconciliation

  1. Create the signer and keep its `sandbox_signer_*` ID.
  2. Create the session and keep its `sandbox_document_*` `documentId`.
  3. Check the status: the simulation returns `SIGNED` so you can test your final flow.
  4. Do not try to download the PDF: sandbox returns `404` because it does not generate persistent files.