创建嵌入式签名请求

创建一个新的 SignatureRequest，其中包含要在嵌入式 iFrame 中签名的提交文档。如果未指定 form_fields_per_document，则将附加一个签名页，所有签名者都需要在其中添加签名，以表明他们同意所有包含的文档。请注意，嵌入式签名请求只能在嵌入式 iFrame 中签名，而普通签名请求只能在 Dropbox Sign 上签名。

通过完整的 Dropbox Sign v3 API 管理账户、签名请求、模板、团队、批量发送、文件下载、传真和事件回调；Hub 仅提供文档与本地 SDK/CLI。

请求

operationId: signatureRequestCreateEmbedded
服务器: https://api.hellosign.com/v3
认证: api_key, oauth2

请求参数

无 URL、查询或 Header 参数。

Body 参数

SignatureRequestCreateEmbeddedRequest必填

Content-Type: application/json, multipart/form-data

字段: filesfile_urlssignersgrouped_signersallow_declineallow_reassignattachmentscc_email_addressesclient_idcustom_fieldsfield_optionsform_field_groupsform_field_rulesform_fields_per_documenthide_text_tagsmessagemetadatasigning_optionssubjecttest_modetitleuse_text_tagsignore_text_tags_extraction_errorspopulate_auto_fill_fieldsexpires_at

{
  "files": [
    {}
  ],
  "file_urls": [
    "https://example.com/resource"
  ],
  "signers": [
    {
      "name": "Example Name",
      "email_address": "developer@example.com",
      "order": 0,
      "sms_phone_number": "+12025550123",
      "sms_phone_number_type": "authentication"
    }
  ],
  "grouped_signers": [
    {
      "order": 0,
      "signers": [
        {
          "name": "Example Name",
          "email_address": "developer@example.com",
          "order": 0,
          "sms_phone_number": "+12025550123",
          "sms_phone_number_type": "authentication"
        }
      ]
    }
  ],
  "allow_decline": false,
  "allow_reassign": false,
  "attachments": [
    {
      "name": "Example Name",
      "required": false,
      "signer_index": 0
    }
  ],
  "cc_email_addresses": [
    "developer@example.com"
  ]
}

响应

`200`

SignatureRequestGetResponseapplication/json

成功响应

字段: signature_requestwarnings

`4XX`

ErrorResponseapplication/json

操作失败

字段: error

{
  "signature_request": {
    "test_mode": false,
    "signature_request_id": "example-signature-request-id",
    "requester_email_address": "developer@example.com",
    "title": "Example document",
    "original_title": "Example document",
    "subject": "Example document",
    "message": "Example message",
    "metadata": {}
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}