How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Firma.dev

Firma.dev Signing Requests API

Document signing request operations

Provider Profile APIs.io OpenAPI GitHub

Firma.dev Signing Requests API is one of 12 APIs that Firma.dev publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Signing Requests. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 21 operations across 17 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 01.38.00.

Requests are made against 2 base URLs: https://api.firma.dev/functions/v1/signing-request-api, https://api.firma.dev/api/v1.

21 operations 17 paths 42 schemas 2 DELETE11 GET1 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
01.38.00
Servers
https://api.firma.dev/functions/v1/signing-request-api
https://api.firma.dev/api/v1
Authentication
API Key
Contact
API Support
Resource Areas
1

Authentication & Security 1

Firma.dev Signing Requests API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Paths & Operations 21

Across 17 paths, the API surfaces 21 operations — 2 DELETE, 11 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Signing Requests 21

Document signing request operations

GET
/signing-requests
List Signing Requests
listSigningRequests 10 params → 200401429
POST
/signing-requests
Create Signing Request
createSigningRequest body → 201400401404503429
POST
/signing-requests/create-and-send
Create and Send Signing Request (Atomic)
createAndSendSigningRequest body → 201400401402404503422429
GET
/signing-requests/{id}
Get Signing Request
getSigningRequest 1 param → 200401404429
PATCH
/signing-requests/{id}
Partially Update Signing Request
patchSigningRequest 1 param body → 200400401404429
PUT
/signing-requests/{id}
Comprehensive Update Signing Request
updateSigningRequest 1 param body → 200400401404429
DELETE
/signing-requests/{id}
Delete a signing request
deleteSigningRequest 1 param → 200401404409429
GET
/signing-requests/{id}/users
Get signing request users
listSigningRequestUsers 1 param → 200401404429
GET
/signing-requests/{id}/fields
Get signing request fields
listSigningRequestFields 1 param → 200401404429
GET
/signing-requests/{id}/reminders
Get signing request reminders
listSigningRequestReminders 1 param → 200401404429
GET
/signing-requests/{id}/audit
Get signing request audit trail
listSigningRequestAuditTrail 1 param → 200401404429
POST
/signing-requests/{id}/send
Send signing request
sendSigningRequest 1 param → 200400401404429
POST
/signing-requests/{id}/cancel
Cancel a signing request
cancelSigningRequest 1 param body → 200401404409429
POST
/signing-requests/{id}/resend
Resend signing request to specific recipients
resendSigningRequest 1 param body → 200400401404409429
GET
/signing-requests/{id}/download
Download Signing Request Document
downloadSigningRequest 1 param → 200401404409429503
GET
/signing-requests/{id}/signers/{signer_id}/signature
Retrieve Signer Signature Image
retrieveSignerSignature 3 params → 200401404429500
GET
/signing-requests/{id}/signers/{signer_id}/initials
Retrieve Signer Initials Image
retrieveSignerInitials 3 params → 200401404429500
GET
/signing-requests/{id}/signers/{signer_id}/stamps/{field_id}
Retrieve Signer Stamp Image
retrieveSignerStamp 4 params → 200400401404429500
GET
/signing-requests/{id}/signers/{signer_id}/files/{field_id}
Retrieve Signer-Uploaded File
retrieveSignerFile 3 params → 200400401404429500
POST
/documents
Upload a document
uploadDocument body → 201400401
DELETE
/signing-requests/{id}/seal-participants/{participant_id}
Remove a seal participant from an unsent signing request
deleteSealParticipant 2 params → 200401403404409429

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are SigningRequestField (32 properties), SigningRequestDetail (26 properties), AnchorTag (25 properties), SigningRequestUser (23 properties). Each schema is shown below with its type and property counts.

