Skip to main content
GET
@firma-dev/sdk

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Signing request ID

signer_id
string<uuid>
required

Signer (recipient) ID

Query Parameters

include_frame
boolean
default:true

Overlay the signer-ID frame on the image (default true). Set to false for the bare mark.

Response

The signer's mark as a base64 PNG data URI.

signer_id
string<uuid>
kind
enum<string>
Available options:
signature,
initials,
stamp
format
string
Example:

"png"

framed
boolean

Whether the signer-ID frame was overlaid.

image
string

PNG as a data URI.

Example:

"data:image/png;base64,iVBORw0KGgo..."