box-node-sdk
Version:
Official SDK for Box Plaform APIs
35 lines (34 loc) • 1.08 kB
TypeScript
import * as schemas from '.';
/**
* Signer fields for Box Sign request response
*
* The schema for a Signer object used
* on the body of a Box Sign request object.
*/
export interface SignRequestSigner extends schemas.SignRequestCreateSigner {
/**
* Set to `true` if the signer views the document
* Example: true
*/
has_viewed_document?: boolean;
/**
* Final decision made by the signer.
*/
signer_decision?: object;
inputs?: schemas.SignRequestSignerInput[];
/**
* URL to direct a signer to for signing
* Example: https://example.com
*/
embed_url?: string;
/**
* This URL is specifically designed for
* signing documents within an HTML `iframe` tag.
* It will be returned in the response
* only if the `embed_url_external_user_id`
* parameter was passed in the
* `create Box Sign request` call.
* Example: https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4
*/
iframeable_embed_url?: string;
}