curl --request POST \
  --url https://api.formabledocs.com/v1/signature-requests/embedded \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "abc123xyz",
  "signers": [
    {
      "email": "jane@example.com",
      "name": "Jane Doe",
      "role": "Client"
    },
    {
      "email": "bob@example.com",
      "name": "Bob Smith",
      "role": "Witness"
    }
  ],
  "testMode": true
}
'

{
  "signatureRequestId": "abc123xyz",
  "templateId": "tmpl_123",
  "signers": [
    {
      "email": "jsmith@example.com",
      "name": "<string>",
      "recipientSignatureId": "rsig_abc123"
    }
  ],
  "sender": {
    "email": "jsmith@example.com",
    "name": "<string>"
  },
  "status": "Created",
  "testMode": true,
  "fields": [
    {
      "fieldId": "field_name",
      "type": "text",
      "required": true,
      "filled": true,
      "recipientSignatureId": "<string>",
      "value": "<unknown>",
      "label": "<string>",
      "role": "<string>",
      "unit": "<string>",
      "signedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "Missing signer for role \"Client\" required by template fields"
}

{
  "error": "Auth token not valid"
}

{
  "error": "Client not authorized to create a signature request for this template"
}

{
  "error": "Template not found for id abc123xyz"
}

{
  "error": "Internal server error"
}

Signature Requests

Create an embedded signature request

Creates an embedded signature request for a template with one or more signers. If template fields have assigned roles, signers must include a signer for each of those roles. Requires signers (array of email, name, and role, in signing order). Optional sender (email and name); when omitted, sender defaults to the API key organization owner. Optionally accepts a fields array to pre-fill template fields. Use each signer’s recipientSignatureId with the create signing URL endpoint to mint embeddable links.

POST

signature-requests

embedded

curl --request POST \
  --url https://api.formabledocs.com/v1/signature-requests/embedded \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "abc123xyz",
  "signers": [
    {
      "email": "jane@example.com",
      "name": "Jane Doe",
      "role": "Client"
    },
    {
      "email": "bob@example.com",
      "name": "Bob Smith",
      "role": "Witness"
    }
  ],
  "testMode": true
}
'

{
  "signatureRequestId": "abc123xyz",
  "templateId": "tmpl_123",
  "signers": [
    {
      "email": "jsmith@example.com",
      "name": "<string>",
      "recipientSignatureId": "rsig_abc123"
    }
  ],
  "sender": {
    "email": "jsmith@example.com",
    "name": "<string>"
  },
  "status": "Created",
  "testMode": true,
  "fields": [
    {
      "fieldId": "field_name",
      "type": "text",
      "required": true,
      "filled": true,
      "recipientSignatureId": "<string>",
      "value": "<unknown>",
      "label": "<string>",
      "role": "<string>",
      "unit": "<string>",
      "signedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "Missing signer for role \"Client\" required by template fields"
}

{
  "error": "Auth token not valid"
}

{
  "error": "Client not authorized to create a signature request for this template"
}

{
  "error": "Template not found for id abc123xyz"
}

{
  "error": "Internal server error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

templateId

string

required

The ID of the template to create a signature request for

Example:

"abc123xyz"

signers

object[]

required

People who will sign, in signing order. Must cover every role assigned to fields on the template.

Minimum array length: 1

Show child attributes

sender

object

Optional. Who is sending the request. When omitted, defaults to the API key organization owner.

Show child attributes

testMode

boolean

Optional flag to mark the signature request as a test. Test mode requests are not counted toward billing

Example:

false

fields

object[]

Optional array of fields to pre-fill in the template

Show child attributes

Response

Signature request created successfully

signatureRequestId

string

required

The unique identifier of the created signature request

Example:

"abc123xyz"

templateId

string

required

Example:

"tmpl_123"

signers

object[]

required

Show child attributes

sender

object

required

Show child attributes

status

enum<string>

required

Available options:

Created,

Completed,

Expired

Example:

"Created"

testMode

boolean

required

Example:

true

fields

object[]

required

Envelope fields with current values. Signature image data is never returned.

Show child attributes

Overview

Templates

Signature Requests

Redlining

Billing

Health

Templates

Redlining

Signature Requests

Billing

Health

Create an embedded signature request

Authorizations

Body

Response