Get Embed Url Signing requests

POST /unified/e-signature/signing_requests/get_embed_url

DocuSign

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters

integrated_account_idstring · uuid

required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

truto_response_formatstring

The format of the response.

unified returns the response with unified mappings applied.
raw returns the unprocessed, raw response from the remote API.
normalized applies the unified mappings and returns the data in a normalized format.
stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified

Possible values:

unifiedrawnormalizedstreamdebug

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name

remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

signing_request

1 supported1 required

DocuSign

required

Response Body

cancellation_reasonstring

If the signing request is voided or cancelled, the reason is specified here.

collectionsobject[]

The collections of the signing request.

References: Collections → id

idstring

The unique identifier of the collection.

namestring

The name of the collection.

created_atstring · date-time

The date and time when the signing request was created.

descriptionstring

Human readable description of the signing request. This is usually the email body that goes as part of the signing request.

expires_atstring · date-time

The date and time when the signing request expires.

groupsobject[]

The groups of the signing request.

References: Groups → id

idstring

The unique identifier of the group.

typestring

The type of the group.

idstring

The unique identifier of the signing request.

1 supported

DocuSign

supported

last_activity_atstring · date-time

The date and time when the signing request was last updated.

namestring

The name of the signing request. This is usually the email subject that goes as part of the signing request.

participantsobject[]

The participants of the signing request.

emailsobject[]

The emails of the participant.

1 property

emailstring

The email address of the participant.

idstring

The unique identifier of the participant.

is_signerboolean

Specifies whether the participant is a signer of the document.

namestring

The name of the participant.

routing_ordernumber

The routing order of the participant.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusobject

The status of the signing request.

References: SigningRequestStatuses → id

idstring

namestring

typestring

The type of the signing request.

1 supported

DocuSign

supported

updated_atstring · date-time

The date and time when the signing request was last updated.

urlsobject[]

The urls of the signing_request

1 supported

DocuSign

supported

typestring

The type of the url

Possible values:

vieweditpublic_view

urlstring

The url of the signing_request

truto unified e-signature signingrequests \
  -m get_embed_url \
  -a '<integrated_account_id>' \
  -o json

import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

// Custom method: get_embed_url
const result = await truto.unifiedApi.get_embed_url(
  'e-signature',
  'signingrequests',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);

import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    # Custom method: get_embed_url
    result = await truto_api.unified_api.get_embed_url(
        "e-signature",
        "signingrequests",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X POST 'https://api.truto.one/unified/e-signature/signing_requests/get_embed_url?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "remote_data": {}
}'

const integratedAccountId = '<integrated_account_id>';

const body = {
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/e-signature/signing_requests/get_embed_url?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.truto.one/unified/e-signature/signing_requests/get_embed_url"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())