openapi: 3.0.1 info: title: DocuSign Admin AccountBrands Envelopes API description: An API for an organization administrator to manage organizations, accounts and users termsOfService: https://www.docusign.com/company/terms-and-conditions/developers contact: name: DocuSign Developer Center url: https://developers.docusign.com email: devcenter@docusign.com version: v2.1 servers: - url: https://api.docusign.net/Management tags: - name: Envelopes description: Create, send, and manage envelopes. An envelope is the fundamental unit of a DocuSign transaction, containing the documents to be signed, the recipients who will sign them, and the workflow rules. externalDocs: url: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/ paths: /accounts/{accountId}/envelopes: post: operationId: Envelopes_CreateEnvelope summary: Docusign Create an Envelope description: Creates and optionally sends an envelope. An envelope is the container for documents, recipients, and the workflow information. You can create an envelope in draft status to allow for further modifications, or send it immediately upon creation. tags: - Envelopes parameters: - $ref: '#/components/parameters/accountId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnvelopeDefinition' responses: '201': description: Envelope created successfully. content: application/json: schema: $ref: '#/components/schemas/EnvelopeSummary' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: Envelopes_ListEnvelopes summary: Docusign List Envelopes description: Returns a list of envelopes that match the specified criteria. Use query parameters to filter by date, status, and other envelope properties. tags: - Envelopes parameters: - $ref: '#/components/parameters/accountId' - name: from_date in: query description: Start date for the envelope search. Only envelopes created on or after this date are returned. Format is ISO 8601. schema: type: string format: date-time - name: to_date in: query description: End date for the envelope search. Only envelopes created before this date are returned. Format is ISO 8601. schema: type: string format: date-time - name: status in: query description: Filter by envelope status. Valid values include created, sent, delivered, signed, completed, declined, voided, deleted. schema: type: string enum: - created - sent - delivered - signed - completed - declined - voided - deleted - name: from_to_status in: query description: The status value checked for in the from_date and to_date range. Default is changed. schema: type: string - name: count in: query description: Maximum number of envelopes to return. Default is 100. schema: type: integer default: 100 - name: start_position in: query description: Starting index position for the result set. schema: type: integer - name: search_text in: query description: Free text search across envelope metadata including recipient names, email addresses, and custom fields. schema: type: string - name: order in: query description: Sort order for results. Valid values are asc and desc. schema: type: string enum: - asc - desc - name: order_by in: query description: The envelope property to sort by. Valid values include created, completed, last_modified, sent, status_changed. schema: type: string - name: folder_ids in: query description: Comma-separated list of folder IDs to search within. schema: type: string - name: include in: query description: Comma-separated list of additional information to include. Valid values include custom_fields, documents, attachments, extensions, folders, recipients, powerform. schema: type: string responses: '200': description: Successfully retrieved list of envelopes. content: application/json: schema: $ref: '#/components/schemas/EnvelopesInformation' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /accounts/{accountId}/envelopes/{envelopeId}: get: operationId: Envelopes_GetEnvelope summary: Docusign Get an Envelope description: Retrieves the overall status and properties of a single envelope. Returns information about the envelope including its status, sender, recipients, and documents. tags: - Envelopes parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/envelopeId' - name: include in: query description: Comma-separated list of additional information to include. Valid values include custom_fields, documents, attachments, extensions, folders, recipients, powerform, tabs. schema: type: string - name: advanced_update in: query description: When true, allows sender to update an in-process envelope. schema: type: string responses: '200': description: Successfully retrieved the envelope. content: application/json: schema: $ref: '#/components/schemas/Envelope' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: Envelopes_UpdateEnvelope summary: Docusign Update an Envelope description: Updates the envelope specified by envelopeId. You can use this method to modify envelope properties such as the email subject and message, resend notifications, void envelopes, and purge documents. tags: - Envelopes parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/envelopeId' - name: resend_envelope in: query description: When true, resends the envelope to all recipients who have not yet completed their actions. schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Envelope' responses: '200': description: Envelope updated successfully. content: application/json: schema: $ref: '#/components/schemas/EnvelopeUpdateSummary' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK /v2/accounts/{accountId}/envelopes: get: tags: - Envelopes summary: Docusign Gets status changes for one or more envelopes. description: "Retrieves a list of envelopes that match your request. \nA large set of optional filters let you filter\nby date,\nby envelope ID,\nor by status codes.\n\nYour request must include one or more of the following parameters:\n\n* `from_date`\n* `envelope_ids`\n* `transaction_ids`\n\n\nGetting envelope status using `transaction_ids` is useful\nfor offline signing situations where it can be used\ndetermine if an envelope was created or not. It can be used\nfor the cases where a network connection was lost, before\nthe envelope status could be returned.\n\nTo avoid unnecessary database queries, the DocuSign\nsignature platform first checks requests to ensure that the\nfilter set supplied does not result in a zero-size response\nbefore querying the database. \n\nFor example, for a request with a `from_to_status` of\n`delivered` and a current `status` of `created,sent`,\nDocuSign will always return an empty list. \nThis is because the request translates to: find the\nenvelopes that were delivered between the `from_date` and\n`to_date` dates that have a current status of `created` or\n`sent`. Since an envelope that has been delivered can\nnever have a status of `created` or `sent`, a zero-size\nresponse would be generated. \nIn this case, DocuSign does not query the database\nand returns an empty list immediately.\n\n\nThe following table shows the valid current envelope\nstatuses (`status` parameter) for the different status\nqualifiers (`from_to_status` parameter) in the request. If\nthe status and status qualifiers in the API request do not\ncontain any of the values shown in the Valid Current\nStatuses column, then an empty list is returned.\n\nClient applications should check that the statuses (`status`\nparameter) they are requesting make sense for a given\n`from_to_status` parameter value.\n\n| Status Qualifier
(`from_to_status`) | Effective Status Qualifier | Valid Current Statuses | \n| :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- | \n| any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted | \n| created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted | \n| sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted | \n| delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted | \n| signed | StatusChanged | any, signed, completed, declined, voided, deleted | \n| completed | Completed | any, completed, declined, voided, deleted | \n| declined | StatusChanged | any, declined, voided, deleted | \n| timedout
always return zero results | StatusChanged | any, voided, deleted | \n| voided | Voided | any, voided, deleted | \n| deleted | StatusChanged | any, deleted | \n\n## Extraneous results\n\nIn some cases, a request for a specific envelope status will\ninclude envelopes with additional statuses. For example, in\na request with a `from_date` of 2017-01-01, a `to_date` of\n2017-01-07 and the status qualifier (`from_to_status`) set\nto `delivered`, the response set might contain envelopes\nthat were created during that time period, but not delivered\nduring the time period. As a workaround, check the envelope\nstatus values in the result set as needed. \n" operationId: Envelopes_GetEnvelopes parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: ac_status in: query description: 'Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.' schema: type: string - name: block in: query description: 'Reserved for DocuSign. ' schema: type: string - name: count in: query description: 'Optional. Number of items to return. Currently there is no implicit maximum limit of the number of items that can be returned. ' schema: type: string - name: custom_field in: query description: "Optional. Specifies a envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`\n\nExample: If you have an envelope custom field named \"Region\" and you want to search for all envelopes where the value is \"West\" you would use set this parameter to `Region=West`. \n \n" schema: type: string - name: email in: query description: 'Limit results to envelopes sent by the account user with this email address. `user_name` must be given as well, and both `email` and `user_name` must refer to an existing account user. ' schema: type: string - name: envelope_ids in: query description: Comma separated list of `envelopeId` values. schema: type: string - name: from_date in: query description: 'Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are set. Although you can use any date format supported by the .NET system library''s [`DateTime.Parse()`][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server''s time zone. For example, the following dates and times refer to the same instant: * `2017-05-02T01:44Z` * `2017-05-01T21:44-04:00` * `2017-05-01T18:44-07:00` [msoft]: https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601' schema: type: string - name: from_to_status in: query description: "The status value checked for in the `from_date` to `to_date` time period. \n\nPossible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.\n\nIf `Changed` is specified, then envelopes that changed status during the period will be returned. \n\nFor example, if `Created` is specified, then envelopes created during the period are found. \n\nThe default is `Changed`. " schema: type: string - name: start_position in: query description: 'This value is supported and currently has no implicit maximum items. ' schema: type: string - name: status in: query description: 'A comma-separated list of current envelope statuses to included in the response. Possible values are: * completed * created * declined * deleted * delivered * processing * sent * signed * timedout * voided The `any` value is equivalent to any status. ' schema: type: string - name: to_date in: query description: 'Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date format supported by the .NET system library''s [`DateTime.Parse()`][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server''s time zone. For example, the following dates and times refer to the same instant: * `2017-05-02T01:44Z` * `2017-05-01T21:44-04:00` * `2017-05-01T18:44-07:00` [msoft]: https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601 ' schema: type: string - name: transaction_ids in: query description: 'A comma-separated list of envelope transaction IDs. Transaction IDs are only valid for seven days. ' schema: type: string - name: user_name in: query description: 'Limit results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name` must refer to an existing account user. ' schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/envelopesInformation' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: listStatusChanges x-ds-method: listStatusChanges x-ds-service: Envelopes x-ds-in-sdk: true x-ds-examples: - description: 'This example shows a how to get information about envelopes created since January 1, 2016. The request for this endpoint has no payload. ### Request ``` GET /restapi/v2/accounts/1703061/envelopes?from_date=2016-01-01 ``` ' direction: response format: json response: endPosition: '1' envelopes: - certificateUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/certificate customFieldsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/custom_fields documentsCombinedUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/combined documentsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents envelopeId: 379497bb-cc85-4654-bab9-a8e397f538d0 envelopeUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0 notificationUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/notification recipientsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/recipients status: completed statusChangedDateTime: 2016-10-04 15:26:28.283000+00:00 templatesUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/templates - certificateUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate customFieldsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields documentsCombinedUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined documentsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents envelopeId: 4b728be4-4417-45c6-b7e8-d63e23f822b6 envelopeUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6 notificationUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification recipientsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients status: sent statusChangedDateTime: 2016-10-05 01:04:58.777000+00:00 templatesUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates nextUri: '' previousUri: '' resultSetSize: '2' startPosition: '0' totalSetSize: '2' style: custom title: Get Status About Envelopes Since a Specified Date post: tags: - Envelopes summary: Docusign Creates an envelope. description: "Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the DocuSign platform.\n\nWith this method you can:\n\n* Create and send an envelope\n with [documents][], [recipients][], and [tabs][].\n* Create and send an envelope from a template.\n* Create and send an envelope from\n a combination of documents and templates.\n* Create a draft envelope.\n\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition]) are required:\n\n| Parameter | Description |\n| :-------- | :---------- |\n| `status` | Set to `sent` to send the envelope to recipients.
Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents` | The [documents][] to be signed. |\n| `recipients` | The email addresses of the envelope [recipients][]. |\n\n\nThere are many ways to use envelopes.\nYou can create and send an envelope\nwith a single API request,\nor you can use several API requests\nto create, populate, and send envelopes.\n\n\n| See | To learn about |\n| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |\n| [Envelopes][envelopes] | Envelopes, [adding documents][addingdocs], [tracking][], [locking][], [deleting][], [templates][] |\n| [Documents][documents] | Documents, [attachments][], [supplemental documents][supdocs], [authoritative copies][authcopies], [purging][] |\n| [Recipients][recipients] | Recipients, [recipient types][reciptypes], [recipient status][recipstatus] |\n| [Tabs][tabs] | Tabs, [tab types][tabtypes], [anchoring tabs][tabanchor], [auto-populating tabs][tabauto], [custom tabs][tabcustom], [payments][] |\n\n\n[addingdocs]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#adding-documents-to-an-envelope\n[attachments]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#attachments\n[authcopies]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#authoritative-copies\n[conoverview]: https://developers.docusign.com/esign-rest-api/guides/concepts/overview\n[deleting]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#deleting-envelopes\n[documents]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents\n[envelopeDefinition]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create#envelopeDefinition\n[envelopes]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes\n[locking]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#locking-envelopes\n[payments]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#requesting-payments\n[purging]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#purging-documents\n[recipients]: https://developers.docusign.com/esign-rest-api/guides/concepts/recipients\n[recipstatus]: https://developers.docusign.com/esign-rest-api/guides/concepts/recipients#recipient-status\n[reciptypes]: https://developers.docusign.com/esign-rest-api/guides/concepts/recipients#recipient-types\n[supdocs]: https://developers.docusign.com/esign-rest-api/guides/concepts/documents#supplemental-documents\n[tabanchor]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#anchoring-tabs\n[tabauto]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#automatically-populating-tabs\n[tabcustom]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#using-custom-tabs-in-envelopes-and-templates\n[tabs]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs\n[tabtypes]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#tab-types\n[templates]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#working-with-templates\n[tracking]: https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#tracking-envelope-status\n\n**Note**: When you create an envelope by using a [composite template](https://developers.docusign.com/esign-rest-api/guides/concepts/templates#composite-templates), you should specify the envelope custom fields in the inline template. Any custom fields that you specify at the root level are ignored.\n" operationId: Envelopes_PostEnvelopes parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: cdse_mode in: query description: 'Reserved for DocuSign. ' schema: type: string - name: change_routing_order in: query description: When true, users can define the routing order of recipients while sending documents for signature. schema: type: string - name: completed_documents_only in: query description: 'Reserved for DocuSign. ' schema: type: string - name: merge_roles_on_draft in: query description: 'When set to **true**, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.) ###### Note: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.' schema: type: string - name: tab_label_exact_matches in: query description: 'Reserved for DocuSign. ' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/envelopeDefinition' application/xml: schema: $ref: '#/components/schemas/envelopeDefinition' required: false responses: '201': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/envelopeSummary' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: createEnvelope x-ds-method: create x-ds-service: Envelopes x-ds-in-sdk: true x-ds-examples: - description: 'This example shows a request/response that includes: * A single PDF document to be signed * One tab positioned using anchor text * One recipient See [Requesting a Signature via Email](/esign/guide/usage/request_a_signature.html) for a full walkthrough of this example. ' direction: both format: json response: envelopeId: 63e05468-6432-41d2-b01c-8b48f7dbeb80 status: sent statusDateTime: 2016-05-29 17:11:56.180000+00:00 uri: /envelopes/63e05468-6432-41d2-b01c-8b48f7dbeb80 request: documents: - documentBase64: '[Document content (PDF File)]' documentId: '1' fileExtension: pdf name: NDA.pdf emailSubject: Please sign the NDA recipients: signers: - email: the_nda_signer@example.com name: Darlene Petersen recipientId: '1' routingOrder: '1' tabs: dateSignedTabs: - anchorString: signer1date anchorYOffset: '-6' fontSize: Size12 name: Date Signed recipientId: '1' tabLabel: date_signed fullNameTabs: - anchorString: signer1name anchorYOffset: '-6' fontSize: Size12 name: Full Name recipientId: '1' tabLabel: Full Name signHereTabs: - anchorString: signer1sig anchorUnits: mms anchorXOffset: '0' anchorYOffset: '0' name: Please sign here optional: 'false' recipientId: '1' scaleValue: 1 tabLabel: signer1sig status: sent style: custom title: Request Signature on Single Document by Email - description: 'This example shows a request/response that includes: * Multiple documents, both pdf and Word docx files. * Multiple tabs including signing, fullName, dateSigned, and text tabs. * Tabs positioned using anchor text. * Two recipients, a signer and a cc recipient. For more information, and to try this request live, see the [API Recipe](https://www.docusign.com/developer-center/recipes/send-multiple-docs) ' direction: both format: json response: envelopeId: 63e05468-6432-41d2-b01c-8b48f7dbeb80 status: sent statusDateTime: 2016-05-29 17:11:56.180000+00:00 uri: /envelopes/63e05468-6432-41d2-b01c-8b48f7dbeb80 request: documents: - documentBase64: '[Document 1 content (PDF File)]' documentId: '1' fileExtension: pdf name: NDA.pdf - documentBase64: '[Document 2 content (PDF File)]' documentId: '2' fileExtension: pdf name: House.pdf - documentBase64: '[Document 3 content (Word file)]' documentId: '3' fileExtension: docx name: contractor_agreement.docx emailSubject: Please sign the house documentation package recipients: carbonCopies: - email: cody_vigil@worldwidecorp.example.com name: Cody Vigil recipientId: '2' routingOrder: '2' signers: - email: darlene_petersen@newco.example.com name: Darlene Petersen recipientId: '1' routingOrder: '1' tabs: dateSignedTabs: - anchorString: signer1date anchorYOffset: '-6' fontSize: Size12 name: Date Signed recipientId: '1' tabLabel: date_signed - documentId: '2' fontSize: Size12 name: Date Signed pageNumber: '1' recipientId: '1' tabLabel: doc3_date_signed xPosition: '89' yPosition: '100' fullNameTabs: - anchorString: signer1name anchorYOffset: '-6' fontSize: Size12 name: Full Name recipientId: '1' tabLabel: Full Name signHereTabs: - anchorString: signer1sig anchorUnits: mms anchorXOffset: '0' anchorYOffset: '0' name: Please sign here optional: 'false' recipientId: '1' scaleValue: 1 tabLabel: signer1sig - documentId: '2' name: Please sign here optional: 'false' pageNumber: '1' recipientId: '2' scaleValue: 1 tabLabel: signer1_doc2 xPosition: '89' yPosition: '40' - anchorString: Client Signature anchorUnits: mms anchorXOffset: '0' anchorYOffset: '-4' name: Please sign here optional: 'false' recipientId: '1' scaleValue: 1 tabLabel: doc3_client_sig textTabs: - anchorString: signer1company anchorYOffset: '-8' fontSize: Size12 name: Company recipientId: '1' required: 'true' tabLabel: Company - anchorString: Client Name anchorYOffset: '-38' fontSize: Size12 name: Company recipientId: '1' required: 'true' tabLabel: Company - documentId: '3' fontSize: Size10 name: Company pageNumber: '1' recipientId: '1' required: 'true' tabLabel: Company xPosition: '145' yPosition: '195' status: sent style: custom title: Multiple Documents and Tabs, Signer and CC Recipients - description: 'For some documents, one or more signatures must be witnessed by an appointed [notary public](https://en.wikipedia.org/wiki/Notary_public). DocuSign supports eNotary services for many jurisdictions. This example demonstrates how to send an envelope to be signed by Susan Signer with her signature witnessed by Nancy Notary. You must know the name and email address of the signer and the notary public for a signature to be notarized. Note that the full legal name of the signer must be used. It will be checked against the signer''s government-issued proof of identity by the notary public. Please see the [DocuSign eNotary resource page](https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources) for further information. It lists the jurisdictions participating in the DocuSign eNotary program and additional reference information. Note that eNotary services are not included with all account types and are **not** included by default with demo/developer sandbox accounts. To enable eNotary service for your sandbox account, contact your DocuSign technical support person or DocuSign customer service. The example includes event notification via the Connect service.' direction: both format: json response: envelopeId: aaaaaaaa-41c4-4d21-b6e4-52a86fb94be8 uri: /envelopes/aaaaaaaa-41c4-4d21-b6e4-52a86fb94be8 statusDateTime: 2017-06-15 11:02:39.399643+00:00 status: sent request: emailSubject: Important agreement for notarized signature status: sent recipients: inPersonSigners: - recipientId: 1 email: susan_signer@gmail.com name: Susan Anne Signer routingOrder: 1 inPersonSigningType: notary notaryHost: name: Nancy Notary email: nancy@notary-svc.com recipientId: 2 tabs: signHereTabs: - documentId: '1' optional: 'false' recipientId: '1' xPosition: '100' yPosition: '100' pageNumber: '1' name: Please sign here tabLabel: signer1sig documents: - documentId: '1' name: important document.docx fileExtension: docx documentBase64: '[Contents elided]' eventNotification: includeDocumentFields: 'false' envelopeEvents: - envelopeEventStatusCode: Completed - envelopeEventStatusCode: Declined - envelopeEventStatusCode: Voided url: https://listener.example.com/docusign_notifications requireAcknowledgment: 'true' includeSenderAccountAsCustomField: 'true' loggingEnabled: 'true' includeDocuments: 'false' signMessageWithX509Cert: 'true' style: custom title: Create a Notarized Signing Recipient - description: "DocuSign enables document signers use\n[electronic](https://www.docusign.com/products/electronic-signature) or\n[digital](https://www.docusign.com/how-it-works/electronic-signature/digital-signature) signatures.\n\nDocuSign has tightly integrated standard digital signatures into the DocuSign Signature platform. This enables a single envelope to include:\n\n* electronic signatures,\n* AES digital signatures using certificates from DocuSign or from your organization,\n* QES digital signatures from government certified Trust Service Providers (TSPs).\n\nThis example enables the signer to create an eIDAS compliant AES signature with embedded signing. InPerson signers can also use SBS digital signatures.\n\n[More information on creating SBS digital signature requests.](../../../../guide/appendix/standards_based_signatures.html)\n\nThe `clientId` in the example tells DocuSign that the Signing Ceremony will be embedded.\nThe example also includes an `eventNotification` object for receiving envelope status updates from DocuSign.\n\n## Embedding the signing ceremony\n1. Send the `Envelopes: create` call as shown below in the Request/Response section.\n2. The response will include the `envelopeId`\n3. Use the [EnvelopeViews: createRecipient](../../EnvelopeViews/createRecipient) request to obtain the redirectURL as follows:\n\n`POST /v2/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`\n\n````\n{\n \"clientUserId\": \"1000\",\n \"email\": \"Sam@spade.com\",\n \"userName\": \"Sam Spade\",\n \"returnUrl\": \"https://your_app.example.com\",\n \"AuthenticationMethod\": \"Password\"\n}\n````\nThe response will include the `url`. Redirect the user's browser to the url to start the signing ceremony.\n\n###### Note: You must **immediately** redirect the user to the url you receive from DocuSign. The url is only valid for 5 minutes. Don't request a recipient view url until you are ready to redirect the user's browser.\n" direction: both format: json response: envelopeId: caaaaaaa-144e-45ce-8e8e-c171528e99c8 uri: /envelopes/caaaaaaa-144e-45ce-8e8e-c171528e99c8 statusDateTime: 2017-06-22 06:44:49.164222+00:00 status: sent request: documents: - documentId: '1' name: ' Agreement' fileExtension: html documentBase64: '[Contents elided]' emailSubject: NewCo agreement for signature status: sent recipients: signers: - recipientId: '1' clientUserId: '1000' email: Sam@spade.com name: Sam Spade recipientSignatureProviders: - signatureProviderName: UniversalSignaturePen_OpenTrust_Hash_TSP signatureProviderOptions: SMS: '+33134567899' routingOrder: '1' tabs: signHereTabs: - documentId: '1' optional: 'false' recipientId: '1' name: Please sign here tabLabel: signer1sig anchorString: signer1sig eventNotification: includeDocumentFields: 'false' envelopeEvents: - envelopeEventStatusCode: Completed - envelopeEventStatusCode: Declined - envelopeEventStatusCode: Voided url: https://your_app.example.com/listener requireAcknowledgment: 'true' includeSenderAccountAsCustomField: 'true' loggingEnabled: 'true' includeDocuments: 'false' signMessageWithX509Cert: 'true' style: custom title: Request an SBS digital signature, with an embedded signing ceremony x-codegen-request-body-name: envelopeDefinition /v2/accounts/{accountId}/envelopes/{envelopeId}: get: tags: - Envelopes summary: Docusign Gets the status of a single envelope. description: 'Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use [Envelope: listStatusChanges ](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/)' operationId: Envelopes_GetEnvelope parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: advanced_update in: query description: When true, envelope information can be added or modified. schema: type: string - name: include in: query description: 'Reserved for DocuSign. ' schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/envelope' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getEnvelope x-ds-method: get x-ds-service: Envelopes x-ds-in-sdk: true x-ds-examples: - description: 'This example shows a how to get information about an envelope with a given envelope id. The request for this endpoint has no payload. ### Request ``` GET /restapi/v2/accounts/1703061/envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6 ``` ' direction: response format: json response: allowMarkup: 'false' autoNavigation: 'true' brandId: 56502fe1-3245-4cf5-8d74-97cb5c43176a certificateUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate createdDateTime: 2016-10-05 01:04:58.183000+00:00 customFieldsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields documentsCombinedUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined documentsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents emailSubject: Please sign the NDA enableWetSign: 'true' envelopeId: 4b728be4-4417-45c6-b7e8-d63e23f822b6 envelopeIdStamping: 'true' envelopeUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6 initialSentDateTime: 2016-10-05 01:04:58.777000+00:00 is21CFRPart11: 'false' isSignatureProviderEnvelope: 'false' lastModifiedDateTime: 2016-10-05 01:04:58.183000+00:00 notificationUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification purgeState: unpurged recipientsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients sentDateTime: 2016-10-05 01:04:58.777000+00:00 status: sent statusChangedDateTime: 2016-10-05 01:04:58.777000+00:00 templatesUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates style: custom title: Get Status About a Specific Envelope - description: 'This example shows a how to get information about envelopes created since January 1, 2016. The request for this endpoint has no payload. ### Request ``` GET /restapi/v2/accounts/1703061/envelopes?from_date=2016-01-01 ``` ' direction: response format: json response: endPosition: '1' envelopes: - certificateUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/certificate customFieldsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/custom_fields documentsCombinedUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/combined documentsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents envelopeId: 379497bb-cc85-4654-bab9-a8e397f538d0 envelopeUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0 notificationUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/notification recipientsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/recipients status: completed statusChangedDateTime: 2016-10-04 15:26:28.283000+00:00 templatesUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/templates - certificateUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate customFieldsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields documentsCombinedUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined documentsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents envelopeId: 4b728be4-4417-45c6-b7e8-d63e23f822b6 envelopeUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6 notificationUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification recipientsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients status: sent statusChangedDateTime: 2016-10-05 01:04:58.777000+00:00 templatesUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates nextUri: '' previousUri: '' resultSetSize: '2' startPosition: '0' totalSetSize: '2' style: custom title: Get Status About Envelopes Since a Specified Date put: tags: - Envelopes summary: Docusign Send, void, or modify a draft envelope. Purge documents from a completed envelope. description: "This method lets you make changes to an envelope.\nYou can use it to:\n\n* Send a draft envelope\n* Void an in-process envelope\n* Modify a draft envelope\n* Purge documents and envelope metadata from the DocuSign platform\n\n\n
\n

\n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nproperties that\nyou're updating. \n\n

\n
\n\n\n## Sending a Draft Envelope\n\nTo send a draft envelope, include this in the request body:\n\n```json\n{\n \"status\": \"sent\"\n}\n```\n\n\n## Voiding an In-Process Envelope\n\nTo void an in-process envelope, include this in the request body:\n\n```json\n{\n \"status\": \"voided\",\n \"voidedReason\": \"The reason for voiding the envelope\"\n}\n```\n\n## Modifying Envelope Email Information\n\nTo change the email subject and message of a draft envelope,\ninclude this in the request body:\n\n```json\n{\n \"emailSubject\": \"new email subject\",\n \"emailBlurb\": \"new email message\"\n}\n```\n\n## Purging Documents from DocuSign\n\n\nTo place only the documents\nin the purge queue,\nleaving any\ncorresponding attachments \nand tabs in the DocuSign platform,\nset the `purgeState` property\nto `documents_queued`.\n\n\n```json\n{\n \"purgeState\": \"documents_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue,\nset the `purgeState` property\nto `documents_and_metadata_queued`.\n\n```json\n{\n \"purgeState\": \"documents_and_metadata_queued\"\n}\n```\n\n\nYou can purge documents\nonly from completed envelopes\nthat are not marked as the authoritative copy.\nThe user requesting the purge\nmust have permission to purge documents\nand\nmust be the sender or be acting on behalf of the sender.\n\n\n\nWhen the purge request is initiated\nthe items to be purged\nare placed in the purge queue\nfor deletion in 14 days.\nThe sender\nand\nall recipients with DocuSign accounts\nassociated with the envelope\nget an email notification\nthe the documents will be deleted in 14 days.\nThe notification contains a link\nto the documents.\nA second email notification\nis sent 7 days later.\nAt the end of the 14-day period\nthe documents are deleted from the system.\nRecipients without DocuSign accounts\ndo not receive email notifications.\n\n\nIf your account has a Document Retention policy,\nenvelope documents\nare automatically placed\nin the purge queue,\nand notification emails are sent\nat the end of the retention period.\nSetting a Document Retention policy is the same as setting a\nschedule for purging documents.\n" operationId: Envelopes_PutEnvelope parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: advanced_update in: query description: When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. schema: type: string - name: resend_envelope in: query description: When set to **true**, sends the specified envelope again. schema: type: string requestBody: description: A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients. content: application/json: schema: $ref: '#/components/schemas/envelope' application/xml: schema: $ref: '#/components/schemas/envelope' required: false responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/envelopeUpdateSummary' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: update x-ds-method: update x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: envelope /v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events: get: tags: - Envelopes summary: Docusign Gets the envelope audit events for an envelope. description: Gets the envelope audit events for the specified envelope. operationId: AuditEvents_GetAuditEvents parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/envelopeAuditEventResponse' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: listAuditEvents x-ds-method: listAuditEvents x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages: get: tags: - Envelopes summary: Docusign Returns document page image(s) based on input. operationId: Pages_GetPageImages parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: documentId in: path description: The ID of the document being accessed. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: count in: query description: The maximum number of results to be returned by this request. schema: type: string - name: dpi in: query description: Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310. schema: type: string - name: max_height in: query description: Sets the maximum height (in pixels) of the returned image. schema: type: string - name: max_width in: query description: Sets the maximum width (in pixels) of the returned image. schema: type: string - name: nocache in: query schema: type: string - name: show_changes in: query schema: type: string - name: start_position in: query description: The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/pageImages' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getDocumentPageImages x-ds-method: getPageImages x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}: delete: tags: - Envelopes summary: Docusign Deletes a page from a document in an envelope. description: Deletes a page from a document in an envelope based on the page number. operationId: Pages_DeletePage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: documentId in: path description: The ID of the document being accessed. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: pageNumber in: path description: The page number being accessed. required: true schema: type: string responses: '200': description: Successful response. content: {} '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: deleteDocumentPage x-ds-method: deleteDocumentPage x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image: get: tags: - Envelopes summary: Docusign Gets a page image from an envelope for display. description: Retrieves a page image for display from the specified envelope. operationId: Pages_GetPageImage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: documentId in: path description: The ID of the document being accessed. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: pageNumber in: path description: The page number being accessed. required: true schema: type: string - name: dpi in: query description: Sets the dpi for the image. schema: type: string - name: max_height in: query description: Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting. schema: type: string - name: max_width in: query description: Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting. schema: type: string - name: show_changes in: query schema: type: string responses: '200': description: Successful response. content: image/png: schema: type: string format: binary '400': description: Error encountered. content: image/png: schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getDocumentPageImage x-ds-method: getPageImage x-ds-service: Envelopes x-ds-in-sdk: true put: tags: - Envelopes summary: Docusign Rotates page image from an envelope for display. description: Rotates page image from an envelope for display. The page image can be rotated to the left or right. operationId: Pages_PutPageImage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: documentId in: path description: The ID of the document being accessed. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: pageNumber in: path description: The page number being accessed. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pageRequest' application/xml: schema: $ref: '#/components/schemas/pageRequest' required: false responses: '200': description: Successful response. content: {} '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: rotateDocumentPage x-ds-method: rotateDocumentPage x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: pageRequest /v2/accounts/{accountId}/envelopes/{envelopeId}/notification: get: tags: - Envelopes summary: Docusign Gets envelope notification information. description: Retrieves the envelope notification, reminders and expirations, information for an existing envelope. operationId: Notification_GetEnvelopesEnvelopeIdNotification parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/notification' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getNotificationSettings x-ds-method: getNotificationSettings x-ds-service: Envelopes x-ds-in-sdk: true put: tags: - Envelopes summary: Docusign Sets envelope notification (Reminders/Expirations) structure for an existing envelope. operationId: Notification_PutEnvelopesEnvelopeIdNotification parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/envelopeNotificationRequest' application/xml: schema: $ref: '#/components/schemas/envelopeNotificationRequest' required: false responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/notification' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: updateNotificationSettings x-ds-method: updateNotificationSettings x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: envelopeNotificationRequest /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image: get: tags: - Envelopes summary: Docusign Gets the initials image for a user. description: "Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account.\n\nThe `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image." operationId: Recipients_GetRecipientInitialsImage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: recipientId in: path description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: true schema: type: string - name: include_chrome in: query description: 'The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.' schema: type: string responses: '200': description: Successful response. content: image/gif: schema: type: string format: binary '400': description: Error encountered. content: image/gif: schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getRecipientInitialsImage x-ds-method: getRecipientInitialsImage x-ds-service: Envelopes x-ds-in-sdk: true put: tags: - Envelopes summary: Docusign Sets the initials image for an accountless signer. description: 'Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.' operationId: Recipients_PutRecipientInitialsImage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: recipientId in: path description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: true schema: type: string responses: '200': description: Successful response. content: {} '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: updateRecipientInitialsImage x-ds-method: updateRecipientInitialsImage x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature: get: tags: - Envelopes summary: Docusign Gets signature information for a signer or sign-in-person recipient. description: Retrieves signature information for a signer or sign-in-person recipient. operationId: Recipients_GetRecipientSignature parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: recipientId in: path description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: true schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/userSignature' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getRecipientSignature x-ds-method: getRecipientSignature x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image: get: tags: - Envelopes summary: Docusign Retrieve signature image information for a signer/sign-in-person recipient. description: "Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image." operationId: Recipients_GetRecipientSignatureImage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: recipientId in: path description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: true schema: type: string - name: include_chrome in: query description: When set to **true**, indicates the chromed version of the signature image should be retrieved. schema: type: string responses: '200': description: Successful response. content: image/gif: schema: type: string format: binary '400': description: Error encountered. content: image/gif: schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getRecipientSignatureImage x-ds-method: getRecipientSignatureImage x-ds-service: Envelopes x-ds-in-sdk: true put: tags: - Envelopes summary: Docusign Sets the signature image for an accountless signer. description: 'Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.' operationId: Recipients_PutRecipientSignatureImage parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: recipientId in: path description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: true schema: type: string responses: '200': description: Successful response. content: {} '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: updateRecipientSignatureImage x-ds-method: updateRecipientSignatureImage x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/status: put: tags: - Envelopes summary: Docusign Gets the envelope status for the specified envelopes. description: Retrieves the envelope status for the specified envelopes. operationId: Envelopes_PutStatus parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: ac_status in: query description: 'Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.' schema: type: string - name: block in: query description: 'Reserved for DocuSign. ' schema: type: string - name: count in: query description: The maximum number of results to be returned by this request. schema: type: string - name: email in: query description: 'Reserved for DocuSign. ' schema: type: string - name: envelope_ids in: query description: Comma separated list of `envelopeId` values. schema: type: string - name: from_date in: query description: "The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are set. \n\n****Note****: This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified." schema: type: string - name: from_to_status in: query description: "The status value checked for in the `from_date` to `to_date` time period. \n\nPossible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.\n\nIf `Changed` is specified, then envelopes that changed status during the period will be returned. \n\nFor example, if `Created` is specified, then envelopes created during the period are found. \n\nThe default is `Changed`. " schema: type: string - name: start_position in: query description: 'Reserved for DocuSign. ' schema: type: string - name: status in: query description: Item status. schema: type: string - name: to_date in: query description: "Optional date/time setting\nthat specifies the last date/time \nor envelope status changes in the result set. \n\nDefault: \"now\", the time that you call the method. \n" schema: type: string - name: transaction_ids in: query description: 'A comma-separated list of envelope transaction IDs. Transaction IDs are only valid for seven days. ' schema: type: string - name: user_name in: query description: 'Limit results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name` must refer to an existing account user. ' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/envelopeIdsRequest' application/xml: schema: $ref: '#/components/schemas/envelopeIdsRequest' required: false responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/envelopesInformation' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: listStatus x-ds-method: listStatus x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: envelopeIdsRequest components: schemas: samlAssertionAttribute: type: object properties: errorDetails: $ref: '#/components/schemas/errorDetails' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' value: type: string description: The value associated with the named SAML assertion attribute description: '' x-ds-definition-name: samlAssertionAttribute x-ms-summary: '' ListTab: type: object description: A dropdown list tab for selecting from predefined options. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value value: type: string example: example_value listItems: type: array items: type: object properties: text: type: string value: type: string selected: type: string example: [] required: type: string example: example_value company: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s company name. ' x-ds-definition-name: company x-ms-summary: 'A tab that displays the recipient''s company name. ' serverTemplate: type: object properties: sequence: type: string description: '' templateId: type: string description: 'The unique identifier of the template. If this is not provided, DocuSign will generate a value. ' description: '' x-ds-definition-name: serverTemplate x-ms-summary: '' recipientProofFile: type: object properties: isInProofFile: type: string description: '' description: '' x-ds-definition-name: recipientProofFile x-ms-summary: '' radioGroup: type: object properties: conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. groupName: type: string description: The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. radios: type: array description: Specifies the locations and status for radio buttons that are grouped together. items: $ref: '#/components/schemas/radio' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. shared: type: string description: When set to **true**, this custom tab is shared. templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' description: 'This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio) objects associated with the group. Only one radio button can be selected in a group. ' x-ds-definition-name: radioGroup x-ms-summary: 'This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio) objects associated with the group. Only one radio button can be selected in a group. ' DateSigned: type: object description: A tab that displays the date the recipient signed. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value value: type: string example: example_value compositeTemplate: type: object properties: compositeTemplateId: type: string description: The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. document: $ref: '#/components/schemas/document' inlineTemplates: type: array description: ' Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.' items: $ref: '#/components/schemas/inlineTemplate' pdfMetaDataTemplateSequence: type: string description: '' serverTemplates: type: array description: 0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value items: $ref: '#/components/schemas/serverTemplate' description: '' x-ds-definition-name: compositeTemplate x-ms-summary: '' EnvelopeSummary: type: object description: Summary information about a newly created envelope. properties: envelopeId: type: string format: uuid description: The unique identifier of the created envelope. example: '500123' uri: type: string description: The URI for the envelope. example: example_value statusDateTime: type: string format: date-time description: The date and time of the status change. example: '2026-01-15T10:30:00Z' status: type: string description: The status of the envelope. example: example_value dobInformationInput: type: object properties: dateOfBirth: type: string description: Specifies the recipient's date, month, and year of birth. displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" receiveInResponse: type: string description: When set to **true**, the information needs to be returned in the response. description: 'Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse' x-ds-definition-name: dobInformationInput x-ms-summary: 'Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse' dateSigned: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the date that the recipient signed the document. ' x-ds-definition-name: dateSigned x-ms-summary: 'A tab that displays the date that the recipient signed the document. ' ssn4InformationInput: type: object properties: displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" receiveInResponse: type: string description: When set to **true**, the information needs to be returned in the response. ssn4: type: string description: The last four digits of the recipient's Social Security Number (SSN). description: '' x-ds-definition-name: ssn4InformationInput x-ms-summary: '' TemplateRole: type: object description: Maps a recipient to a role defined in a template. Used when creating an envelope from a template. properties: name: type: string description: The recipient's full name. example: Example Title email: type: string format: email description: The recipient's email address. example: user@example.com roleName: type: string description: The role name that matches a role defined in the template. example: example_value clientUserId: type: string description: The client user ID for embedded signing. example: '500123' defaultRecipient: type: string description: When true, this is the default recipient for the role. example: example_value routingOrder: type: string description: The routing order for the recipient. example: example_value accessCode: type: string description: Access code for authentication. example: example_value tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' emailNotification: $ref: '#/components/schemas/RecipientEmailNotification' envelopeNotificationRequest: type: object properties: expirations: $ref: '#/components/schemas/expirations' reminders: $ref: '#/components/schemas/reminders' useAccountDefaults: type: string description: When set to **true**, the account default notification settings are used for the envelope. description: '' x-ds-definition-name: envelopeNotificationRequest x-ms-summary: '' Envelope: type: object description: Contains the properties of an envelope. properties: envelopeId: type: string format: uuid description: The unique identifier of the envelope. example: '500123' envelopeUri: type: string description: The URI for retrieving the envelope. example: example_value status: type: string description: Current status of the envelope. enum: - created - sent - delivered - signed - completed - declined - voided - deleted - timedout - processing - template example: created statusChangedDateTime: type: string format: date-time description: The date and time the status last changed. example: '2026-01-15T10:30:00Z' emailSubject: type: string description: The subject line of the envelope email. example: user@example.com emailBlurb: type: string description: The body text of the envelope email. example: user@example.com createdDateTime: type: string format: date-time description: The date and time the envelope was created. example: '2026-01-15T10:30:00Z' sentDateTime: type: string format: date-time description: The date and time the envelope was sent. example: '2026-01-15T10:30:00Z' deliveredDateTime: type: string format: date-time description: The date and time the envelope was delivered. example: '2026-01-15T10:30:00Z' completedDateTime: type: string format: date-time description: The date and time the envelope was completed. example: '2026-01-15T10:30:00Z' voidedDateTime: type: string format: date-time description: The date and time the envelope was voided. example: '2026-01-15T10:30:00Z' voidedReason: type: string description: The reason the envelope was voided. example: example_value declinedDateTime: type: string format: date-time description: The date and time the envelope was declined. example: '2026-01-15T10:30:00Z' sender: $ref: '#/components/schemas/UserInfo' recipients: $ref: '#/components/schemas/Recipients' documents: type: array items: $ref: '#/components/schemas/Document' example: [] customFields: $ref: '#/components/schemas/CustomFields' notification: $ref: '#/components/schemas/Notification' purgeState: type: string description: Purge state of the envelope. enum: - unpurged - documents_queued - documents_dequeued - documents_purged - documents_and_metadata_queued - documents_and_metadata_purged example: unpurged brandId: type: string description: The ID of the brand applied to the envelope. example: '500123' certificateUri: type: string description: URI for retrieving the certificate of completion. example: example_value isSignatureProviderEnvelope: type: string description: Whether this envelope uses a signature provider. example: example_value signingLocation: type: string description: The signing location. Valid values are inPerson and online. enum: - inPerson - online example: inPerson expireEnabled: type: string description: Whether the envelope expiration is enabled. example: example_value expireDateTime: type: string format: date-time description: The date and time the envelope expires. example: '2026-01-15T10:30:00Z' expireAfter: type: string description: Number of days after which the envelope expires. example: example_value autoNavigation: type: string description: Whether auto-navigation is enabled for recipients. example: example_value anySigner: type: string description: Reserved for DocuSign use. example: example_value editor: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' lastName: type: string description: The recipient's last name. name: type: string description: 'legal name of the recipient. Maximum Length: 100 characters.' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: editor x-ms-summary: '' documentHtmlDisplaySettings: type: object properties: cellStyle: type: string description: '' collapsibleSettings: $ref: '#/components/schemas/documentHtmlCollapsibleDisplaySettings' display: type: string description: "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n" displayLabel: type: string description: '' displayOrder: type: integer description: '' format: int32 displayPageNumber: type: integer description: '' format: int32 hideLabelWhenOpened: type: boolean description: '' inlineOuterStyle: type: string description: '' labelWhenOpened: type: string description: '' preLabel: type: string description: '' scrollToTopWhenOpened: type: boolean description: '' tableStyle: type: string description: '' description: '' x-ds-definition-name: documentHtmlDisplaySettings x-ms-summary: '' errorDetails: type: object properties: errorCode: type: string description: An error code associated with the error. message: type: string description: A short error message. description: This object describes errors that occur. It is only valid for responses, and ignored in requests. x-ds-definition-name: errorDetails x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests. list: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. listItems: type: array description: "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. \n" items: $ref: '#/components/schemas/listItem' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: The value to use when the item is selected. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem) objects to specify the selectable options. ' x-ds-definition-name: list x-ms-summary: 'This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem) objects to specify the selectable options. ' propertyMetadata: type: object properties: options: type: array description: '' items: type: string rights: type: string description: '' description: '' x-ds-definition-name: propertyMetadata x-ms-summary: '' smartSectionDisplaySettings: type: object properties: cellStyle: type: string description: '' collapsibleSettings: $ref: '#/components/schemas/smartSectionCollapsibleDisplaySettings' display: type: string description: "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n" displayLabel: type: string description: '' displayOrder: type: integer description: '' format: int32 displayPageNumber: type: integer description: '' format: int32 hideLabelWhenOpened: type: boolean description: '' inlineOuterStyle: type: string description: '' labelWhenOpened: type: string description: '' preLabel: type: string description: '' scrollToTopWhenOpened: type: boolean description: '' tableStyle: type: string description: '' description: '' x-ds-definition-name: smartSectionDisplaySettings x-ms-summary: '' EnvelopeRecipientTabs: type: object description: Contains the tab collections for an envelope recipient, organized by tab type. properties: signHereTabs: type: array description: Signature tabs requiring the recipient to sign. items: $ref: '#/components/schemas/SignHere' example: [] initialHereTabs: type: array description: Initial tabs requiring the recipient to initial. items: $ref: '#/components/schemas/InitialHere' example: [] dateSignedTabs: type: array description: Date signed tabs auto-filled with the signing date. items: $ref: '#/components/schemas/DateSigned' example: [] textTabs: type: array description: Text input tabs for free-form text entry. items: $ref: '#/components/schemas/Text' example: [] fullNameTabs: type: array description: Full name tabs auto-filled with the signer name. items: $ref: '#/components/schemas/FullName' example: [] emailTabs: type: array description: Email tabs for email address input. items: $ref: '#/components/schemas/EmailTab' example: user@example.com checkboxTabs: type: array description: Checkbox tabs for boolean selection. items: $ref: '#/components/schemas/Checkbox' example: [] radioGroupTabs: type: array description: Radio button group tabs for single-choice selection. items: $ref: '#/components/schemas/RadioGroup' example: [] listTabs: type: array description: List tabs for dropdown selection. items: $ref: '#/components/schemas/ListTab' example: [] numberTabs: type: array description: Number tabs for numeric input. items: $ref: '#/components/schemas/NumberTab' example: [] dateTabs: type: array description: Date tabs for date selection. items: $ref: '#/components/schemas/DateTab' example: [] formulaTabs: type: array description: Formula tabs for calculated values. items: $ref: '#/components/schemas/FormulaTab' example: [] noteTabs: type: array description: Note tabs for displaying read-only text. items: $ref: '#/components/schemas/NoteTab' example: [] approveTabs: type: array description: Approve tabs for document approval. items: $ref: '#/components/schemas/Approve' example: [] declineTabs: type: array description: Decline tabs for document rejection. items: $ref: '#/components/schemas/Decline' example: [] ErrorDetails: type: object description: Contains error information returned by the API. properties: errorCode: type: string description: The error code. example: example_value message: type: string description: A human-readable error message. example: example_value title: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s title. ' x-ds-definition-name: title x-ms-summary: 'A tab that displays the recipient''s title. ' recipientSignatureProviderOptions: type: object properties: cpfNumber: type: string description: Reserved for DocuSign oneTimePassword: type: string description: 'A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer''s government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.' signerRole: type: string description: 'The role or capacity of the signing recipient. Examples: Manager, Approver, etc.' sms: type: string description: 'The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.' description: Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) x-ds-definition-name: recipientSignatureProviderOptions x-ms-summary: Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) EnvelopeRecipients: type: object properties: agents: type: array description: A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. items: $ref: '#/components/schemas/agent' carbonCopies: type: array description: A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. items: $ref: '#/components/schemas/carbonCopy' certifiedDeliveries: type: array description: A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. items: $ref: '#/components/schemas/certifiedDelivery' currentRoutingOrder: type: string description: '' editors: type: array description: A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document. items: $ref: '#/components/schemas/editor' errorDetails: $ref: '#/components/schemas/errorDetails' inPersonSigners: type: array description: Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. items: $ref: '#/components/schemas/inPersonSigner' intermediaries: type: array description: Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). items: $ref: '#/components/schemas/intermediary' recipientCount: type: string description: 'The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message.' seals: type: array description: '' items: $ref: '#/components/schemas/sealSign' signers: type: array description: A complex type containing information about the Signer recipient. items: $ref: '#/components/schemas/signer' witnesses: type: array description: '' items: $ref: '#/components/schemas/witness' description: Envelope recipients x-ds-definition-name: recipients x-ds-category: Envelopes x-ds-order: '20' x-ms-summary: Envelope recipients note: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays additional information, in the form of a note, for the recipient. ' x-ds-definition-name: note x-ms-summary: 'A tab that displays additional information, in the form of a note, for the recipient. ' EnvelopeLocks: type: object properties: errorDetails: $ref: '#/components/schemas/errorDetails' lockDurationInSeconds: type: string description: 'Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended. ' lockedByApp: type: string description: Specifies the friendly name of the application that is locking the envelope. lockedByUser: $ref: '#/components/schemas/userInfo' lockedUntilDateTime: type: string description: The datetime until the envelope lock expires. lockToken: type: string description: A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock. lockType: type: string description: The type of envelope lock. Currently "edit" is the only supported type. useScratchPad: type: string description: "Reserved for future use.\n\nIndicates whether a scratchpad is used for editing information.\n " description: Envelope locks x-ds-definition-name: lockInformation x-ds-category: Envelopes x-ds-order: '80' x-ms-summary: Envelope locks recipientEvent: type: object properties: includeDocuments: type: string description: reserved recipientEventStatusCode: type: string description: 'Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.' description: '' x-ds-definition-name: recipientEvent x-ms-summary: '' recipientSignatureInformation: type: object properties: fontStyle: type: string description: '' signatureInitials: type: string description: '' signatureName: type: string description: Specifies the user signature name. description: 'Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.' x-ds-definition-name: recipientSignatureInformation x-ms-summary: 'Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.' recipientSAMLAuthentication: type: object properties: samlAssertionAttributes: type: array description: '' items: $ref: '#/components/schemas/samlAssertionAttribute' description: "Contains the name/value pair information for the SAML assertion attributes:\n\n* name - The name of the SAML assertion attribute.\n* value - The value associated with the named SAML assertion attribute. \n\nYour account must be set up to use SSO to use this." x-ds-definition-name: recipientSAMLAuthentication x-ms-summary: "Contains the name/value pair information for the SAML assertion attributes:\n\n* name - The name of the SAML assertion attribute.\n* value - The value associated with the named SAML assertion attribute. \n\nYour account must be set up to use SSO to use this." decline: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: ' Specifies the decline text displayed in the tab.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. declineReason: type: string description: The reason the recipient declined the document. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. ' x-ds-definition-name: decline x-ms-summary: 'A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. ' EnvelopesInformation: type: object description: Contains information about the envelopes returned by a list request, including the result set and pagination details. properties: envelopes: type: array description: The list of envelopes matching the query. items: $ref: '#/components/schemas/Envelope' example: [] resultSetSize: type: string description: The number of results in the current set. example: example_value totalSetSize: type: string description: The total number of envelopes matching the query. example: example_value startPosition: type: string description: The starting index position of the current result set. example: example_value endPosition: type: string description: The ending index position of the current result set. example: example_value nextUri: type: string description: URI for the next page of results. example: example_value previousUri: type: string description: URI for the previous page of results. example: example_value recipientSignatureProvider: type: object properties: sealDocumentsWithTabsOnly: type: string description: 'By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document. To apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won''t be sealed. ' sealName: type: string description: 'Indicates the name of the electronic seal to apply on documents. ' signatureProviderName: type: string description: The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) signatureProviderOptions: $ref: '#/components/schemas/recipientSignatureProviderOptions' description: 'An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). ' x-ds-definition-name: recipientSignatureProvider x-ms-summary: 'An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). ' InPersonSigner: type: object description: An in-person signer recipient for face-to-face signing where a host manages the signing session. properties: recipientId: type: string example: '500123' hostName: type: string description: The name of the signing host. example: example_value hostEmail: type: string format: email description: The email of the signing host. example: user@example.com signerName: type: string description: The name of the in-person signer. example: example_value signerEmail: type: string format: email description: The email of the in-person signer. example: user@example.com routingOrder: type: string example: example_value status: type: string example: example_value tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' FullName: type: object description: A tab auto-filled with the recipient full name. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value value: type: string example: example_value date: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. ' x-ds-definition-name: date x-ms-summary: 'A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. ' Recipients: type: object description: Contains the recipient collections for an envelope, organized by recipient type. properties: signers: type: array description: List of signer recipients. items: $ref: '#/components/schemas/Signer' example: [] carbonCopies: type: array description: List of carbon copy recipients who receive a copy of the completed envelope. items: $ref: '#/components/schemas/CarbonCopy' example: [] certifiedDeliveries: type: array description: List of certified delivery recipients who must confirm receipt of the envelope. items: $ref: '#/components/schemas/CertifiedDelivery' example: [] inPersonSigners: type: array description: List of in-person signer recipients for face-to-face signing scenarios. items: $ref: '#/components/schemas/InPersonSigner' example: [] agents: type: array description: List of agent recipients who can designate another person to sign on their behalf. items: $ref: '#/components/schemas/Agent' example: [] editors: type: array description: List of editor recipients who can modify the envelope before it is sent. items: $ref: '#/components/schemas/Editor' example: [] intermediaries: type: array description: List of intermediary recipients who can forward the envelope to another person for signing. items: $ref: '#/components/schemas/Intermediary' example: [] witnesses: type: array description: List of witness recipients who verify the identity of a signer. items: $ref: '#/components/schemas/Witness' example: [] recipientCount: type: string description: The total number of recipients in the envelope. example: example_value currentRoutingOrder: type: string description: The current routing order position. example: example_value attachment: type: object properties: accessControl: type: string description: '' attachmentId: type: string description: '' attachmentType: type: string description: Specifies the type of the attachment for the recipient. data: type: string description: '' label: type: string description: '' name: type: string description: '' remoteUrl: type: string description: '' description: Contains information about an attachment. x-ds-definition-name: attachment x-ms-summary: Contains information about an attachment. paymentLineItem: type: object properties: amountReference: type: string description: 'This is a the `tabLabel` that specifies the amount paid for the line items. ' description: type: string description: 'A sender-defined description of the line item. ' itemCode: type: string description: 'This is the sender-defined SKU, inventory number, or other item code for the line item. ' name: type: string description: 'This is a sender-defined product name, service name, or other designation for the line item. ' description: 'A line item describes details about an individual line item in a payment request. ' x-ds-definition-name: paymentLineItem x-ms-summary: 'A line item describes details about an individual line item in a payment request. ' userInfo: type: object properties: activationAccessCode: type: string description: '' email: type: string description: '' errorDetails: $ref: '#/components/schemas/errorDetails' loginStatus: type: string description: '' sendActivationEmail: type: string description: '' uri: type: string description: '' userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' userName: type: string description: '' userStatus: type: string description: 'Status of the user''s account. One of: * ActivationRequired * ActivationSent * Active * Closed * Disabled ' userType: type: string description: '' description: '' x-ds-definition-name: userInfo x-ms-summary: '' document: type: object properties: applyAnchorTabs: type: string description: Reserved for DocuSign authoritativeCopy: type: boolean description: 'If **true**, this document is considered an authoritative copy. If this property is not set, it gets its value from the envelope''s `authoritativeCopyDefault` property if it''s set, or the envelope''s `authoritativeCopy` property. If **false**, this document is not an authoritative copy regardless of the envelope''s `authoritativeCopyDefault` or `authoritativeCopy` property.' display: type: string description: "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n" documentBase64: type: string description: The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. documentFields: type: array description: '' items: $ref: '#/components/schemas/nameValue' documentId: type: string description: Specifies the document ID of this document. This value is used by tabs to determine which document they appear in. encryptedWithKeyManager: type: string description: "When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n " fileExtension: type: string description: "The file extension type of the document. Non-PDF documents are converted to PDF.\n\nIf the document is not a PDF, `fileExtension` is required.\n\nIf you try to upload a non-PDF document without a `fileExtension`, you will receive an \"unable to load document\" error message. \n " fileFormatHint: type: string description: '' htmlDefinition: $ref: '#/components/schemas/documentHtmlDefinition' includeInDownload: type: string description: "When set to **true**,\nthe document is included in the combined document download. \nThe default value is **true**.\n" matchBoxes: type: array description: "Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. \n\nA matchbox consists of 5 elements:\n\n* pageNumber - The document page number on which the matchbox will appear. \n* xPosition - The x position of the matchbox on a page. \n* yPosition - The y position of the matchbox on a page.\n* width - The width of the matchbox. \n* height - The height of the matchbox. \n" items: $ref: '#/components/schemas/matchBox' name: type: string description: '' order: type: string description: "An optional value that sets the direction order used to sort the item list. \n\nValid values are: \n\n* asc = ascending sort order\n* desc = descending sort order " pages: type: string description: '' password: type: string description: '' remoteUrl: type: string description: 'The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. ' signerMustAcknowledge: type: string description: "Sets how the signer interacts with the supplemental document.\nThe possible values are: \n\n*\t`no_interaction`
\n No recipient action is required. \n\n*\t`view`
\n The recipient is required to view the document. \n\n*\t`accept`
\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. \n\n*\t`view_accept`
\n The recipient is required to view and accept the document. \n\n" templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. transformPdfFields: type: string description: 'When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. ' uri: type: string description: '' description: A document object. x-ds-definition-name: document x-ms-summary: A document object. Notification: type: object description: Envelope notification settings including reminders and expirations. properties: useAccountDefaults: type: string description: When true, use account default notification settings. example: example_value reminders: type: object properties: reminderEnabled: type: string description: When true, reminders are enabled. reminderDelay: type: string description: Days before the first reminder is sent. reminderFrequency: type: string description: Days between subsequent reminders. example: example_value expirations: type: object properties: expireEnabled: type: string description: When true, expiration is enabled. expireAfter: type: string description: Days until the envelope expires. expireWarn: type: string description: Days before expiration to send a warning. example: example_value recipientEmailNotification: type: object properties: emailBody: type: string description: Not applicable emailSubject: type: string description: Not applicable supportedLanguage: type: string description: "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. " description: '' x-ds-definition-name: recipientEmailNotification x-ms-summary: '' envelope: type: object properties: allowMarkup: type: string description: When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this allowReassign: type: string description: When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. allowViewHistory: type: string description: '' asynchronous: type: string description: "When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification." attachmentsUri: type: string description: '' authoritativeCopy: type: string description: 'Specifies whether all documents in this envelope are authoritative copies. A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ' authoritativeCopyDefault: type: string description: 'The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope''s `authoritativeCopy`.' autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. brandId: type: string description: The unique identifier of a brand. brandLock: type: string description: '' certificateUri: type: string description: Retrieves a URI for an endpoint allowing you to easily retrieve certificate information. completedDateTime: type: string description: Specifies the date and time this item was completed. copyRecipientData: type: string description: '' createdDateTime: type: string description: Indicates the date and time the item was created. customFields: $ref: '#/components/schemas/AccountCustomFields' customFieldsUri: type: string description: Contains a URI for an endpoint to retrieve the custom fields. declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. deletedDateTime: type: string description: Specifies the data and time the item was deleted. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' disableResponsiveDocument: type: string description: '' documentsCombinedUri: type: string description: '' documentsUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the documents. emailBlurb: type: string description: '' emailSettings: $ref: '#/components/schemas/emailSettings' emailSubject: type: string description: 'Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.' enableWetSign: type: string description: When set to **true**, the signer is allowed to print the document and sign it on paper. enforceSignerVisibility: type: string description: 'When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. ###### Note: Your account must have Document Visibility enabled to use this.' envelopeId: type: string description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' envelopeIdStamping: type: string description: When set to **true**, Envelope ID Stamping is enabled. envelopeUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. initialSentDateTime: type: string description: '' is21CFRPart11: type: string description: When set to **true**, indicates that this module is enabled on the account. isSignatureProviderEnvelope: type: string description: '' lastModifiedDateTime: type: string description: The date and time the item was last modified. lockInformation: $ref: '#/components/schemas/EnvelopeLocks' messageLock: type: string description: "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope." notification: $ref: '#/components/schemas/notification' notificationUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the notifications. purgeState: type: string description: 'Shows the current purge state for the envelope. The possible values are: * `unpurged`: There has been no successful request to purge documents. * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. * `documents_dequeued`: The envelope documents have been taken out of the purge queue. * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. * `documents_purged`: The envelope documents have been successfully purged. * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. ' recipients: $ref: '#/components/schemas/EnvelopeRecipients' recipientsLock: type: string description: When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. recipientsUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the recipients. sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signerCanSignOnMobile: type: string description: '' signingLocation: type: string description: Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. status: type: string description: Item status. statusChangedDateTime: type: string description: The data and time the status changed. templatesUri: type: string description: Contains a URI for an endpoint which you can use to retrieve the templates. transactionId: type: string description: Specifies the Transaction ID from the AppStore. useDisclosure: type: string description: "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information." voidedDateTime: type: string description: The date and time the envelope or template was voided. voidedReason: type: string description: The reason the envelope or template was voided. description: '' x-ds-definition-name: envelope x-ms-summary: '' witness: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. agentCanEditEmail: type: string description: '' agentCanEditName: type: string description: '' autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. bulkRecipientsUri: type: string description: 'The URL for the bulk recipient file with the bulk recipient information for this envelope, if applicable. This information is read only and is only shown after the bulk recipient file is uploaded to the envelope by using the PUT method. ' canSignOffline: type: string description: When set to **true**, specifies that the signer can perform the signing ceremony offline. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " creationReason: type: string description: The reason why the recipient was created (for example, `sender`). Read only. customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. defaultRecipient: type: string description: When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: '' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' isBulkRecipient: type: string description: "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. \n" lastName: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' offlineAttributes: $ref: '#/components/schemas/offlineAttributes' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' recipientSuppliesTabs: type: string description: When set to **true**, specifies that the recipient creates the tabs. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' requireSignerCertificate: type: string description: "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate." requireSignOnPaper: type: string description: When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signatureInfo: $ref: '#/components/schemas/recipientSignatureInformation' signedDateTime: type: string description: Reserved for DocuSign. signInEachLocation: type: string description: When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: Item status. tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' witnessFor: type: string description: '' witnessForGuid: type: string description: '' description: '' x-ds-definition-name: witness x-ms-summary: '' reminders: type: object properties: reminderDelay: type: string description: An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. reminderEnabled: type: string description: When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. reminderFrequency: type: string description: An interger that sets the interval, in days, between reminder emails. description: A complex element that specifies reminder settings for the envelope x-ds-definition-name: reminders x-ms-summary: A complex element that specifies reminder settings for the envelope pageRequest: type: object properties: password: type: string description: '' rotate: type: string description: 'Sets the direction the page image is rotated. The possible settings are: left or right' description: '' x-ds-definition-name: pageRequest x-ms-summary: '' EnvelopeDefinition: type: object description: The envelope definition object that contains all the properties needed to create and send an envelope. properties: emailSubject: type: string description: The subject line of the email sent to recipients. maxLength: 10000 example: user@example.com emailBlurb: type: string description: The body text of the email sent to recipients. example: user@example.com status: type: string description: The envelope status. Set to "sent" to send the envelope immediately, or "created" to save as a draft. enum: - created - sent example: created templateId: type: string description: The ID of a template to use as the basis for the envelope. When specified, the template's documents, recipients, and tabs are merged with any specified in the request. example: '500123' templateRoles: type: array description: Template role assignments that map recipients to template roles when using a templateId. items: $ref: '#/components/schemas/TemplateRole' example: [] documents: type: array description: The documents to include in the envelope. items: $ref: '#/components/schemas/Document' example: [] recipients: $ref: '#/components/schemas/Recipients' compositeTemplates: type: array description: An array of composite template objects that combine server templates and inline templates for complex workflows. items: $ref: '#/components/schemas/CompositeTemplate' example: [] notification: $ref: '#/components/schemas/Notification' customFields: $ref: '#/components/schemas/CustomFields' brandId: type: string description: The ID of the brand to apply to the envelope. example: '500123' envelopeIdStamping: type: string description: When true, the envelope ID is stamped in the document margins. example: example_value eventNotification: $ref: '#/components/schemas/EventNotification' ssn9InformationInput: type: object properties: displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" ssn9: type: string description: ' The recipient''s Social Security Number(SSN).' description: '' x-ds-definition-name: ssn9InformationInput x-ms-summary: '' envelopeId: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. ' x-ds-definition-name: envelopeId x-ms-summary: 'A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. ' intermediary: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' lastName: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: intermediary x-ms-summary: '' listCustomField: type: object properties: configurationType: type: string description: If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. errorDetails: $ref: '#/components/schemas/errorDetails' fieldId: type: string description: An ID used to specify a custom field. listItems: type: array description: '' items: type: string name: type: string description: The name of the custom field. required: type: string description: When set to **true**, the signer is required to fill out this tab show: type: string description: 'A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ' value: type: string description: 'The value of the custom field. Maximum Length: 100 characters.' description: '' x-ds-definition-name: listCustomField x-ms-summary: '' recipientAttachment: type: object properties: attachmentId: type: string description: '' attachmentType: type: string description: '' data: type: string description: '' label: type: string description: '' name: type: string description: '' remoteUrl: type: string description: '' description: '' x-ds-definition-name: recipientAttachment x-ms-summary: '' SignHere: type: object description: A signature tab placed on a document. properties: tabId: type: string description: Unique identifier for the tab. example: '500123' tabLabel: type: string description: Label used to identify the tab. example: example_value documentId: type: string description: The document ID where this tab is placed. example: '500123' pageNumber: type: string description: The page number where this tab is placed. example: example_value recipientId: type: string description: The recipient this tab is assigned to. example: '500123' xPosition: type: string description: The X position of the tab on the page. example: example_value yPosition: type: string description: The Y position of the tab on the page. example: example_value anchorString: type: string description: Anchor text string used to automatically position the tab. example: example_value anchorXOffset: type: string description: X offset from the anchor string position. example: example_value anchorYOffset: type: string description: Y offset from the anchor string position. example: example_value anchorUnits: type: string description: Units for anchor offsets (pixels, inches, mms, cms). example: example_value scaleValue: type: string description: Scale value for the signature. example: example_value optional: type: string description: When true, the tab is optional for the recipient. example: example_value stampType: type: string description: The type of stamp for the signature. example: example_value inlineTemplate: type: object properties: customFields: $ref: '#/components/schemas/AccountCustomFields' documents: type: array description: Complex element contains the details on the documents in the envelope. items: $ref: '#/components/schemas/document' envelope: $ref: '#/components/schemas/envelope' recipients: $ref: '#/components/schemas/EnvelopeRecipients' sequence: type: string description: Specifies the order in which templates are overlaid. description: '' x-ds-definition-name: inlineTemplate x-ms-summary: '' textCustomField: type: object properties: configurationType: type: string description: If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. errorDetails: $ref: '#/components/schemas/errorDetails' fieldId: type: string description: An ID used to specify a custom field. name: type: string description: The name of the custom field. required: type: string description: When set to **true**, the signer is required to fill out this tab show: type: string description: 'A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ' value: type: string description: The value of the custom field. description: '' x-ds-definition-name: textCustomField x-ms-summary: '' addressInformation: type: object properties: city: type: string description: The city associated with the address. country: type: string description: Specifies the country associated with the address. fax: type: string description: A Fax number associated with the address if one is available. phone: type: string description: A phone number associated with the address. state: type: string description: The state or province associated with the address. street1: type: string description: The first line of the address. street2: type: string description: The second line of the address (optional). zip: type: string description: The zip or postal code associated with the address. zipPlus4: type: string description: '' description: Contains address information. x-ds-definition-name: addressInformation x-ms-summary: Contains address information. bccEmailAddress: type: object properties: bccEmailAddressId: type: string description: "Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. \n \nExample: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address." email: type: string description: 'Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope. Maximum of length: 100 characters. ' description: Contains information about the BCC email address. x-ds-definition-name: bccEmailAddress x-ms-summary: Contains information about the BCC email address. initialHere: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: ' Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.' format: float status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -23) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -23) ' description: 'A tab that allows the recipient to initial the document. May be optional. ' x-ds-definition-name: initialHere x-ms-summary: 'A tab that allows the recipient to initial the document. May be optional. ' AccountCustomFields: type: object properties: listCustomFields: type: array description: An array of list custom fields. items: $ref: '#/components/schemas/listCustomField' textCustomFields: type: array description: An array of text custom fields. items: $ref: '#/components/schemas/textCustomField' description: Custom Fields x-ds-definition-name: customFields x-ds-category: Accounts x-ds-order: '30' x-ms-summary: Custom Fields ssn: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. ' x-ds-definition-name: ssn x-ms-summary: 'A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. ' bulkEnvelope: type: object properties: bulkRecipientRow: type: string description: 'Reserved: TBD' bulkStatus: type: string description: 'Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed' email: type: string description: '' envelopeId: type: string description: The envelope ID of the envelope status that failed to post. envelopeUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. errorDetails: $ref: '#/components/schemas/errorDetails' name: type: string description: '' submittedDateTime: type: string description: '' transactionId: type: string description: ' Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope''s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.' description: '' x-ds-definition-name: bulkEnvelope x-ms-summary: '' fullName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s full name. ' x-ds-definition-name: fullName x-ms-summary: 'A tab that displays the recipient''s full name. ' money: type: object properties: amountInBaseUnit: type: string description: 'The total payment amount in the currency''s base unit. For example, for USD the base currency is one cent. ' currency: type: string description: 'The three-letter [ISO 4217][ISO4217] currency code for the payment. For example: * AUD Australian dollar * CAD Canadian dollar * EUR Euro * GBP Great Britain pound * USD United States dollar This is a read-only property. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 ' displayAmount: type: string description: 'The payment amount as displayed in the `currency`. For example, if the payment amount is USD 12.59, the `amountInBaseUnit` is 1259 (cents), and the displayed amount is `$12.59 USD`. This is a read-only property. ' description: 'Describes information about the `total` of a payment. ' x-ds-definition-name: money x-ms-summary: 'Describes information about the `total` of a payment. ' idCheckInformationInput: type: object properties: addressInformationInput: $ref: '#/components/schemas/addressInformationInput' dobInformationInput: $ref: '#/components/schemas/dobInformationInput' ssn4InformationInput: $ref: '#/components/schemas/ssn4InformationInput' ssn9InformationInput: $ref: '#/components/schemas/ssn9InformationInput' description: "A complex element that contains input information related to a recipient ID check. It can include the following information.\n\naddressInformationInput: Used to set recipient address information and consists of:\n\n* addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\ndobInformationInput: Used to set recipient date of birth information and consists of:\n\n* dateOfBirth: Specifies the recipient's date, month and year of birth.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:\n\n* ssn4: Specifies the last four digits of the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: \n* ssn9: Specifies the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay." x-ds-definition-name: idCheckInformationInput x-ms-summary: "A complex element that contains input information related to a recipient ID check. It can include the following information.\n\naddressInformationInput: Used to set recipient address information and consists of:\n\n* addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\ndobInformationInput: Used to set recipient date of birth information and consists of:\n\n* dateOfBirth: Specifies the recipient's date, month and year of birth.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:\n\n* ssn4: Specifies the last four digits of the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: \n* ssn9: Specifies the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay." notarize: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: '' documentId: type: string description: The ID of the document being accessed. errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: The page number being accessed. recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.' x-ds-definition-name: notarize x-ms-summary: 'A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.' addressInformationInput: type: object properties: addressInformation: $ref: '#/components/schemas/addressInformation' displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" receiveInResponse: type: string description: When set to **true**, the information needs to be returned in the response. description: Contains address input information. x-ds-definition-name: addressInformationInput x-ms-summary: Contains address input information. firstName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s first name. This tab takes the recipient''s name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. ' x-ds-definition-name: firstName x-ms-summary: 'A tab that displays the recipient''s first name. This tab takes the recipient''s name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. ' signer: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. agentCanEditEmail: type: string description: Optional element. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. agentCanEditName: type: string description: Optional. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. bulkRecipientsUri: type: string description: 'The URL for the bulk recipient file with the bulk recipient information for this envelope, if applicable. This information is read only and is only shown after the bulk recipient file is uploaded to the envelope by using the PUT method. ' canSignOffline: type: string description: When set to **true**, specifies that the signer can perform the signing ceremony offline. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " creationReason: type: string description: The reason why the recipient was created (for example, `sender`). Read only. customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. defaultRecipient: type: string description: When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "The recipient's email address. The system sends notification of the documents to sign to this email address. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' isBulkRecipient: type: string description: "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. \n" lastName: type: string description: The recipient's last name. name: type: string description: 'The full legal name of the recipient. Maximum Length: 100 characters. **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' recipientSuppliesTabs: type: string description: When set to **true**, specifies that the recipient creates the tabs. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' requireSignerCertificate: type: string description: "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate." requireSignOnPaper: type: string description: When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signatureInfo: $ref: '#/components/schemas/recipientSignatureInformation' signedDateTime: type: string description: Reserved for DocuSign. signInEachLocation: type: string description: When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Specifies the status of the recipient at the time of the request. Read only. Possible values are: - `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status). - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope. - `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed. - `declined`: The recipient declined to sign the documents in the envelope. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step. - `autoresponded`: The recipient''s email system auto-responded to the email from DocuSign. This status is used by the DocuSign webapp (also known as the DocuSign console) to inform senders about the auto-responded email.' tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. x-ds-definition-name: signer x-ms-summary: A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. FormulaTab: type: object description: A calculated field tab using formulas. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value formula: type: string description: The formula expression. example: example_value roundDecimalPlaces: type: string example: example_value value: type: string example: example_value socialAuthentication: type: object properties: authentication: type: string description: 'Reserved: TBD' description: '' x-ds-definition-name: socialAuthentication x-ms-summary: '' notaryHost: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: 'The notary''s email address. Maximum Length: 100 characters. ' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' faxNumber: type: string description: Reserved for DocuSign. hostRecipientId: type: string description: '' idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' name: type: string description: 'The notary''s full legal name. Maximum Length: 100 characters. ' note: type: string description: 'A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later." tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: 'This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary''s full legal name. * `email`: Specifies the notary''s email address. * `recipientId`: A unique ID number for the notary signing host. ' x-ds-definition-name: notaryHost x-ms-summary: 'This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary''s full legal name. * `email`: Specifies the notary''s email address. * `recipientId`: A unique ID number for the notary signing host. ' dateStampProperties: type: object properties: dateAreaHeight: type: string description: '' dateAreaWidth: type: string description: '' dateAreaX: type: string description: '' dateAreaY: type: string description: '' description: '' x-ds-definition-name: dateStampProperties x-ms-summary: '' Checkbox: type: object description: A checkbox tab for boolean selection. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value selected: type: string description: When true, the checkbox is selected. example: example_value required: type: string example: example_value locked: type: string example: example_value listItem: type: object properties: selected: type: string description: "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default." text: type: string description: 'Specifies the text that is shown in the dropdown list. ' value: type: string description: Specifies the value that is used when the list item is selected. description: 'One of the selectable items in the `listItems` property of a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab.' x-ds-definition-name: listItem x-ms-summary: 'One of the selectable items in the `listItems` property of a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab.' DateTab: type: object description: A tab for date selection. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value value: type: string example: example_value required: type: string example: example_value lastName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s last name. This tab takes the recipient''s name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. ' x-ds-definition-name: lastName x-ms-summary: 'A tab that displays the recipient''s last name. This tab takes the recipient''s name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. ' UserInfo: type: object description: Information about a DocuSign user. properties: userName: type: string description: The user's full name. example: example_value email: type: string format: email description: The user's email address. example: user@example.com userId: type: string description: The user's unique ID. example: '500123' accountId: type: string description: The account ID associated with the user. example: '500123' page: type: object properties: dpi: type: string description: The number of dots per inch used for the page image. errorDetails: $ref: '#/components/schemas/errorDetails' height: type: string description: Height of the tab in pixels. imageBytes: type: string description: '' mimeType: type: string description: '' pageId: type: string description: '' sequence: type: string description: '' width: type: string description: Width of the tab in pixels. description: Description of a page of a document. x-ds-definition-name: page x-ms-summary: Description of a page of a document. Decline: type: object description: A decline button tab for document rejection. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value buttonText: type: string example: example_value declineReason: type: string example: example_value EventNotification: type: object description: Configuration for envelope event notifications via DocuSign Connect webhooks. properties: url: type: string description: The webhook endpoint URL to receive notifications. example: https://www.example.com loggingEnabled: type: string description: When true, Connect logging is enabled. example: example_value requireAcknowledgment: type: string description: When true, requires HTTPS 200 acknowledgment. example: example_value envelopeEvents: type: array description: Envelope-level events to trigger notifications. items: type: object properties: envelopeEventStatusCode: type: string enum: - sent - delivered - completed - declined - voided includeDocuments: type: string example: [] recipientEvents: type: array description: Recipient-level events to trigger notifications. items: type: object properties: recipientEventStatusCode: type: string enum: - Sent - Delivered - Completed - Declined - AuthenticationFailed - AutoResponded includeDocuments: type: string example: [] includeCertificateOfCompletion: type: string description: When true, includes the certificate of completion. example: example_value includeDocuments: type: string description: When true, includes document PDFs in the notification. example: example_value includeDocumentFields: type: string description: When true, includes document custom fields. example: example_value includeHMAC: type: string description: When true, includes HMAC security headers. example: example_value includeSenderAccountAsCustomField: type: string example: example_value includeTimeZone: type: string description: When true, includes time zone information. example: example_value includeCertificateWithSoap: type: string example: example_value envelopeIdsRequest: type: object properties: envelopeIds: type: array description: '' items: type: string transactionIds: type: array description: ' A list of transaction Id''s used to determining the status of envelopes sent asynchronously. See **transactionId** property on envelopes.' items: type: string description: '' x-ds-definition-name: envelopeIdsRequest x-ms-summary: '' documentVisibility: type: object properties: documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. rights: type: string description: '' visible: type: string description: '' description: '' x-ds-definition-name: documentVisibility x-ms-summary: '' documentHtmlDisplayAnchor: type: object properties: caseSensitive: type: boolean description: '' displaySettings: $ref: '#/components/schemas/documentHtmlDisplaySettings' endAnchor: type: string description: '' removeEndAnchor: type: boolean description: '' removeStartAnchor: type: boolean description: '' startAnchor: type: string description: '' description: '' x-ds-definition-name: documentHtmlDisplayAnchor x-ms-summary: '' envelopeDefinition: type: object properties: accessibility: type: string description: "Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. \n\n###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here." allowMarkup: type: string description: When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this allowReassign: type: string description: When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. allowRecipientRecursion: type: string description: When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. allowViewHistory: type: string description: '' asynchronous: type: string description: "When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification." attachments: type: array description: '' items: $ref: '#/components/schemas/attachment' attachmentsUri: type: string description: '' authoritativeCopy: type: string description: 'Specifies whether all documents in this envelope are authoritative copies. A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ' authoritativeCopyDefault: type: string description: 'The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope''s `authoritativeCopy`.' autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. brandId: type: string description: This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option. brandLock: type: string description: '' certificateUri: type: string description: Retrieves a URI for an endpoint allowing you to easily retrieve certificate information. completedDateTime: type: string description: Specifies the date and time this item was completed. compositeTemplates: type: array description: A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope. items: $ref: '#/components/schemas/compositeTemplate' copyRecipientData: type: string description: '' createdDateTime: type: string description: Indicates the date and time the item was created. customFields: $ref: '#/components/schemas/AccountCustomFields' customFieldsUri: type: string description: Contains a URI for an endpoint to retrieve the custom fields. declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. deletedDateTime: type: string description: Specifies the data and time the item was deleted. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' disableResponsiveDocument: type: string description: '' documents: type: array description: Complex element contains the details on the documents in the envelope. items: $ref: '#/components/schemas/document' documentsCombinedUri: type: string description: '' documentsUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the documents. emailBlurb: type: string description: Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters emailSettings: $ref: '#/components/schemas/emailSettings' emailSubject: type: string description: 'Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.' enableWetSign: type: string description: When set to **true**, the signer is allowed to print the document and sign it on paper. enforceSignerVisibility: type: string description: 'When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. ###### Note: Your account must have Document Visibility enabled to use this.' envelopeId: type: string description: The envelope ID of the envelope status that failed to post. envelopeIdStamping: type: string description: When set to **true**, Envelope ID Stamping is enabled. envelopeUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. eventNotification: $ref: '#/components/schemas/eventNotification' initialSentDateTime: type: string description: '' is21CFRPart11: type: string description: When set to **true**, indicates that this module is enabled on the account. isSignatureProviderEnvelope: type: string description: '' lastModifiedDateTime: type: string description: The date and time the item was last modified. lockInformation: $ref: '#/components/schemas/EnvelopeLocks' messageLock: type: string description: "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope." notification: $ref: '#/components/schemas/notification' notificationUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the notifications. password: type: string description: '' purgeState: type: string description: 'Initiates a purge request. Valid values are: * documents_queued - Places envelope documents in the purge queue. * documents_and_metadata_queued - Places envelope documents and metadata in the purge queue. ' recipients: $ref: '#/components/schemas/EnvelopeRecipients' recipientsLock: type: string description: When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. recipientsUri: type: string description: Contains a URI for an endpoint that you can use to retrieve the recipients. sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signerCanSignOnMobile: type: string description: '' signingLocation: type: string description: Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. status: type: string description: "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later." statusChangedDateTime: type: string description: The data and time the status changed. templateId: type: string description: 'The unique identifier of the template. If this is not provided, DocuSign will generate a value. ' templateRoles: type: array description: 'Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up by the following elements: * email - The recipient''s email address. * name - The recipient''s name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role-specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template. ' items: $ref: '#/components/schemas/templateRole' templatesUri: type: string description: Contains a URI for an endpoint which you can use to retrieve the templates. transactionId: type: string description: ' Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope''s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.' useDisclosure: type: string description: "When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information." voidedDateTime: type: string description: The date and time the envelope or template was voided. voidedReason: type: string description: The reason the envelope or template was voided. description: '' x-ds-definition-name: envelopeDefinition x-ms-summary: '' userSignature: type: object properties: adoptedDateTime: type: string description: The date and time the user adopted their signature. createdDateTime: type: string description: Indicates the date and time the item was created. dateStampProperties: $ref: '#/components/schemas/dateStampProperties' errorDetails: $ref: '#/components/schemas/errorDetails' externalID: type: string description: '' imageType: type: string description: One of **signature_image** or **initials_image**. initials150ImageId: type: string description: '' initialsImageUri: type: string description: Contains the URI for an endpoint that you can use to retrieve the initials image. isDefault: type: string description: '' phoneticName: type: string description: '' signature150ImageId: type: string description: '' signatureFont: type: string description: '' signatureId: type: string description: The ID of the signature being accessed. signatureImageUri: type: string description: Contains the URI for an endpoint that you can use to retrieve the signature image. signatureInitials: type: string description: '' signatureName: type: string description: Specifies the user signature name. signatureType: type: string description: '' stampFormat: type: string description: '' stampImageUri: type: string description: '' stampSizeMM: type: string description: '' stampType: type: string description: '' description: '' x-ds-definition-name: userSignature x-ms-summary: '' emailAddress: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s email as entered in the recipient information. ' x-ds-definition-name: emailAddress x-ms-summary: 'A tab that displays the recipient''s email as entered in the recipient information. ' inPersonSigner: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. canSignOffline: type: string description: When set to **true**, specifies that the signer can perform the signing ceremony offline. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " creationReason: type: string description: The reason why the recipient was created (for example, `sender`). Read only. customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. defaultRecipient: type: string description: 'When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. ' deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: 'The signer''s email address in an eNotary flow. Use only when `inPersonSigningType` is `notary`. For regular in-person-signer flow, use `signerEmail` instead. ' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. hostEmail: type: string description: 'The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. ' hostName: type: string description: 'The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. ' idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' inPersonSigningType: type: string description: 'Specifies whether the envelope uses the eNotary feature. Valid values: * `inPersonSigner` The envelope uses the normal in-person signing flow. * `notary`: The envelope uses the eNotary in-person signing flow. ' name: type: string description: 'The signer''s full legal name in an eNotary flow. Required when `inPersonSigningType` is `notary`. For regular in-person-signer flow, use `signerName` instead. Maximum Length: 100 characters. ' notaryHost: $ref: '#/components/schemas/notaryHost' note: type: string description: 'A note sent to the in-person signer in the signing email. This note is visible only to this recipient. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' recipientSuppliesTabs: type: string description: When set to **true**, specifies that the recipient creates the tabs. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' requireSignerCertificate: type: string description: "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate." requireSignOnPaper: type: string description: When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signatureInfo: $ref: '#/components/schemas/recipientSignatureInformation' signedDateTime: type: string description: Reserved for DocuSign. signerEmail: type: string description: 'The in-person signer''s email address. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. ' signerName: type: string description: 'The in-person signer''s full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. ' signInEachLocation: type: string description: When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: 'An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about fields used for eNotary feature, see the [EnvelopeRecipients resource][enveloperecipientsInPerson]. [enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient ' x-ds-definition-name: inPersonSigner x-ms-summary: 'An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about fields used for eNotary feature, see the [EnvelopeRecipients resource][enveloperecipientsInPerson]. [enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient ' matchBox: type: object properties: height: type: integer description: Height of the tab in pixels. format: int32 pageNumber: type: integer description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' format: int32 width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: integer description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: int32 yPosition: type: integer description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: int32 description: '' x-ds-definition-name: matchBox x-ms-summary: '' NumberTab: type: object description: A tab for numeric input. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value value: type: string example: example_value required: type: string example: example_value signerAttachment: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: '' format: float status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) ' description: 'A tab that allows the recipient to attach supporting documents to an envelope. ' x-ds-definition-name: signerAttachment x-ms-summary: 'A tab that allows the recipient to attach supporting documents to an envelope. ' pageImages: type: object properties: endPosition: type: string description: 'The last position in the result set. ' nextUri: type: string description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ' pages: type: array description: '' items: $ref: '#/components/schemas/page' previousUri: type: string description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ' resultSetSize: type: string description: 'The number of results returned in this response. ' startPosition: type: string description: Starting position of the current result set. totalSetSize: type: string description: The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field. description: '' x-ds-definition-name: pageImages x-ms-summary: '' envelopesInformation: type: object properties: continuationToken: type: string description: '' endPosition: type: string description: 'The last position in the result set. ' envelopes: type: array description: Set of envelope information items: $ref: '#/components/schemas/envelope' envelopeTransactionStatuses: type: array description: Array of envelope statuses and transaction Ids in the result set. items: $ref: '#/components/schemas/envelopeTransactionStatus' lastQueriedDateTime: type: string description: '' nextUri: type: string description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ' previousUri: type: string description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ' resultSetSize: type: string description: 'The number of results returned in this response. ' startPosition: type: string description: Starting position of the current result set. totalSetSize: type: string description: The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field. description: 'Result set for the Envelopes: listStatusChanges method' x-ds-definition-name: envelopesInformation x-ms-summary: 'Result set for the Envelopes: listStatusChanges method' envelopeSummary: type: object properties: envelopeId: type: string description: The envelope ID of the envelope status that failed to post. status: type: string description: "Indicates the envelope status. Valid values are: \n\n* completed - The envelope has been completed and all tags have been signed.\n* created - The envelope is created as a draft. It can be modified and sent later.\n* declined - The envelope has been declined by the recipients.\n* delivered - The envelope has been delivered to the recipients.\n* sent - The envelope is sent to the recipients.\n* signed - The envelope has been signed by the recipients.\n* voided - The envelope is no longer valid and recipients cannot access or sign the envelope.\n" statusDateTime: type: string description: The DateTime that the envelope changed status (i.e. was created or sent.) uri: type: string description: '' description: '' x-ds-definition-name: envelopeSummary x-ms-summary: '' Signer: type: object description: A signer recipient who must sign the envelope documents. properties: recipientId: type: string description: Unique identifier for the recipient. Assigned by the sender. example: '500123' recipientIdGuid: type: string format: uuid description: The GUID for the recipient. example: '500123' name: type: string description: The full legal name of the signer. example: Example Title email: type: string format: email description: The email address of the signer. example: user@example.com routingOrder: type: string description: The routing order of the signer. Lower numbers are processed first. Recipients with the same routing order sign in parallel. example: example_value roleName: type: string description: The role name associated with the signer, used with templates. example: example_value clientUserId: type: string description: The client user ID for embedded signing. When set, the recipient is an embedded signer and must sign through your application using a generated signing URL. example: '500123' status: type: string description: The status of the signer. enum: - created - sent - delivered - signed - completed - declined - autoresponded example: created signedDateTime: type: string format: date-time description: The date and time the signer signed. example: '2026-01-15T10:30:00Z' deliveredDateTime: type: string format: date-time description: The date and time the envelope was delivered to the signer. example: '2026-01-15T10:30:00Z' declinedDateTime: type: string format: date-time description: The date and time the signer declined. example: '2026-01-15T10:30:00Z' declinedReason: type: string description: The reason the signer declined. example: example_value tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' identityVerification: type: object description: Identity verification settings for this recipient. properties: workflowId: type: string inputOptions: type: array items: type: object example: example_value phoneAuthentication: type: object description: Phone authentication settings. properties: recipMayProvideNumber: type: string senderProvidedNumbers: type: array items: type: string example: example_value accessCode: type: string description: An access code the recipient must enter to access the envelope. example: example_value requireIdLookup: type: string description: Whether ID lookup authentication is required. example: example_value note: type: string description: A private note to the signer from the sender. example: example_value emailNotification: $ref: '#/components/schemas/RecipientEmailNotification' envelopeEvent: type: object properties: envelopeEventStatusCode: type: string description: 'An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided.' includeDocuments: type: string description: reserved description: For which envelope events should your webhook be called? x-ds-definition-name: envelopeEvent x-ms-summary: For which envelope events should your webhook be called? InitialHere: type: object description: An initial tab placed on a document. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value optional: type: string example: example_value scaleValue: type: string example: example_value CompositeTemplate: type: object description: A composite template that combines server templates and inline templates for complex envelope workflows. properties: compositeTemplateId: type: string description: Unique identifier for the composite template. example: '500123' serverTemplates: type: array items: type: object properties: templateId: type: string sequence: type: string example: [] inlineTemplates: type: array items: type: object properties: sequence: type: string recipients: $ref: '#/components/schemas/Recipients' documents: type: array items: $ref: '#/components/schemas/Document' example: [] document: $ref: '#/components/schemas/Document' number: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' formula: type: string description: 'Contains the formula for calculating the value of this tab. Use a tab''s `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields ' isPaymentAmount: type: string description: 'When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter numbers and decimal (.) points. ' x-ds-definition-name: number x-ms-summary: 'A tab that allows the recipient to enter numbers and decimal (.) points. ' recipientSMSAuthentication: type: object properties: senderProvidedNumbers: type: array description: 'An Array containing a list of phone numbers the recipient may use for SMS text authentication. ' items: type: string description: Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. x-ds-definition-name: recipientSMSAuthentication x-ms-summary: Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. mergeField: type: object properties: allowSenderToEdit: type: string description: When set to **true**, the sender can modify the value of the custom tab during the sending process. configurationType: type: string description: If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. path: type: string description: Sets the object associated with the custom tab. Currently this is the Salesforce Object. row: type: string description: Specifies the row number in a Salesforce table that the merge field value corresponds to. writeBack: type: string description: When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. description: Contains information for transfering values between Salesforce data fields and DocuSign Tabs. x-ds-definition-name: mergeField x-ms-summary: Contains information for transfering values between Salesforce data fields and DocuSign Tabs. zip: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. useDash4: type: string description: '' validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. ' x-ds-definition-name: zip x-ms-summary: 'A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. ' agent: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' lastName: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: Contains information about agent recipients. x-ds-definition-name: agent x-ms-summary: Contains information about agent recipients. Approve: type: object description: An approve button tab for document approval. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value buttonText: type: string example: example_value RecipientEmailNotification: type: object description: Custom email notification settings for a recipient. properties: emailSubject: type: string description: Custom email subject for this recipient. example: user@example.com emailBody: type: string description: Custom email body for this recipient. example: user@example.com supportedLanguage: type: string description: Language code for the notification. example: example_value envelopeUpdateSummary: type: object properties: bulkEnvelopeStatus: $ref: '#/components/schemas/bulkEnvelopeStatus' envelopeId: type: string description: The envelope ID of the envelope status that failed to post. errorDetails: $ref: '#/components/schemas/errorDetails' listCustomFieldUpdateResults: type: array description: '' items: $ref: '#/components/schemas/listCustomField' lockInformation: $ref: '#/components/schemas/EnvelopeLocks' recipientUpdateResults: type: array description: '' items: $ref: '#/components/schemas/recipientUpdateResponse' tabUpdateResults: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' textCustomFieldUpdateResults: type: array description: '' items: $ref: '#/components/schemas/textCustomField' description: '' x-ds-definition-name: envelopeUpdateSummary x-ms-summary: '' recipientPhoneAuthentication: type: object properties: recipMayProvideNumber: type: string description: Boolean. When set to **true**, the recipient can supply a phone number their choice. recordVoicePrint: type: string description: Reserved. senderProvidedNumbers: type: array description: 'An Array containing a list of phone numbers the recipient may use for SMS text authentication. ' items: type: string validateRecipProvidedNumber: type: string description: ' Reserved.' description: 'A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.' x-ds-definition-name: recipientPhoneAuthentication x-ms-summary: 'A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.' checkbox: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: This property does not apply to `checkbox` tabs. Check boxes are always optional. requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. selected: type: string description: When set to **true**, the checkbox is selected. shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) ' description: 'A tab that allows the recipient to select a yes/no (on/off) option. ' x-ds-definition-name: checkbox x-ms-summary: 'A tab that allows the recipient to select a yes/no (on/off) option. ' Editor: type: object description: An editor recipient who can modify the envelope before it is sent. properties: recipientId: type: string example: '500123' name: type: string example: Example Title email: type: string format: email example: user@example.com routingOrder: type: string example: example_value status: type: string example: example_value signHere: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: '' format: float stampType: type: string description: '' stampTypeMetadata: $ref: '#/components/schemas/propertyMetadata' status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -27) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -27) ' description: 'A tab that allows the recipient to sign a document. May be optional. ' x-ds-definition-name: signHere x-ms-summary: 'A tab that allows the recipient to sign a document. May be optional. ' text: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' formula: type: string description: 'Contains the formula for calculating the value of this tab. Use a tab''s `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields ' height: type: integer description: Height of the tab in pixels. format: int32 isPaymentAmount: type: string description: 'When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter any type of text. ' x-ds-definition-name: text x-ms-summary: 'A tab that allows the recipient to enter any type of text. ' recipientIdentityPhoneNumber: type: object properties: countryCode: type: string description: '' extension: type: string description: '' number: type: string description: '' description: '' x-ds-definition-name: recipientIdentityPhoneNumber x-ms-summary: '' paymentDetails: type: object properties: allowedPaymentMethods: type: array description: 'An array of accepted payment methods: * `CreditCard` * `ApplePay` * `AndroidPay` * `BankAccount` For example, if you only accept credit cards and ACH transfers, you would set this property to: `''["BankAccount", "CreditCard"]''` Do not specify `BankAccount` (ACH) if you are also using in-person signing. ' items: type: string chargeId: type: string description: The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment. currencyCode: type: string description: 'Specifies the three-letter [ISO 4217][ISO4217] currency code for the payment. Supported currencies are: * AUD Australian dollar * CAD Canadian dollar * EUR Euro * GBP Great Britain pound * USD United States dollar Specifying any other ISO 4217 code for payments is an error. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 ' customerId: type: string description: '' customMetadata: type: string description: '' customMetadataRequired: type: boolean description: '' gatewayAccountId: type: string description: 'A GUID that identifies the payment gateway connected to the sender''s DocuSign account. There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the DocuSign Admin console and through your chosen payment gateway. You can get the gateway account ID in the Payments section of the DocuSign Admin console. [paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways ' gatewayDisplayName: type: string description: 'Display name of the gateway connected to sender''s Docusign account. Possible values are: Stripe, Braintree, Authorize.Net.' gatewayName: type: string description: 'Name of the gateway connected to sender''s DocuSign account. Possible values are: * `Stripe` * `Braintree` * `AuthorizeDotNet`' lineItems: type: array description: 'A payment formula can have one or more line items that provide detail about individual items in a payment request. The list of line items are returned as metadata to the payment gateway. ' items: $ref: '#/components/schemas/paymentLineItem' paymentOption: type: string description: '' paymentSourceId: type: string description: '' signerValues: $ref: '#/components/schemas/paymentSignerValues' status: type: string description: "This read-only property describes the status of a payment.\n\n* `new`
\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`
\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`
\n The recipient's card has been charged.\n\n* `payment_capture_failed`
\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n" total: $ref: '#/components/schemas/money' description: 'When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' x-ds-definition-name: paymentDetails x-ms-summary: 'When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' recipientIdentityInputOption: type: object properties: name: type: string description: '' phoneNumberList: type: array description: '' items: $ref: '#/components/schemas/recipientIdentityPhoneNumber' valueType: type: string description: '' description: '' x-ds-definition-name: recipientIdentityInputOption x-ms-summary: '' certifiedDelivery: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. agentCanEditEmail: type: string description: '' agentCanEditName: type: string description: '' clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: '' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' lastName: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: certifiedDelivery x-ms-summary: '' Intermediary: type: object description: An intermediary recipient who can forward the envelope to another person. properties: recipientId: type: string example: '500123' name: type: string example: Example Title email: type: string format: email example: user@example.com routingOrder: type: string example: example_value status: type: string example: example_value templateRole: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " defaultRecipient: type: string description: When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. email: type: string description: Specifies the email associated with a role name. emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " inPersonSignerName: type: string description: 'Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters.' name: type: string description: Specifies the recipient's name. recipientSignatureProviders: type: array description: The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' description: '' x-ds-definition-name: templateRole x-ms-summary: '' emailSettings: type: object properties: bccEmailAddresses: type: array description: 'An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. **Note**: While this property is an array, it takes only a single email address.' items: $ref: '#/components/schemas/bccEmailAddress' replyEmailAddressOverride: type: string description: '' replyEmailNameOverride: type: string description: '' description: '' x-ds-definition-name: emailSettings x-ms-summary: '' eventNotification: type: object properties: envelopeEvents: type: array description: "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both." items: $ref: '#/components/schemas/envelopeEvent' includeCertificateOfCompletion: type: string description: 'When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes. ' includeCertificateWithSoap: type: string description: When set to **true**, the Connect service will digitally sign the XML data. The signature will be included in the XML message. includeDocumentFields: type: string description: 'When set to **true**, the Document Fields associated with the envelope''s documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. ' includeDocuments: type: string description: 'When set to **true**, the XML webhook messages will include the envelope''s PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. ' includeEnvelopeVoidReason: type: string description: 'When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. ' includeHMAC: type: string description: '' includeSenderAccountAsCustomField: type: string description: When set to **true**, Connect will include the sender account as Custom Field in the data. includeTimeZone: type: string description: 'When set to **true**, the envelope''s time zone information is included in the webhook messages. ' loggingEnabled: type: string description: When set to **true**, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents). recipientEvents: type: array description: "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both." items: $ref: '#/components/schemas/recipientEvent' requireAcknowledgment: type: string description: 'When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures. ' signMessageWithX509Cert: type: string description: 'When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer''s web server) during the TLS handshake protocol. ' soapNameSpace: type: string description: 'The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.' url: type: string description: The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used. useSoapInterface: type: string description: 'When set to **true**, the notifications are sent to your endpoint as SOAP requests. ' description: Register a Connect webhook for a specific envelope x-ds-definition-name: eventNotification x-ms-summary: Register a Connect webhook for a specific envelope nameValue: type: object properties: errorDetails: $ref: '#/components/schemas/errorDetails' name: type: string description: The name or key of a name/value pair. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' value: type: string description: The value field of a name/value pair. description: '' x-ds-definition-name: nameValue x-ms-summary: '' Witness: type: object description: A witness recipient who verifies the identity of a signer. properties: recipientId: type: string example: '500123' name: type: string example: Example Title email: type: string format: email example: user@example.com routingOrder: type: string example: example_value status: type: string example: example_value tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' email: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. ' x-ds-definition-name: email x-ms-summary: 'A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. ' authenticationStatus: type: object properties: accessCodeResult: $ref: '#/components/schemas/eventResult' ageVerifyResult: $ref: '#/components/schemas/eventResult' anySocialIDResult: $ref: '#/components/schemas/eventResult' facebookResult: $ref: '#/components/schemas/eventResult' googleResult: $ref: '#/components/schemas/eventResult' identityVerificationResult: $ref: '#/components/schemas/eventResult' idLookupResult: $ref: '#/components/schemas/eventResult' idQuestionsResult: $ref: '#/components/schemas/eventResult' linkedinResult: $ref: '#/components/schemas/eventResult' liveIDResult: $ref: '#/components/schemas/eventResult' ofacResult: $ref: '#/components/schemas/eventResult' openIDResult: $ref: '#/components/schemas/eventResult' phoneAuthResult: $ref: '#/components/schemas/eventResult' salesforceResult: $ref: '#/components/schemas/eventResult' signatureProviderResult: $ref: '#/components/schemas/eventResult' smsAuthResult: $ref: '#/components/schemas/eventResult' sTANPinResult: $ref: '#/components/schemas/eventResult' twitterResult: $ref: '#/components/schemas/eventResult' yahooResult: $ref: '#/components/schemas/eventResult' description: Contains information about the authentication status. x-ds-definition-name: authenticationStatus x-ms-summary: Contains information about the authentication status. EmailTab: type: object description: A tab for email address input. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value value: type: string example: example_value notification: type: object properties: expirations: $ref: '#/components/schemas/expirations' reminders: $ref: '#/components/schemas/reminders' useAccountDefaults: type: string description: When set to **true**, the account default notification settings are used for the envelope. description: "A complex element that specifies the notification options for the envelope. It consists of:\n\n* useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. \n* reminders - A complex element that specifies reminder settings for the envelope. It consists of: \n\n * reminderEnabled - When set to **true**, a reminder message is sent to the recipient.\n * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. \n * reminderFrequency - An interger that sets the interval, in days, between reminder emails. \n\n* expirations - A complex element that specifies the expiration settings for the envelope. It consists of:\n\n * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. \n * expireAfter - An integer that sets the number of days the envelope is active.\n * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent." x-ds-definition-name: notification x-ms-summary: "A complex element that specifies the notification options for the envelope. It consists of:\n\n* useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. \n* reminders - A complex element that specifies reminder settings for the envelope. It consists of: \n\n * reminderEnabled - When set to **true**, a reminder message is sent to the recipient.\n * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. \n * reminderFrequency - An interger that sets the interval, in days, between reminder emails. \n\n* expirations - A complex element that specifies the expiration settings for the envelope. It consists of:\n\n * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. \n * expireAfter - An integer that sets the number of days the envelope is active.\n * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent." radio: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' required: type: string description: When set to **true**, the signer is required to fill out this tab selected: type: string description: When set to **true**, the radio button is selected. tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'One of the selectable radio buttons in the `radios` property of a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab. ' x-ds-definition-name: radio x-ms-summary: 'One of the selectable radio buttons in the `radios` property of a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab. ' sealSign: type: object properties: accessCode: type: string description: Not applicable addAccessCodeToEmail: type: string description: Not applicable clientUserId: type: string description: Not applicable customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: Not applicable declinedReason: type: string description: Not applicable deliveredDateTime: type: string description: Not applicable deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: Not applicable items: $ref: '#/components/schemas/documentVisibility' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' faxNumber: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' name: type: string description: '' note: type: string description: Not applicable phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Not applicable items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: (Required) The `recipientId` used when the envelope or template was created. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: (Required) Indicates which electronic seal to apply on documents when creating an envelope. items: $ref: '#/components/schemas/recipientSignatureProvider' requireIdLookup: type: string description: Not applicable roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: "(Optional, default: 1) \nSpecifies the routing order of the electronic seal in the envelope.\nThe routing order assigned to your electronic seal cannot be shared with another recipient.\nIt is recommended that you set a routing order for your electronic seals.\n" samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: Not applicable signedDateTime: type: string description: Not applicable smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: Item status. tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: Not applicable userId: type: string description: Not applicable description: "Specifies one or more electronic seals to apply on documents. \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-13be-42ca-a6fe-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n```\nFor more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals" x-ds-definition-name: sealSign x-ms-summary: "Specifies one or more electronic seals to apply on documents. \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-13be-42ca-a6fe-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n```\nFor more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals" envelopeTransactionStatus: type: object properties: envelopeId: type: string description: The envelope ID of the envelope status that failed to post. errorDetails: $ref: '#/components/schemas/errorDetails' status: type: string description: "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later." transactionId: type: string description: ' Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope''s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.' description: '' x-ds-definition-name: envelopeTransactionStatus x-ms-summary: '' EnvelopeUpdateSummary: type: object description: Summary of an envelope update operation. properties: envelopeId: type: string format: uuid description: The envelope ID. example: '500123' bulkEnvelopeStatus: type: object description: Bulk envelope status information, if applicable. example: example_value errorDetails: $ref: '#/components/schemas/ErrorDetails' listCustomFieldUpdateResults: type: array items: type: object example: [] recipientUpdateResults: type: array items: type: object example: [] textCustomFieldUpdateResults: type: array items: type: object example: [] carbonCopy: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. agentCanEditEmail: type: string description: '' agentCanEditName: type: string description: '' clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nNote: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. \n\nMaximum length: 100 characters. " customFields: type: array description: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nIf set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.\n\nIt is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: 'Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: 'When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient''s account. ' lastName: type: string description: The recipient's last name. name: type: string description: 'legal name of the recipient. Maximum Length: 100 characters.' note: type: string description: 'A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: carbonCopy x-ms-summary: '' CertifiedDelivery: type: object description: A certified delivery recipient who must confirm receipt of the envelope documents. properties: recipientId: type: string example: '500123' name: type: string example: Example Title email: type: string format: email example: user@example.com routingOrder: type: string example: example_value status: type: string example: example_value smartSection: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' caseSensitive: type: boolean description: '' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: '' displaySettings: $ref: '#/components/schemas/smartSectionDisplaySettings' documentId: type: string description: The ID of the document being accessed. endAnchor: type: string description: '' endPosition: $ref: '#/components/schemas/smartSectionAnchorPosition' errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: The page number being accessed. recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. removeEndAnchor: type: boolean description: '' removeStartAnchor: type: boolean description: '' startAnchor: type: string description: '' startPosition: $ref: '#/components/schemas/smartSectionAnchorPosition' status: type: string description: Item status. tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: '' x-ds-definition-name: smartSection x-ms-summary: '' EnvelopeRecipientTabs_2: type: object properties: approveTabs: type: array description: "A list of\n[Approve tabs][approve].\n\n\nThis tab allows\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n" items: $ref: '#/components/schemas/approve' checkboxTabs: type: array description: 'A list of [Checkbox tabs][checkbox]. This tab allows the recipient to select a yes/no (on/off) option. [checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox ' items: $ref: '#/components/schemas/checkbox' companyTabs: type: array description: "A list of \n[Company tabs][company].\n\n\nThis tab displays the recipient's company name.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n" items: $ref: '#/components/schemas/company' dateSignedTabs: type: array description: "A list of \n[Date Signed tabs][dateSigned]\n\n\nThis tab displays the date that the recipient signed the\ndocument.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n" items: $ref: '#/components/schemas/dateSigned' dateTabs: type: array description: "A list of \n[Date tabs][date].\n\n\nThis tab allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n" items: $ref: '#/components/schemas/date' declineTabs: type: array description: "A list of \n[Decline tabs][decline].\n\nThis tab allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n" items: $ref: '#/components/schemas/decline' emailAddressTabs: type: array description: "A list of \n[Email Address tabs][emailAddress].\n\nThis tab \ndisplays the recipient's email as entered in the\nrecipient information.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n" items: $ref: '#/components/schemas/emailAddress' emailTabs: type: array description: "A list of \n[Email tabs][email].\n\nThis tab \nallows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n" items: $ref: '#/components/schemas/email' envelopeIdTabs: type: array description: "A list of \n[Envelope ID tabs][envelopeId].\n\nThis tab \ndisplays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n" items: $ref: '#/components/schemas/envelopeId' firstNameTabs: type: array description: "A list of \n[First Name tabs][firstName].\n\nThis tab \ndisplays the recipient's first name. It\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n" items: $ref: '#/components/schemas/firstName' formulaTabs: type: array description: "A list of [Formula tabs][formulaTab].\n\nThe value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n" items: $ref: '#/components/schemas/formulaTab' fullNameTabs: type: array description: "A list of \n[Full Name tabs][fullName].\n\nThis tab \ndisplays the recipient's full name.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n" items: $ref: '#/components/schemas/fullName' initialHereTabs: type: array description: "A list of \n[Initial Here tabs][initialHere].\n\nThis tab allows the recipient to initial the document. May\nbe optional.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n" items: $ref: '#/components/schemas/initialHere' lastNameTabs: type: array description: "A list of \n[Last Name tabs][lastName].\n\nThis tab \ndisplays the recipient's last name. It\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n" items: $ref: '#/components/schemas/lastName' listTabs: type: array description: "A list of \n[list tabs][list].\n\nThis tab offers a list of options to choose from. The\n`listItems` property is used to specify the selectable\noptions.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n" items: $ref: '#/components/schemas/list' notarizeTabs: type: array description: "A list of \n[Notarize tabs][notarize].\n\nA notarize tab is a tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n" items: $ref: '#/components/schemas/notarize' noteTabs: type: array description: "A list of \n[Note tabs][note].\n\nThis tab displays additional information, in the form of a\nnote, for the recipient.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n" items: $ref: '#/components/schemas/note' numberTabs: type: array description: "A list of \n[Number tabs][number].\n\nThis tab allows the recipient to enter numbers and decimal\n(.) points.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n" items: $ref: '#/components/schemas/number' radioGroupTabs: type: array description: "A list of \n[Radio Group tabs][radioGroup].\n\nThis tab \nThis group tab is used to place radio buttons on a document.\nThe `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can\nbe selected in a group.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n" items: $ref: '#/components/schemas/radioGroup' signerAttachmentTabs: type: array description: "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis tab \nallows the recipient to attach supporting\ndocuments to an envelope.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n" items: $ref: '#/components/schemas/signerAttachment' signHereTabs: type: array description: "A list of \n[Sign Here tabs][signHere].\n\nThis tab allows the recipient to sign a document. May be\noptional.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n" items: $ref: '#/components/schemas/signHere' smartSectionTabs: type: array description: '' items: $ref: '#/components/schemas/smartSection' ssnTabs: type: array description: "A list of \n[SSN tabs][ssn].\n\nThis tab \nis a one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n" items: $ref: '#/components/schemas/ssn' textTabs: type: array description: "A list of \n[Text tabs][text].\n\nThis tab \nA tab that allows the recipient to enter any type of text.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n" items: $ref: '#/components/schemas/text' titleTabs: type: array description: "A list of \n[Title tabs][title].\n\nThis tab displays the recipient's title.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n" items: $ref: '#/components/schemas/title' viewTabs: type: array description: "A list of \n[View tabs][view].\n\nThis tab \nThis tab is used with the Approve tab to handle\nsupplemental documents.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n" items: $ref: '#/components/schemas/view' zipTabs: type: array description: "A list of \n[Zip tabs][zip].\n\nThis tab \nallows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n" items: $ref: '#/components/schemas/zip' description: 'All of the tabs associated with a recipient. Each property is a list of a type of tab. ' x-ds-definition-name: tabs x-ds-category: Envelopes x-ds-order: '50' x-ms-summary: 'All of the tabs associated with a recipient. Each property is a list of a type of tab. ' smartSectionCollapsibleDisplaySettings: type: object properties: arrowClosed: type: string description: '' arrowColor: type: string description: '' arrowLocation: type: string description: '' arrowOpen: type: string description: '' arrowSize: type: string description: '' arrowStyle: type: string description: '' containerStyle: type: string description: '' labelStyle: type: string description: '' onlyArrowIsClickable: type: boolean description: '' outerLabelAndArrowStyle: type: string description: '' description: '' x-ds-definition-name: smartSectionCollapsibleDisplaySettings x-ms-summary: '' Agent: type: object description: An agent recipient who can designate a recipient to sign in their place. properties: recipientId: type: string example: '500123' name: type: string example: Example Title email: type: string format: email example: user@example.com routingOrder: type: string example: example_value status: type: string example: example_value Document: type: object description: A document to be included in an envelope. Documents can be provided as base64-encoded content or by reference. properties: documentId: type: string description: A unique identifier for the document within the envelope, assigned by the sender. Must be unique within the envelope. example: '500123' name: type: string description: The name of the document. example: Example Title fileExtension: type: string description: The file extension of the document. DocuSign uses this to determine the correct content type. example: example_value documentBase64: type: string description: The base64-encoded content of the document. example: example_value remoteUrl: type: string description: URL from which to retrieve the document content. example: https://www.example.com order: type: string description: The order of the document in the envelope. example: example_value pages: type: string description: The number of pages in the document. example: example_value display: type: string description: Display setting for the document. enum: - inline - modal - download example: inline includeInDownload: type: string description: Whether to include this document in downloads. example: example_value transformPdfFields: type: string description: When true, DocuSign transforms PDF form fields into DocuSign tabs. example: example_value expirations: type: object properties: expireAfter: type: string description: An integer that sets the number of days the envelope is active. expireEnabled: type: string description: When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. expireWarn: type: string description: An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. description: A complex element that specifies the expiration settings for the envelope. x-ds-definition-name: expirations x-ms-summary: A complex element that specifies the expiration settings for the envelope. Text: type: object description: A text input tab for free-form text entry. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value anchorString: type: string example: example_value value: type: string example: example_value required: type: string description: When true, the recipient must fill in this tab. example: example_value locked: type: string description: When true, the tab value cannot be changed. example: example_value maxLength: type: string description: Maximum length of text input. example: example_value width: type: string example: example_value height: type: string example: example_value font: type: string example: example_value fontSize: type: string example: example_value fontColor: type: string example: example_value bold: type: string example: example_value italic: type: string example: example_value underline: type: string example: example_value validationPattern: type: string description: Regular expression for input validation. example: example_value validationMessage: type: string description: Error message displayed when validation fails. example: example_value concealValueOnDocument: type: string description: When true, the value is concealed on the document. example: example_value NoteTab: type: object description: A read-only note tab for displaying text. properties: tabId: type: string example: '500123' tabLabel: type: string example: example_value documentId: type: string example: '500123' pageNumber: type: string example: example_value recipientId: type: string example: '500123' xPosition: type: string example: example_value yPosition: type: string example: example_value value: type: string example: example_value recipientIdentityVerification: type: object properties: inputOptions: type: array description: '' items: $ref: '#/components/schemas/recipientIdentityInputOption' workflowId: type: string description: '' description: '' x-ds-definition-name: recipientIdentityVerification x-ms-summary: '' formulaTab: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: 'When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. disableAutoSize: type: string description: When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' formula: type: string description: 'Contains the formula for calculating the value of this tab. Use a tab''s `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields ' hidden: type: string description: 'If this is a regular formula (no `paymentDetails` property is present): * **true**: The tab is hidden. * **false**: The tab is shown. If the formula is payment item (a `paymentDetails` property is present): * **true**: The tab is displayed as a payment. * **false**: The tab is displayed as a regular formula. ' isPaymentAmount: type: string description: 'When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' paymentDetails: $ref: '#/components/schemas/paymentDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. roundDecimalPlaces: type: string description: '' senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) ' description: 'The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' x-ds-definition-name: formulaTab x-ms-summary: 'The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' approve: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: ' Specifies the approval text displayed in the tab. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to approve documents without placing a signature or initials on the document. ' x-ds-definition-name: approve x-ms-summary: 'A tab that allows the recipient to approve documents without placing a signature or initials on the document. ' recipientUpdateResponse: type: object properties: errorDetails: $ref: '#/components/schemas/errorDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs_2' description: '' x-ds-definition-name: recipientUpdateResponse x-ms-summary: '' CustomFields: type: object description: Envelope custom fields for metadata and integrations. properties: textCustomFields: type: array items: type: object properties: fieldId: type: string name: type: string value: type: string required: type: string show: type: string example: [] listCustomFields: type: array items: type: object properties: fieldId: type: string name: type: string value: type: string required: type: string show: type: string listItems: type: array items: type: string example: [] envelopeAuditEvent: type: object properties: eventFields: type: array description: '' items: $ref: '#/components/schemas/nameValue' description: '' x-ds-definition-name: envelopeAuditEvent x-ms-summary: '' RadioGroup: type: object description: A group of radio buttons for single-choice selection. properties: groupName: type: string description: The name of the radio group. example: example_value documentId: type: string example: '500123' recipientId: type: string example: '500123' radios: type: array items: type: object properties: value: type: string selected: type: string pageNumber: type: string xPosition: type: string yPosition: type: string anchorString: type: string example: [] required: type: string example: example_value documentHtmlCollapsibleDisplaySettings: type: object properties: arrowClosed: type: string description: '' arrowColor: type: string description: '' arrowLocation: type: string description: '' arrowOpen: type: string description: '' arrowSize: type: string description: '' arrowStyle: type: string description: '' containerStyle: type: string description: '' labelStyle: type: string description: '' onlyArrowIsClickable: type: boolean description: '' outerLabelAndArrowStyle: type: string description: '' description: '' x-ds-definition-name: documentHtmlCollapsibleDisplaySettings x-ms-summary: '' view: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: '' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: 'For conditional fields, this is the value of the parent tab that controls the tab''s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. ' customTabId: type: string description: The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: 'The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana ' fontColor: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: 'The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab requiredRead: type: string description: '' status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: 'The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. ' tabOrder: type: string description: 'A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'This tab is used with the Approve tab to handle supplemental documents.' x-ds-definition-name: view x-ms-summary: 'This tab is used with the Approve tab to handle supplemental documents.' eventResult: type: object properties: eventTimestamp: type: string description: '' failureDescription: type: string description: '' status: type: string description: Event status. vendorFailureStatusCode: type: string description: '' description: '' x-ds-definition-name: eventResult x-ms-summary: '' paymentSignerValues: type: object properties: paymentOption: type: string description: '' description: '' x-ds-definition-name: paymentSignerValues x-ms-summary: '' documentHtmlDefinition: type: object properties: displayAnchorPrefix: type: string description: '' displayAnchors: type: array description: '' items: $ref: '#/components/schemas/documentHtmlDisplayAnchor' displayOrder: type: string description: '' displayPageNumber: type: string description: '' documentGuid: type: string description: '' documentId: type: string description: The ID of the document being accessed. headerLabel: type: string description: '' maxScreenWidth: type: string description: '' removeEmptyTags: type: string description: '' showMobileOptimizedToggle: type: string description: '' source: type: string description: '' description: '' x-ds-definition-name: documentHtmlDefinition x-ms-summary: '' bulkEnvelopeStatus: type: object properties: batchId: type: string description: Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches. batchSize: type: string description: The number of items returned in this response. bulkEnvelopes: type: array description: 'Reserved: TBD' items: $ref: '#/components/schemas/bulkEnvelope' bulkEnvelopesBatchUri: type: string description: 'Reserved: TBD' endPosition: type: string description: 'The last position in the result set. ' failed: type: string description: 'The number of entries with a status of failed. ' nextUri: type: string description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ' previousUri: type: string description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ' queued: type: string description: 'The number of entries with a status of queued. ' resultSetSize: type: string description: 'The number of results returned in this response. ' sent: type: string description: The number of entries with a status of sent. startPosition: type: string description: Starting position of the current result set. submittedDate: type: string description: '' totalSetSize: type: string description: The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field. description: '' x-ds-definition-name: bulkEnvelopeStatus x-ms-summary: '' CarbonCopy: type: object description: A carbon copy recipient who receives a copy of the completed documents but does not need to take any action. properties: recipientId: type: string description: Unique identifier for the recipient. example: '500123' name: type: string description: The full name of the recipient. example: Example Title email: type: string format: email description: The email address of the recipient. example: user@example.com routingOrder: type: string description: The routing order of the recipient. example: example_value roleName: type: string description: The role name for template matching. example: example_value status: type: string description: The status of the recipient. example: example_value note: type: string description: A note for the recipient. example: example_value smartSectionAnchorPosition: type: object properties: pageNumber: type: integer description: The page number being accessed. format: int32 xPosition: type: number description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: double yPosition: type: number description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: double description: '' x-ds-definition-name: smartSectionAnchorPosition x-ms-summary: '' envelopeAuditEventResponse: type: object properties: auditEvents: type: array description: 'Reserved: TBD' items: $ref: '#/components/schemas/envelopeAuditEvent' description: '' x-ds-definition-name: envelopeAuditEventResponse x-ms-summary: '' parameters: envelopeId: name: envelopeId in: path required: true description: The envelope ID (GUID) of the envelope. schema: type: string format: uuid accountId: name: accountId in: path required: true description: The external account number (short) or account ID GUID of the DocuSign account. schema: type: string responses: NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' BadRequest: description: Bad request. The request body or parameters are invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' Unauthorized: description: Unauthorized. Authentication credentials are missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' securitySchemes: accessCode: type: oauth2 description: OAuth2 Access code Grant flows: authorizationCode: authorizationUrl: https://account.docusign.com/oauth/auth tokenUrl: https://account.docusign.com/oauth/auth scopes: organization_read: '' permission_read: '' group_read: '' user_read: '' account_read: '' account_write: '' user_write: '' identity_provider_read: '' domain_read: '' x-ds-categories: - name: UserManagement summary: Methods to manage users in an account. description: Methods to manage users in an account. - name: BulkOperations summary: Methods to import and export users and accounts. description: Methods to import and export users and accounts. - name: IdentityProviders summary: Methods to get a list of identity providers. description: Methods to get a list of identity providers. - name: ReservedDomains summary: Methods to get a list of reserved domains. description: Methods to get a list of reserved domains. - name: Organization summary: Methods for working with organizations. description: Methods for working with organizations. x-original-swagger-version: '2.0'