Skip to main content
POST
/
get-embedded-signing-request
Get embedded signing request data (JWT authenticated)
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000"
}'
{
  "signing_request": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "document_url": "<string>",
    "document_page_count": 2,
    "status": "not_sent",
    "expiration_hours": 168,
    "settings": {
      "allow_download": true,
      "attach_pdf_on_finish": true,
      "allow_editing_before_sending": false
    },
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "date_created": "2023-11-07T05:31:56Z",
    "date_sent": "2023-11-07T05:31:56Z",
    "date_finished": "2023-11-07T05:31:56Z",
    "date_cancelled": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "fields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "signature",
      "position": {
        "x": 50,
        "y": 50,
        "width": 50,
        "height": 50
      },
      "page_number": 2,
      "required": false,
      "recipient_id": "<string>",
      "variable_name": "<string>",
      "dropdown_options": [
        "<string>"
      ],
      "date_default": "2023-12-25",
      "date_signing_default": false,
      "multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "format_rules": {},
      "validation_rules": {}
    }
  ],
  "recipients": [
    {
      "id": "<string>",
      "_temp_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "designation": "Signer",
      "order": 2,
      "phone_number": "<string>",
      "street_address": "<string>",
      "city": "<string>",
      "state_province": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "title": "<string>",
      "company": "<string>",
      "custom_fields": {}
    }
  ],
  "reminders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "hours": 2,
      "subject": "<string>",
      "message": "<string>",
      "all_users": true,
      "template_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date_created": "2023-11-07T05:31:56Z",
      "date_changed": "2023-11-07T05:31:56Z"
    }
  ]
}

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.

Body

application/json
​
companies_workspaces_signing_requests_id
string<uuid>
required

ID of the signing request to retrieve

Response

Signing request retrieved successfully

​
signing_request
object
​
fields
object[]
​
recipients
object[]
​
reminders
object[]