post
https://{host}/api/v2/project/link/iframe-url
Generates an embeddable IFrame URL for signature setup, allowing users to create or update their signature and initials within your application.
Overview
This endpoint creates a secure, time-limited URL that can be embedded in an IFrame to provide users with a signature setup interface. This is useful for integrating DOC's signature capture functionality directly into your enterprise application.
Authentication
- Bearer Token: Required. Pass the user token in the Authorization header.
- x-api-client: API client identifier header.
- x-api-signature: API signature header for request validation.
Query Parameters
| Parameter | Required | Description |
|---|---|---|
user_type | Required | The type of user. Use ENTERPRISE_API for enterprise API integrations. |
email | Optional | The email address of the user for whom to generate the signature setup URL. |
Response
Returns a JSON object containing the IFrame URL that can be embedded in your application for signature setup.
Usage Notes
- The generated URL is time-limited and should be used promptly.
- The IFrame allows users to draw, type, or upload their signature and initials.
- Once the user completes the signature setup, the assets are stored and can be retrieved via the Get Signature and Initial endpoint.
Error Codes
401 Unauthorized: Invalid or missing authentication token.403 Forbidden: Insufficient permissions to generate the IFrame URL.422 Unprocessable Entity: Invalid parameters provided.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
