Chilkat Online Tools

DataFlex / DocuSign eSignature REST API / Returns a URL to the recipient view UI.

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "clientUserId": "sample string 1",
    //   "userId": "sample string 2",
    //   "userName": "sample string 3",
    //   "email": "sample string 4",
    //   "recipientId": "sample string 5",
    //   "returnUrl": "sample string 6",
    //   "pingUrl": "sample string 7",
    //   "pingFrequency": "sample string 8",
    //   "authenticationMethod": "sample string 9",
    //   "assertionId": "sample string 10",
    //   "authenticationInstant": "sample string 11",
    //   "securityDomain": "sample string 12",
    //   "xFrameOptions": "sample string 13",
    //   "xFrameOptionsAllowFromUrl": "sample string 14",
    //   "frameAncestors": [
    //     "sample string 1"
    //   ]
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "clientUserId" "sample string 1" To iSuccess
    Get ComUpdateString Of hoJson "userId" "sample string 2" To iSuccess
    Get ComUpdateString Of hoJson "userName" "sample string 3" To iSuccess
    Get ComUpdateString Of hoJson "email" "sample string 4" To iSuccess
    Get ComUpdateString Of hoJson "recipientId" "sample string 5" To iSuccess
    Get ComUpdateString Of hoJson "returnUrl" "sample string 6" To iSuccess
    Get ComUpdateString Of hoJson "pingUrl" "sample string 7" To iSuccess
    Get ComUpdateString Of hoJson "pingFrequency" "sample string 8" To iSuccess
    Get ComUpdateString Of hoJson "authenticationMethod" "sample string 9" To iSuccess
    Get ComUpdateString Of hoJson "assertionId" "sample string 10" To iSuccess
    Get ComUpdateString Of hoJson "authenticationInstant" "sample string 11" To iSuccess
    Get ComUpdateString Of hoJson "securityDomain" "sample string 12" To iSuccess
    Get ComUpdateString Of hoJson "xFrameOptions" "sample string 13" To iSuccess
    Get ComUpdateString Of hoJson "xFrameOptionsAllowFromUrl" "sample string 14" To iSuccess
    Get ComUpdateString Of hoJson "frameAncestors[0]" "sample string 1" To iSuccess

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    Set ComAuthToken Of hoHttp To "{{accessToken}}"
    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/recipient" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "clientUserId": "sample string 1",
  "userId": "sample string 2",
  "userName": "sample string 3",
  "email": "sample string 4",
  "recipientId": "sample string 5",
  "returnUrl": "sample string 6",
  "pingUrl": "sample string 7",
  "pingFrequency": "sample string 8",
  "authenticationMethod": "sample string 9",
  "assertionId": "sample string 10",
  "authenticationInstant": "sample string 11",
  "securityDomain": "sample string 12",
  "xFrameOptions": "sample string 13",
  "xFrameOptionsAllowFromUrl": "sample string 14",
  "frameAncestors": [
    "sample string 1"
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/recipient

Postman Collection Item JSON

{
  "name": "Returns a URL to the recipient view UI.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"clientUserId\": \"sample string 1\",\n  \"userId\": \"sample string 2\",\n  \"userName\": \"sample string 3\",\n  \"email\": \"sample string 4\",\n  \"recipientId\": \"sample string 5\",\n  \"returnUrl\": \"sample string 6\",\n  \"pingUrl\": \"sample string 7\",\n  \"pingFrequency\": \"sample string 8\",\n  \"authenticationMethod\": \"sample string 9\",\n  \"assertionId\": \"sample string 10\",\n  \"authenticationInstant\": \"sample string 11\",\n  \"securityDomain\": \"sample string 12\",\n  \"xFrameOptions\": \"sample string 13\",\n  \"xFrameOptionsAllowFromUrl\": \"sample string 14\",\n  \"frameAncestors\": [\n    \"sample string 1\"\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/recipient",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "views",
        "recipient"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    },
    "description": "Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. \n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. \n\nAn entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity."
  },
  "response": [
  ]
}