SealParticipantInput
object
Seal participant assignment for a signing request or template.
3 properties 2 required
CreateAndSendValidationError
object
Validation error during create-and-send
5 properties 2 required
AnchorTag
object
Anchor tag definition for automatic field placement. Anchor tags are text markers embedded in a PDF document (e.g., '{{SIGNHERE}}') that are automatically loca…
25 properties 3 required
UpdateSigningRequestBodySchema
object
7 properties
SealParticipant
object
Seal participant on a signing request or template.
6 properties
SigningRequestListResponse
object
Paginated list of signing requests
2 properties 2 required
SigningRequestField
object
Field associated with a signing request, containing position, type, and value information
32 properties 3 required
SigningRequestListItem
object
Signing request as returned by the LIST endpoint (GET /signing-requests)
21 properties 4 required
UnprocessableEntityError
object
Unprocessable entity error
2 properties 2 required
SigningRequestFieldListResponse
object
List of signing request fields
1 property 1 required
Condition
object
A single condition that evaluates a field's value.
3 properties 2 required
FileFormatRules
object
Formatting rules for file upload fields. Specifies which file types signers are allowed to upload.
1 property
SigningRequestReminder
object
6 properties 3 required
CreateAndSendResponse
object
Signing request created and sent
16 properties 3 required
InsufficientCreditsError
object
Insufficient credits error
3 properties 3 required
Error
object
Organization Seal error codes: SEALSDISABLED, SEALALREADYREVOKED, SEALCREATIONDISABLEDEDGE, SEALERASENOTELIGIBLE, SEALIMAGEINVALID, SEALMUTATIONNOTALLOWED, SEA…
5 properties 1 required
Field
object
Field definition for signing requests. Read-only fields: Set readonly=true to pre-fill a field value that signers cannot edit. Use readonlyvalue for static tex…
22 properties 3 required
CancelSigningRequestResponse
object
Signing request cancellation result
5 properties 3 required
ResendSigningRequestResponse
object
Signing request resend result
5 properties 2 required
SigningRequestListRecipient
object
Recipient as returned in LIST signing request responses (simplified shape)
7 properties
SigningRequestUserListResponse
object
List of signing request users
1 property 1 required
FieldValidationRules
objectnull
Validation rules for field values. Reserved for future use - currently not enforced for any field types.
SigningRequestUpdateResponse
object
Signing request update result
6 properties 2 required
SigningRequestDetail
object
Detailed signing request as returned by GET /signing-requests/{id} (nested shape with status object and timestamps)
26 properties 4 required
SigningRequestDownloadResponse
object
5 properties 4 required
SigningRequestDeleteResponse
object
Signing request deletion confirmation
3 properties 2 required
DeletedRecipient
object
3 properties 2 required
SigningRequestCreateResponse
object
Signing request as returned by CREATE endpoints (POST /signing-requests)
18 properties 3 required
SigningRequestCreateField
object
Field as returned in CREATE signing request responses (flat position, database-style)
18 properties 3 required
SigningRequestCreateRecipient
object
Recipient as returned in CREATE signing request responses
17 properties 3 required
Recipient
object
Recipient schema with auto-construction and mapping behaviors. Name field: Auto-constructed from firstname and lastname ('First Last' if both present, otherwis…
17 properties 3 required
Reminder
object
10 properties 4 required
SigningRequestUser
object
23 properties 5 required
ResendConflictError
object
Resend conflict error
3 properties 2 required
SendSigningRequestResponse
object
4 properties
SigningRequestUpdateError
object
Signing request update validation error
3 properties 1 required
Pagination
object
Pagination metadata for list responses
4 properties 4 required
ConditionGroup
object
1 property 1 required
ConditionSet
object
A set of condition groups with nested logic. The outer 'logic' operator combines groups, while each group's conditions use the opposite operator. Example: logi…
2 properties 2 required
DateFormatRules
object
Formatting rules for date fields. Specifies how date values should be displayed and formatted.
2 properties
AuditTrailListResponse
object
List of audit trail entries
1 property 1 required
SigningRequestSettings
object
Settings returned by the signing request list and detail endpoints. Templates use the TemplateSettings schema (no identity fields).
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firma-dev-signing-requests-api-openapi.yml Raw ↑

Other APIs Firma.dev publishes across the network.

Firma.dev Company API
AE Profile APIs.io
Firma.dev Custom Fields API
AE Profile APIs.io
Firma.dev Email Domains API
AE Profile APIs.io
Firma.dev Email Templates API
AE Profile APIs.io
Firma.dev JWT Management API
AE Profile APIs.io
Firma.dev Organization Seals API
AE Profile APIs.io
Firma.dev Signer Terms API
AE Profile APIs.io
Firma.dev Templates API
AE Profile APIs.io
Firma.dev Webhooks API
AE Profile APIs.io
Firma.dev Workspace Settings API
AE Profile APIs.io
Firma.dev Workspaces API
AE Profile APIs.io
#Signing Requests
← Back to F APIs
API Details
ID
firma-dev:firma-dev-signing-requests-api
Server
https://api.firma.dev/functions/v1/signing-request-api
Provider
Firma.dev
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=firma-dev-signing-requests-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/firma-dev-signing-requests-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Firma.dev Signing Requests API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.