Docusign EnvelopeConsumerDisclosures API

openapi: 3.2.0
info:
  title: Docusign Envelope Consumer Disclosures API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeConsumerDisclosures across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: EnvelopeConsumerDisclosures
  description: The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure:
    get:
      tags:
      - EnvelopeConsumerDisclosures
      summary: Docusign Gets the Electronic Record and Signature Disclosure associated with…
      description: Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
      operationId: ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId
      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: langCode
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/consumerDisclosure'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getConsumerDisclosureDefault
      x-ds-method: getDefault
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}:
    get:
      tags:
      - EnvelopeConsumerDisclosures
      summary: 'Docusign Reserved: Gets the Electronic Record and Signature Disclosure…'
      description: 'Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.'
      operationId: ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode
      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: langCode
        in: path
        description: The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), 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), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), 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). Additionally, the value can be set to "browser" to automatically detect the browser language being used by the viewer and display the disclosure in that language.
        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: langCode
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/consumerDisclosure'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getConsumerDisclosure
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure:
    parameters: []
    get:
      tags:
      - EnvelopeConsumerDisclosures
      summary: Gets the default Electronic Record and Signature Disclosure for an envelope
      description: 'Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify.


        This is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.


        To set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.'
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdRecipientsByRecipientIdConsumerDisclosure
      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. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      - name: recipientId
        in: path
        description: 'A local reference used to map

          recipients to other objects, such as specific

          document tabs.


          A `recipientId` must be

          either an integer or a GUID,

          and the `recipientId` must be

          unique within an envelope.


          For example, many envelopes assign the first recipient

          a `recipientId` of `1`.

          '
        required: true
        schema:
          type: string
      - name: langCode
        in: query
        required: false
        description: "(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/consumerDisclosure_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getConsumerDisclosureDefault
      x-ds-method: getDefault
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}:
    parameters: []
    get:
      tags:
      - EnvelopeConsumerDisclosures
      summary: Gets the Electronic Record and Signature Disclosure for a specific envelope…
      description: 'Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient''s language settings.


        To set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.'
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdRecipientsByRecipientIdConsumerDisclosureByLangCode
      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. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      - name: langCode
        in: path
        description: "(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
        required: true
        schema:
          type: string
      - name: recipientId
        in: path
        description: 'A local reference used to map

          recipients to other objects, such as specific

          document tabs.


          A `recipientId` must be

          either an integer or a GUID,

          and the `recipientId` must be

          unique within an envelope.


          For example, many envelopes assign the first recipient

          a `recipientId` of `1`.

          '
        required: true
        schema:
          type: string
      - name: langCode
        in: query
        required: false
        description: "(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/consumerDisclosure_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getConsumerDisclosure
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    settingsMetadata:
      type: object
      properties:
        is21CFRPart11:
          type: string
          description: When set to **true**, indicates that this module is enabled on the account.
        options:
          type: array
          description: ''
          items:
            type: string
        rights:
          type: string
          description: ''
        uiHint:
          type: string
          description: ''
        uiOrder:
          type: string
          description: ''
        uiType:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: settingsMetadata
      x-ms-summary: ''
    consumerDisclosure:
      type: object
      properties:
        accountEsignId:
          type: string
          description: A GUID identifying the account associated with the consumer disclosure
        allowCDWithdraw:
          type: string
          description: Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
        allowCDWithdrawMetadata:
          $ref: '#/components/schemas/settingsMetadata'
        changeEmail:
          type: string
          description: ''
        changeEmailOther:
          type: string
          description: ''
        companyName:
          type: string
          description: The name of the user's Company.
        companyPhone:
          type: string
          description: The phone number of the company associated with the consumer disclosure.
        copyCostPerPage:
          type: string
          description: ''
        copyFeeCollectionMethod:
          type: string
          description: 'Specifies the fee collection method for cases in which the customer requires paper copies of the document.


            Maximum Length: 255 characters'
        copyRequestEmail:
          type: string
          description: ''
        custom:
          type: string
          description: ''
        enableEsign:
          type: string
          description: ''
        esignAgreement:
          type: string
          description: The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.
        esignText:
          type: string
          description: ''
        languageCode:
          type: string
          description: ''
        mustAgreeToEsign:
          type: string
          description: ''
        pdfId:
          type: string
          description: "**Deprecated**\n\nThe `\x80\x9CpdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
        useBrand:
          type: string
          description: ''
        useConsumerDisclosureWithinAccount:
          type: string
          description: ''
        useConsumerDisclosureWithinAccountMetadata:
          $ref: '#/components/schemas/settingsMetadata'
        withdrawAddressLine1:
          type: string
          description: 'Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 100 characters. '
        withdrawAddressLine2:
          type: string
          description: 'Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 100 characters. '
        withdrawByEmail:
          type: string
          description: Indicates whether the customer can withdraw consent by email.
        withdrawByMail:
          type: string
          description: Indicates whether the customer can withdraw consent by postal mail.
        withdrawByPhone:
          type: string
          description: Indicates whether the customer can withdraw consent by phone.
        withdrawCity:
          type: string
          description: 'Contains the city of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 50 characters. '
        withdrawConsequences:
          type: string
          description: Indicates the consequences of withdrawing consent.
        withdrawEmail:
          type: string
          description: 'Contains the email address to which a customer can send a consent withdrawal notification.


            Maximum length: 100 characters. '
        withdrawOther:
          type: string
          description: 'Indicates other information need to withdraw consent.


            Maximum length: 255 characters.'
        withdrawPhone:
          type: string
          description: 'Contains the phone number which a customer can call to register consent withdrawal notification.


            Maximum length: 20 characters. '
        withdrawPostalCode:
          type: string
          description: 'Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 20 characters. '
        withdrawState:
          type: string
          description: Contains the state of the postal address to which a customer can send a consent withdrawal notification.
      description: ''
      x-ds-definition-name: consumerDisclosure
      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.
    settingsMetadata_2:
      type: object
      properties:
        is21CFRPart11:
          description: When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
          type: string
        options:
          description: An array of option strings supported by this setting.
          type: array
          items:
            type: string
        rights:
          description: 'Indicates whether the property is editable. Valid values are:


            - `editable`

            - `read_only`'
          type: string
        uiHint:
          description: Reserved for Docusign.
          type: string
        uiOrder:
          description: Reserved for Docusign.
          type: string
        uiType:
          description: Reserved for Docusign.
          type: string
      description: Metadata that indicates whether a property is editable and describes setting-specific options.
      x-ds-definition-name: settingsMetadata
      x-ms-summary: Metadata that indicates whether a property is editable and describes setting-specific options.
    consumerDisclosure_2:
      type: object
      properties:
        accountEsignId:
          description: The GUID of the account associated with the consumer disclosure.
          type: string
        allowCDWithdraw:
          description: 'When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**

            **Note:** Only Admin users can change this setting.'
          type: string
        allowCDWithdrawMetadata:
          $ref: '#/components/schemas/settingsMetadata_2'
          description: 'Metadata that indicates whether the `allowCDWithdraw` property is editable.

            '
        changeEmail:
          description: 'If the customer needs to change their email address, this is the email address to which they should the change request.


            Maximum length: 100 characters.'
          type: string
        changeEmailOther:
          description: "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`"
          type: string
        companyName:
          description: 'Specifies the company name used in the disclosure. The default value is the account name.


            However, if your account uses signing brands that specify a company name, you can substitute the brand''s company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.


            **Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**'
          type: string
        companyPhone:
          description: The phone number of the company associated with the consumer disclosure, as a free-formatted string.
          type: string
        copyCostPerPage:
          description: "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
          type: string
        copyFeeCollectionMethod:
          description: "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`"
          type: string
        copyRequestEmail:
          description: 'The email address to which the customer should send a request for copies of a document.


            Maximum length: 100 characters.'
          type: string
        custom:
          description: When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**
          type: string
        enableEsign:
          description: When **true** (default), indicates that eSign is enabled.
          type: string
        esignAgreement:
          description: The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting.
          type: string
        esignText:
          description: 'The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.


            **Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.'
          type: string
        languageCode:
          description: "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
          type: string
        mustAgreeToEsign:
          description: When **true,** the  recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions.
          type: string
        pdfId:
          description: "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
          type: string
        useBrand:
          description: "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.  \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. "
          type: string
        useConsumerDisclosureWithinAccount:
          description: When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
          type: string
        useConsumerDisclosureWithinAccountMetadata:
          $ref: '#/components/schemas/settingsMetadata_2'
          description: 'Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.

            '
        withdrawAddressLine1:
          description: 'Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 100 characters. '
          type: string
        withdrawAddressLine2:
          description: 'Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 100 characters. '
          type: string
        withdrawByEmail:
          description: When **true** (default), indicates that the customer can withdraw consent by email.
          type: string
        withdrawByMail:
          description: When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**
          type: string
        withdrawByPhone:
          description: When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**
          type: string
        withdrawCity:
          description: 'Contains the city of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 50 characters. '
          type: string
        withdrawConsequences:
          description: 'Text indicating the consequences of withdrawing consent.


            Maximum length: 255 characters.'
          type: string
        withdrawEmail:
          description: 'Contains the email address to which a customer can send a consent withdrawal notification.


            Maximum length: 100 characters. '
          type: string
        withdrawOther:
          description: 'Contains any other information needed to withdraw consent.


            Maximum length: 255 characters.


            Example:


            `We do not need any other information from you to withdraw consent.`'
          type: string
        withdrawPhone:
          description: 'Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.


            Maximum length: 20 characters. '
          type: string
        withdrawPostalCode:
          description: 'Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.


            Maximum length: 20 characters. '
          type: string
        withdrawState:
          description: 'Contains the state of the postal address to which a customer can send a consent withdrawal notification.


            Example: `PA`'
          type: string
      description: Details about consumer disclosures.
      x-ds-definition-name: consumerDisclosure
      x-ms-summary: Details about consumer disclosures.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
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'