Docusign Account Signatures API

openapi: 3.2.0
info:
  version: v2.1
  title: Docusign eSignature REST Account Signatures API
  description: The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  contact:
    name: Docusign Developer Center
    url: https://developers.docusign.com/
    email: devcenter@docusign.com
servers:
- url: https://www.docusign.net/restapi
tags:
- name: AccountSignatures
  description: 'In certain countries, stamps are used to certify documents. This resource provides methods to manage stamps available in your account.


    To use these endpoints, your account must have Managed Stamps enabled. Contact your Docusign account manager for more information.


    ### Related topics

    - Sending and Signing with eHanko

    - Docusign eSignature Admin Guide: Stamps'
paths:
  /v2.1/accounts/{accountId}/signatures:
    parameters: []
    get:
      tags:
      - AccountSignatures
      summary: Returns a list of stamps available in the account
      operationId: AccountSignatures_GetAccountSignatures
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: stamp_format
        in: query
        required: false
        description: 'The format of the stamp to return. Valid values:

          - `NameDateHanko`

          - `NameHanko`

          - `PlaceholderHanko`'
        schema:
          type: string
      - name: stamp_name
        in: query
        required: false
        description: The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.
        schema:
          type: string
      - name: stamp_type
        in: query
        required: false
        description: 'The type of the stamps to return. Valid values:

          - `name_stamp`

          - `stamp`

          - `signature`'
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignaturesInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAccountSignatures
      description: Returns a list of stamps available in the account.
      x-ds-method: getAccountSignatures
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    put:
      tags:
      - AccountSignatures
      summary: Updates an account stamp
      operationId: AccountSignatures_PutAccountSignature
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignaturesInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateAccountSignature
      description: Adds or updates one or more account stamps. This request may include images in multi-part format.
      x-ds-method: updateAccountSignature
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountSignaturesInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/accountSignaturesInformation'
    post:
      tags:
      - AccountSignatures
      summary: Adds or updates one or more account stamps
      operationId: AccountSignatures_PostAccountSignatures
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: decode_only
        in: query
        required: false
        description: ''
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignaturesInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createAccountSignatures
      description: Adds or updates one or more account stamps.
      x-ds-method: createAccountSignatures
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountSignaturesInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/accountSignaturesInformation'
  /v2.1/accounts/{accountId}/signatures/{signatureId}:
    parameters: []
    get:
      tags:
      - AccountSignatures
      summary: Returns information about the specified stamp
      operationId: AccountSignatures_GetAccountSignature
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: signatureId
        in: path
        description: The ID of the account stamp.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignature'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAccountSignature
      description: Returns information about the specified stamp.
      x-ds-method: getAccountSignature
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    put:
      tags:
      - AccountSignatures
      summary: Updates an account stamp by ID
      operationId: AccountSignatures_PutAccountSignatureById
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: signatureId
        in: path
        description: The ID of the account stamp.
        required: true
        schema:
          type: string
      - name: close_existing_signature
        in: query
        required: false
        description: When **true,** closes the current signature.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignature'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateAccountSignatureById
      description: Updates an account stamp specified by the `signatureId` query parameter.
      x-ds-method: updateAccountSignatureById
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountSignatureDefinition'
          application/xml:
            schema:
              $ref: '#/components/schemas/accountSignatureDefinition'
    delete:
      tags:
      - AccountSignatures
      summary: Deletes an account stamp
      operationId: AccountSignatures_DeleteAccountSignature
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: signatureId
        in: path
        description: The ID of the account stamp.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteAccountSignature
      description: Deletes a stamp specified by `signatureId`.
      x-ds-method: deleteAccountSignature
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
  /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}:
    parameters: []
    get:
      tags:
      - AccountSignatures
      summary: Returns the image for an account stamp
      operationId: AccountSignatures_GetAccountSignatureImage
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: imageType
        in: path
        description: 'Specificies the type of image. Valid values:


          - `stamp_image`

          - `signature_image`

          - `initials_image`'
        required: true
        schema:
          type: string
      - name: signatureId
        in: path
        description: The ID of the account stamp.
        required: true
        schema:
          type: string
      - name: include_chrome
        in: query
        required: false
        description: When **true,** the chrome (or frame containing the added line and identifier) is included with the signature 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: getAccountSignatureImage
      description: Returns the image for an account stamp.
      x-ds-method: getAccountSignatureImage
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    put:
      tags:
      - AccountSignatures
      summary: Sets a signature image, initials, or stamp
      operationId: AccountSignatures_PutAccountSignatureImage
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: imageType
        in: path
        description: 'Specificies the type of image. Valid values:


          - `stamp_image`

          - `signature_image`

          - `initials_image`'
        required: true
        schema:
          type: string
      - name: signatureId
        in: path
        description: The ID of the account stamp.
        required: true
        schema:
          type: string
      - name: transparent_png
        in: query
        required: false
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignature'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateAccountSignatureImage
      description: Sets a signature image, initials, or stamp.
      x-ds-method: updateAccountSignatureImage
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
    delete:
      tags:
      - AccountSignatures
      summary: Deletes the image for a stamp
      operationId: AccountSignatures_DeleteAccountSignatureImage
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: imageType
        in: path
        description: 'Specificies the type of image. Valid values:


          - `stamp_image`

          - `signature_image`

          - `initials_image`'
        required: true
        schema:
          type: string
      - name: signatureId
        in: path
        description: The ID of the account stamp.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountSignature'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteAccountSignatureImage
      description: Deletes the image for a stamp specified by `signatureId`.
      x-ds-method: deleteAccountSignatureImage
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
components:
  schemas:
    signatureGroupDef:
      type: object
      properties:
        groupId:
          description: The ID of the group being accessed.
          type: string
        rights:
          description: 'Indicates whether the property is editable. Valid values are:


            - `editable`

            - `read_only`'
          type: string
      x-ds-definition-name: signatureGroupDef
      description: ''
      x-ms-summary: ''
    accountSignatureDefinition:
      type: object
      properties:
        dateStampProperties:
          $ref: '#/components/schemas/dateStampProperties'
          description: 'Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.


            This property contains the following information about the central rectangle:


            - `DateAreaX`: The X axis position of the top-left corner.

            - `DateAreaY`: The Y axis position of the top-left corner.

            - `DateAreaWidth`: The width of the rectangle.

            - `DateAreaHeight`: The height of the rectangle.'
        disallowUserResizeStamp:
          description: When **true,** users may not resize the stamp.
          type: string
        externalID:
          description: Optionally specify an external identifier for the user's signature.
          type: string
        imageType:
          description: 'Specificies the type of image. Valid values:


            - `stamp_image`

            - `signature_image`

            - `initials_image`'
          type: string
        isDefault:
          description: Boolean that specifies whether the signature is the default signature for the user.
          type: string
        nrdsId:
          description: The National Association of Realtors (NAR) membership ID for a user who is a realtor.
          type: string
        nrdsLastName:
          description: The realtor's last name.
          type: string
        phoneticName:
          description: The phonetic spelling of the `signatureName`.
          type: string
        signatureFont:
          description: 'The font type to use for the signature if the signature is not drawn. The following font styles  are supported. The quotes are to indicate that these values are strings, not `enums`.


            - `"1_DocuSign"`

            - `"2_DocuSign"`

            - `"3_DocuSign"`

            - `"4_DocuSign"`

            - `"5_DocuSign"`

            - `"6_DocuSign"`

            - `"7_DocuSign"`

            - `"8_DocuSign"`

            - `"Mistral"`

            - `"Rage Italic"`

            '
          type: string
        signatureGroups:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/signatureGroupDef'
        signatureId:
          description: Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.
          type: string
        signatureInitials:
          description: Specifies the user's signature in initials format.
          type: string
        signatureName:
          description: Specifies the user's signature name.
          type: string
        signatureType:
          description: Specifies the type of signature.
          type: string
        signatureUsers:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/signatureUserDef'
        stampFormat:
          description: 'The format of a stamp. Valid values are:


            - `NameHanko`: The stamp represents only the signer''s name.

            - `NameDateHanko`: The stamp represents the signer''s name and the date. '
          type: string
        stampSizeMM:
          description: The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
          type: string
      x-ds-definition-name: accountSignatureDefinition
      description: ''
      x-ms-summary: ''
    accountSignature:
      type: object
      properties:
        adoptedDateTime:
          description: The UTC date and time when the user adopted the signature.
          type: string
        createdDateTime:
          description: The UTC DateTime when the item was created.
          type: string
        customField:
          description: ''
          type: string
        dateStampProperties:
          $ref: '#/components/schemas/dateStampProperties'
          description: 'Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.


            This property contains the following information about the central rectangle:


            - `DateAreaX`: The X axis position of the top-left corner.

            - `DateAreaY`: The Y axis position of the top-left corner.

            - `DateAreaWidth`: The width of the rectangle.

            - `DateAreaHeight`: The height of the rectangle.'
        disallowUserResizeStamp:
          description: When **true,** users may not resize the stamp.
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        externalID:
          description: Optionally specify an external identifier for the user's signature.
          type: string
        imageBase64:
          description: ''
          type: string
        imageType:
          description: 'Specificies the type of image. Valid values:


            - `stamp_image`

            - `signature_image`

            - `initials_image`'
          type: string
        initials150ImageId:
          description: The ID of the user's initials image.
          type: string
        initialsImageUri:
          description: The URI for retrieving the image of the user's initials.
          type: string
        isDefault:
          description: Boolean that specifies whether the signature is the default signature for the user.
          type: string
        lastModifiedDateTime:
          description: The date and time that the item was last modified.
          type: string
        nrdsId:
          description: The National Association of Realtors (NAR) membership ID for a user who is a realtor.
          type: string
        nrdsLastName:
          description: The realtor's last name.
          type: string
        nrdsStatus:
          description: 'The realtor''s NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:


            - `Active`

            - `Inactive`

            - `Terminate`

            - `Provisional`

            - `Deceased`

            - `Suspend`

            - `Unknown`'
          type: string
        phoneticName:
          description: The phonetic spelling of the `signatureName`.
          type: string
        signature150ImageId:
          description: The ID of the user's signature image.
          type: string
        signatureFont:
          description: 'The font type to use for the signature if the signature is not drawn. The following font styles  are supported. The quotes are to indicate that these values are strings, not `enums`.


            - `"1_DocuSign"`

            - `"2_DocuSign"`

            - `"3_DocuSign"`

            - `"4_DocuSign"`

            - `"5_DocuSign"`

            - `"6_DocuSign"`

            - `"7_DocuSign"`

            - `"8_DocuSign"`

            - `"Mistral"`

            - `"Rage Italic"`

            '
          type: string
        signatureGroups:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/signatureGroup'
        signatureId:
          description: Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.
          type: string
        signatureImageUri:
          description: An endpoint URI that you can use to retrieve the user's signature image.
          type: string
        signatureInitials:
          description: Specifies the user's signature in initials format.
          type: string
        signatureName:
          description: Specifies the user's signature name.
          type: string
        signatureRights:
          description: 'The rights that the user has to the signature. Valid values are:


            - `none`

            - `read`

            - `admin`'
          type: string
        signatureType:
          description: Specifies the type of signature.
          type: string
        signatureUsers:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/signatureUser'
        stampFormat:
          description: 'The format of a stamp. Valid values are:


            - `NameHanko`: The stamp represents only the signer''s name.

            - `NameDateHanko`: The stamp represents the signer''s name and the date. '
          type: string
        stampImageUri:
          description: The URI for retrieving the image of the user's stamp.
          type: string
        stampSizeMM:
          description: The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
          type: string
        stampType:
          description: 'The type of stamp. Valid values are:


            - `signature`: A signature image. This is the default value.

            - `stamp`: A stamp image.

            - null'
          type: string
        status:
          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."
          type: string
      x-ds-definition-name: accountSignature
      description: ''
      x-ms-summary: ''
    signatureUserDef:
      type: object
      properties:
        isDefault:
          description: Boolean that specifies whether the signature is the default signature for the user.
          type: string
        rights:
          description: 'Indicates whether the property is editable. Valid values are:


            - `editable`

            - `read_only`'
          type: string
        userId:
          description: 'The ID of the user to access.


            **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user''s settings.'
          type: string
      x-ds-definition-name: signatureUserDef
      description: ''
      x-ms-summary: ''
    errorDetails:
      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.
    signatureUser:
      type: object
      properties:
        isDefault:
          description: Boolean that specifies whether the signature is the default signature for the user.
          type: string
        rights:
          description: 'Indicates whether the property is editable. Valid values are:


            - `editable`

            - `read_only`'
          type: string
        userId:
          description: 'The ID of the user to access.


            **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user''s settings.'
          type: string
        userName:
          description: The name of the user.
          type: string
      x-ds-definition-name: signatureUser
      description: ''
      x-ms-summary: ''
    dateStampProperties:
      type: object
      properties:
        dateAreaHeight:
          description: The height of the rectangle.
          type: string
        dateAreaWidth:
          description: The width of the rectangle.
          type: string
        dateAreaX:
          description: The X axis position of the top-left corner.
          type: string
        dateAreaY:
          description: The Y axis position of the top-left corner.
          type: string
      description: 'Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.


        This property contains the following information about the central rectangle:


        - `DateAreaX`: The X axis position of the top-left corner.

        - `DateAreaY`: The Y axis position of the top-left corner.

        - `DateAreaWidth`: The width of the rectangle.

        - `DateAreaHeight`: The height of the rectangle.'
      x-ds-definition-name: dateStampProperties
      x-ms-summary: 'Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.


        This property contains the following information about the central rectangle:


        - `DateAreaX`: The X axis position of the top-left corner.

        - `DateAreaY`: The Y axis position of the top-left corner.

        - `DateAreaWidth`: The width of the rectangle.

        - `DateAreaHeight`: The height of the rectangle.'
    accountSignaturesInformation:
      type: object
      properties:
        accountSignatures:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/accountSignature'
      x-ds-definition-name: accountSignaturesInformation
      description: ''
      x-ms-summary: ''
    signatureGroup:
      type: object
      properties:
        groupId:
          description: The ID of the group being accessed.
          type: string
        groupName:
          description: The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.
          type: string
        rights:
          description: 'Indicates whether the property is editable. Valid values are:


            - `editable`

            - `read_only`'
          type: string
      x-ds-definition-name: signatureGroup
      description: ''
      x-ms-summary: ''
externalDocs:
  description: See the Docusign eSignature REST API Guide for more information.
  url: https://docs.docusign.com/esign
x-ds-allow-editing: false
x-ds-categories:
- name: Envelopes
  summary: This section shows you how to create and send envelopes.
  description: 'The eSignature API Envelope category includes the resources and methods for sending and managing envelopes and envelope data.


    Envelopes are the key objects in the Docusign platform. As a result, they are complex data structures with few required fields. See the [How-to guides](/docs/esign-rest-api/how-to/) for examples and solutions.


    To learn more about envelopes, see [Envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/).

    '


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/docusign/openapi/docusign-accountsignatures-api-openapi.yml