Chilkat Online Tools

lianja / DocuSign REST API / Retrieves the user initials image or the user signature image for the specified user.

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("include_chrome","{{include_chrome}}")

// Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","image/gif")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}/signatures/{{signatureId}}/{{imageType}}",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loQueryParams

Curl Command

curl -G -d "include_chrome=%7B%7Binclude_chrome%7D%7D"
	-H "Accept: image/gif"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}/signatures/{{signatureId}}/{{imageType}}

Postman Collection Item JSON

{
  "name": "Retrieves the user initials image or the  user signature image for the specified user.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "image/gif"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users/{{userId}}/signatures/{{signatureId}}/{{imageType}}?include_chrome={{include_chrome}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "users",
        "{{userId}}",
        "signatures",
        "{{signatureId}}",
        "{{imageType}}"
      ],
      "query": [
        {
          "key": "include_chrome",
          "value": "{{include_chrome}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "imageType",
          "value": "{{imageType}}"
        },
        {
          "key": "signatureId",
          "value": "{{signatureId}}"
        },
        {
          "key": "userId",
          "value": "{{userId}}"
        }
      ]
    },
    "description": "Retrieves the specified initials image or signature image for the specified user. 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 property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n\n###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image."
  },
  "response": [
  ]
}