Flow Service API

<?php
$data = [
  'document' => [
    'documentId' => 'ID_FROM_STEP_1',
    'overlayId' => ''
  ],
  'imageUpload' => [
    'imageUploadDescription' => 'Take a picture of some form of identification',
    'imageUploadRequested' => 'true'
  ],
  'standaloneSignatureRequested' => 'true'
];

my $data = {
  'document' => {
    'documentId' => 'ID_FROM_STEP_1',
    'overlayId' => ''
  },
  'imageUpload' => {
    'imageUploadDescription' => 'Take a picture of some form of identification',
    'imageUploadRequested' => 'true'
  },
  'standaloneSignatureRequested' => 'true'
};

data = {
  'document' => {
    'documentId' => 'ID_FROM_STEP_1',
    'overlayId' => ''
  },
  'imageUpload' => {
    'imageUploadDescription' => 'Take a picture of some form of identification',
    'imageUploadRequested' => 'true'
  },
  'standaloneSignatureRequested' => 'true'
};

<?php
$data = [
  'document' => [
    'documentId' => 'ID_FROM_STEP_1',
    'overlayId' => ''
  ],
  'standaloneSignatureRequested' => 'true'
];

my $data = {
  'document' => {
    'documentId' => 'ID_FROM_STEP_1',
    'overlayId' => ''
  },
  'standaloneSignatureRequested' => 'true'
};

data = {
  'document' => {
    'documentId' => 'ID_FROM_STEP_1',
    'overlayId' => ''
  },
  'standaloneSignatureRequested' => 'true'
};

Expected HTTP Status codes

Status '200':
Description = 'Success.'

Status: '400':
Description = 'Malformed request. The request is either incorrectly formatted, or there are validation errors.'

Status '401':
Description = 'Invalid credentials.'

Status '403':
Description = 'Service not activated.'

Status '404':
Description = 'The requested signature/document/image was not found.'

Status '405':
Description = 'POST, GET, PUT request not supported for resource.'

Status '500':
Description = 'An internal error has occurred.'

<?php
$paymentType = 'CARD';
$payment = [
  'accountNumber' => 'YourAccountNumber',
  'paymentAmount' => '$125.00',
  'feeAmount' => '$5.00',
  'feePercentage' => 0,
  'accountDirective' => '0000',
  'editablePaymentAmount' => 'true',
  'minimumAmount' => '100.00'
];
if($paymentType == 'CARD') {
  $payment['paymentType'] = 'CC';
  $payment['ccTransaction'] = [
    'creditCardExpirationMonth' => '09',
    'creditCardExpirationYear' => '2022',
    'creditCardToken' => 'CardTokenFromPDC'
  ];
}
else if($paymentType == 'CHECK') {
  $payment['paymentType'] = 'ACH';
  $payment['achTransaction'] = [
    'bankAccountNumber' => 'aBankToken123456',
    'bankAccountNumberLastFour' => '3456',
    'bankAccountType' => 'CHECKING',
    'bankRoutingNumber' => '124001545',
    'checkNumber' => '1'
  ];
}

$roundTripList = [];
$roundTripList[] = [
  'rtName' => 'personalIdNumber',
  'rtValue' => '1234Number'
];

$data = [
  'customMessage' => 'Thank you for buying!',
  'description' => 'Agreement for mortgage.',
  'emailAddress' => 'frontenduser@pdc4u.com',
  'firstName' => 'Adam',
  'lastName' => 'Test',
  'maxPinAttempts' => '2',
  'mobileNumber' => '7777777777',
  'pinDescription' => 'Last four of your social security number',
  'verificationPageHeader' => 'Text that will be displayed at the top of the verification page',
  'redirectLink' => 'https://www.pdcflow.com',
  'requestGeolocation' => 'true',
  'roundTripNVPS' => $roundTripList,
  'payment' => $payment,
  'companyOverride' => [
    'companyName' => 'Our Child Company'
  ],
  'document' => [
    'documentId' => '1',
    'overlayId' => '1',
    'prePopulateVariables' => [
        'firstName' => 'Adam'
    ]
  ],
  'imageUpload' => [
    'imageUploadDescription' => 'Upload photo id',
    'imageUploadRequested' => 'true',
  ],
  'standaloneSignatureRequested' => 'true',
  'templateName' => 'SignatureOnly',
  'timeoutMinutes' => '4.5',
  'transactionOrigin' => 'EXT',
  'username' => 'someuser@pdc4u.com',
  'verificationPin' => '1235',
  'postbackUrl' => 'https://www.testpostbackaddress.com'
];

$url = 'https://flowdemo.pdcflow.com/api/v2_0/signatures';

$curl = curl_init();

curl_setopt($curl, CURLOPT_POST, 1);
$data = json_encode($data, JSON_UNESCAPED_SLASHES);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
  ]);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "someSecretUsername:someSecretPassword");
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5);  //num seconds to try connecting
curl_setopt($curl, CURLOPT_TIMEOUT, 30); //max number of seconds to allow execution

$result = curl_exec($curl);

$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// View response
print_r(json_decode($result, true));

if($statusCode == '200') {
  echo $result;
}
else {
  echo "Error #:" . $statusCode;
}
curl_close($curl);

#!/usr/bin/perl

use LWP::UserAgent;
use HTTP::Request;
use HTTP::Request::Common;
use JSON::XS;
use IO::Socket::SSL qw(debug3); # verbose for troubleshooting

eval {
   my $paymentType = 'CARD';
   my %payment = (
      'accountNumber' => 'YourAccountNumber',
      'paymentAmount' => '$125.00',
      'feeAmount' => '$5.00',
      'feePercentage' => '0',
      'accountDirective' => '0000',
      'editablePaymentAmount' => 'true',
      'minimumAmount' => '100.00'
   );
   if($paymentType eq 'CARD') {
      $payment{'paymentType'} = 'CC';
      $payment{'ccTransaction'} = {
         'creditCardExpirationMonth' => '09',
         'creditCardExpirationYear' => '2022',
         'creditCardToken' => 'CardTokenFromPDC'
      };
   }
   elsif ($paymentType == 'CHECK'){
      $payment{'paymentType'} = 'ACH';
      $payment{'achTransaction'} = {
         'bankAccountNumber' => 'aBankToken123456',
         'bankAccountNumberLastFour' => '3456',
         'bankAccountType' => 'CHECKING',
         'bankRoutingNumber' => '124001545',
         'checkNumber' => '1'
      };
   }
   my $roundTripList = [ {'rtName'=>'personalIdNumber'}, {'rtValue'=>'1234abcd'} ];

   my $data = {
      'customMessage' => 'Thank you for buying!',
      'description' => 'Agreement for mortgage.',
      'emailAddress' => 'frontenduser@pdc4u.com',
      'firstName' => 'Adam',
      'lastName' => 'Test',
      'maxPinAttempts' => '2',
      'mobileNumber' => '7777777777',
      'pinDescription' => 'Last four of your social security number',
      'verificationPageHeader' => 'Text that will be displayed at the top of the verification page',
      'redirectLink' => 'https://www.pdcflow.com',
      'requestGeolocation' => 'true',
      'roundTripNVPS' => $roundTripList,
      'payment' => \%payment,
      'companyOverride' => {
        'companyName' => 'Our Child Company'
      },
      'document' => {
         'documentId' => '1',
         'overlayId' => '' #Specify to include an overlay
      },
      'imageUpload' => {
         'imageUploadDescription' => 'Upload photo id',
         'imageUploadRequested' => 'true',
      },
      'standaloneSignatureRequested' => 'true',
      'templateName' => 'SignatureOnly',
      'timeoutMinutes' => '4.5',
      'transactionOrigin' => 'EXT',
      'username' => 'someuser@pdc4u.com',
      'verificationPin' => '1235',
      'customEmailBody' => 'We would like to capture authorization that you approve this message. Please click the following link to authorize our transaction.',
      'postbackUrl' => 'https://www.testpostbackaddress.com'
   };

   $data = JSON::XS->new->utf8->encode ($data);

   my $url = 'https://flowdemo.pdcflow.com/api/v2_0/signatures';

   my $req = HTTP::Request->new( 'POST', $url );
   $req->authorization_basic( 'SomeSecretUsername', 'SomeSecretPassword' );
   $req->content_type('application/json');
   $req->content_length( length($data) );
   $req->content( $data );

   my $lwp = LWP::UserAgent->new;
   $lwp->timeout(30);
   my $response = $lwp->request( $req );

   if ( $response->is_success ) {
      print "Success: " . $response->decoded_content;
   }
   else {
      die $response->status_line . ": " . $response->decoded_content;
   }
};
if ( $@ ) {
   print "Error: $@\n";
}

#!/usr/bin/ruby

require 'curl'
require 'curb'
require 'json'
require 'base64'

begin
  paymentType = 'CARD'
  #paymentType = 'CHECK'

  payment = {
    'accountNumber' => 'YourAccountNumber',
    'paymentAmount' => '$125.00',
    'feeAmount' => '$5.00',
    'feePercentage' => '0',
    'accountDirective' => '0000',
    'editablePaymentAmount' => 'true',
    'minimumAmount' => '100.00'
  }

  if paymentType == 'CARD' then
    payment['paymentType'] = 'CC'
    payment['ccTransaction'] = {
      'creditCardExpirationMonth' => '09',
      'creditCardExpirationYear' => '2022',
      'creditCardToken' => 'CardTokenFromPDC'
    }
  elsif paymentType == 'CHECK' then
    payment['paymentType'] = 'ACH'
    payment['achTransaction'] = {
      'bankAccountNumber' => 'aBankToken123456',
      'bankAccountNumberLastFour' => '3456',
      'bankAccountType' => 'CHECKING',
      'bankRoutingNumber' => '124001545',
      'checkNumber' => '1'
    }
  end

  roundTripList = [
    'rtName'=>'personalIdNumber',
    'rtValue'=>'1234abcd'
  ]

  data = {
    'customMessage' => 'Thank you for buying!',
    'description' => 'Agreement for mortgage.',
    'emailAddress' => 'frontenduser@pdc4u.com',
    'firstName' => 'Adam',
    'lastName' => 'Test',
    'maxPinAttempts' => '2',
    'mobileNumber' => '7777777777',
    'pinDescription' => 'Last four of your social security number',
    'verificationPageHeader' => 'Text that will be displayed at the top of the verification page',
    'redirectLink' => 'https://www.pdcflow.com',
    'requestGeolocation' => 'true',
    'roundTripNVPS' => roundTripList,
    'payment' => payment,
    'companyOverride' => {
      'companyName' => 'Our Child Company'
    },
    'document' => {
      'documentId' => '1',
      'overlayId' => '' # Specify to include an overlay
    },
    'imageUpload' => {
      'imageUploadDescription' => 'Upload photo id',
      'imageUploadRequested' => 'true',
    },
    'standaloneSignatureRequested' => 'true',
    'templateName' => 'SignatureOnly',
    'timeoutMinutes' => '4.5',
    'transactionOrigin' => 'EXT',
    'username' => 'someuser@pdc4u.com',
    'verificationPin' => '1235',
    'customEmailBody' => 'We would like to capture authorization that you approve this message. Please click the following link to authorize our transaction.',
    'customEmailFooter' => 'This email has been brought to you by our Corporation.',
    'postbackUrl' => 'https://www.testpostbackaddress.com'
  }

  c = Curl::Easy.new
  c.url = 'https://flowdemo.pdcflow.com/api/v2_0/signatures'
  c.http_auth_types = :basic
  c.username = 'SomeSecretUsername'
  c.password = 'SomeSecretPassword'
  c.connect_timeout = 5
  c.timeout = 30
  c.verbose = true

  headers={}
  headers['Content-Type'] = 'application/json'
  headers['Content-Length'] = data.to_json.length
  payload = data.to_json

  c.headers = headers
  c.http_post(payload)

  puts JSON.parse c.body_str

  if c.response_code == 200 then
    puts "Success " + c.status
  else
    puts "Error " + c.status
  end
rescue
  puts "Caught: #$!\n"
end

<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "someSecretUsername:someSecretPassword");
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://flowdemo.pdc4u.com/api/v2_0/signatures/bulk',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "username": "someUserName",
    "description": "BULK FLOW Profound 3rd generation circuit",
    'postBackUrl' => 'https://www.example.com',
    'postBackAuthHeader' => 'BEARER abc123...',
    "defaultSignature": {
        "timeoutMinutes": 20,
        "verificationPin": "1234",
        "maxPinAttempts": "2",
        "pinDescription": "Pin Description",
        "description": "Demo Description",
        "flowTitle": "Flow Demo",
        "templateName": "DemoFlowTempate",
        "customMessage" => "Thank you for buying!",
        "verificationPageHeader" => "Text that will be displayed at the top of the verification page",
        "pageFooter": "Page footer",
        "standaloneSignatureRequested": false,
        "requestGeolocation": false,
        "companyOverride": {
            "companyName": "Jones - Hermann",
            "subject": "Bulk Requesting All Things",
            "emailFromName": "Omar Cartwright",
            "linkText": ">>>Click Here To Begin<<<"
        },
        "imageUpload": {
            "imageUploadRequested": true,
            "imageUploadDescription": "Please Upload Your Image!"
        },
        "componentList": [
            {
                "componentType": "BILLING_DATA",
                "data": {
                    "paymentTypeRequest": [
                        "CHECK",
                        "CARD"
                    ]
                }
            },
            {
                "componentType": "FILE_UPLOAD",
                "data": {
                    "fileUploadList": [
                        {
                            "fileType": "image",
                            "isRequired": "TRUE",
                            "description": "Polarised real-time framework"
                        },
                        {
                            "fileType": "PDF",
                            "isRequired": false,
                            "description": "Managed responsive budgetary management"
                        }
                    ]
                }
            }
        ],
        "roundTripNVPS": [
            {
                "rtName": "n1",
                "rtValue": "v1"
            },
            {
                "rtName": "employee",
                "rtValue": "employeeName"
            }
        ]
    },
    "signatureList": [
        {
            "firstName": "Clara",
            "lastName": "Maggio",
            "emailAddress": "emailaddress@my.com",
            "description": "This one has a payment",
            "mobileNumber": "",
            "roundTripNVPS": [
                {
                    "rtName": "Bulk Request #",
                    "rtValue": "1"
                }
            ]
        },
        {
            "firstName": "Natasha",
            "lastName": "Hessel",
            "emailAddress": "emailaddress2@my.com",
            "mobileNumber": "",
            "standaloneSignatureRequested": true,
            "requestGeolocation": true,
            "payment": {
                "paymentType": "ALL",
                "accountNumber": "97810345",
                "paymentAmount": "$401.78",
                "minimumAmount": "$0.02",
                "feeAmount": "$0.10",
                "editablePaymentAmount": true,
                "state": "UT",
                "zip": "84401",
                "ccTransaction": {
                    "accountDirective": "888-1",
                    "creditCardToken": "someCCToken",
                    "creditCardExpirationMonth": "01",
                    "creditCardExpirationYear": "2025"
                },
                "achTransaction": {
                    "accountDirective": "2071-1",
                    "bankAccountNumber": "89252076",
                    "bankRoutingNumber": "324377516",
                    "bankAccountType": "CHECKING",
                    "checkNumber": "919"
                }
            },
            "roundTripNVPS": [
                {
                    "rtName": "Bulk Request #",
                    "rtValue": "2"
                }
            ]
        }
    ]
}'
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

<?php

$data = [
    'overlayName' => MyOverlayName',
    'overlayBoxDefinitionList' => [
        [
            'boxTypeId' => 5,
            'startXPercent' => 5.798,
            'startYPercent' => 25.755,
            'documentPage' => 1,
            'boxProperties' => [
                'fontSize' => 24,
                'boxWidth' => 520.55,
                'boxHeight' => 120.44,
                'characterLimit' => 40,
                'description' => 'First Name',
                'prePopulateVariable' => 'firstName'
            ]
        ],
        [
            'boxTypeId' => 2,
            'startXPercent' => 71.336,
            'startYPercent' => 10.151,
            'documentPage' => 1
        ]
    ]
];

$url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays';

$curl = curl_init();

curl_setopt($curl, CURLOPT_POST, 1);
$data = json_encode($data, JSON_UNESCAPED_SLASHES);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
]);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, 'someSecretUsername:someSecretPassword');
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5);  //num seconds to try connecting
curl_setopt($curl, CURLOPT_TIMEOUT, 30); //max number of seconds to allow execution

$result = curl_exec($curl);

$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// View response
print_r(json_decode($result, true));

if($statusCode == '200') {
  echo $result;
}
else {
  echo "Error #:" . $statusCode;
}
curl_close($curl);

#!/usr/bin/perl

use LWP::UserAgent;
use HTTP::Request;
use HTTP::Request::Common;
use JSON::XS;
use IO::Socket::SSL qw(debug3); # verbose for troubleshooting

eval {  

   my $data = {
       'overlayName' => MyOverlayName',
       'overlayBoxDefinitionList' => [
           {
               'boxTypeId' => 5,
               'startXPercent' => 5.798,
               'startYPercent' => 25.755,
               'documentPage' => 1,
               'boxProperties' => {
                   'fontSize' => 24,
                   'boxWidth' => 520.55,
                   'boxHeight' => 120.44,
                   'characterLimit' => 40,
                   'description' => 'First Name',
                   'prePopulateVariable' => 'firstName'
               }
           },
           {
               'boxTypeId' => 2,
               'startXPercent' => 71.336,
               'startYPercent' => 10.151,
               'documentPage' => 1
           }
       ]
   };

   $data = JSON::XS->new->utf8->encode ($data);

   my $url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays';

   my $req = HTTP::Request->new( 'POST', $url );
   $req->authorization_basic( 'SomeSecretUsername', 'SomeSecretPassword' );
   $req->content_type('application/json');
   $req->content_length( length($data) );
   $req->content( $data );

   my $lwp = LWP::UserAgent->new;
   $lwp->timeout(30);
   my $response = $lwp->request( $req );

   if ( $response->is_success ) {
      print "Success: " . $response->decoded_content;
   }
   else {
      die $response->status_line . ": " . $response->decoded_content;
   }
};
if ( $@ ) {
   print "Error: $@\n";
}

#!/usr/bin/ruby

require 'curl'
require 'curb'
require 'json'
require 'base64'

begin

  data = {
    'overlayName' => MyOverlayName',
       'overlayBoxDefinitionList' => [
           {
               'boxTypeId' => 5,
               'startXPercent' => 5.798,
               'startYPercent' => 25.755,
               'documentPage' => 1,
               'boxProperties' => {
                   'fontSize' => 24,
                   'boxWidth' => 520.55,
                   'boxHeight' => 120.44,
                   'characterLimit' => 40,
                   'description' => 'First Name',
                   'prePopulateVariable' => 'firstName'
               }
           },
           {
               'boxTypeId' => 2,
               'startXPercent' => 71.336,
               'startYPercent' => 10.151,
               'documentPage' => 1
           }
       ]
   }

   c = Curl::Easy.new
   c.url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays'
   c.http_auth_types = :basic
   c.username = 'SomeSecretUsername'
   c.password = 'SomeSecretPassword'
   c.connect_timeout = 5
   c.timeout = 30
   c.verbose = true

   headers={}
   headers['Content-Type'] = 'application/json'
   headers['Content-Length'] = data.to_json.length
   payload = data.to_json

   c.headers = headers
   c.http_post(payload)

   puts JSON.parse c.body_str

   if c.response_code == 200 then
      puts "Success " + c.status
   else
      puts "Error " + c.status
   end
rescue
   puts "Caught: #$!\n"
end

<?php

$data = [
    'overlayName' => MyOverlayName',
    'overlayBoxDefinitionList' => [
        [
            'boxTypeId' => 5,
            'startXPercent' => 5.798,
            'startYPercent' => 25.755,
            'documentPage' => 1,
            'boxProperties' => [
                'fontSize' => 24,
                'boxWidth' => 520.55,
                'boxHeight' => 120.44,
                'characterLimit' => 40,
                'description' => 'First Name',
                'prePopulateVariable' => 'firstName'
            ]
        ],
        [
            'boxTypeId' => 2,
            'startXPercent' => 71.336,
            'startYPercent' => 10.151,
            'documentPage' => 1
        ]
    ]
];

&existingOverlayId = 1;

$url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays/' . existingOverlayId . '?command=EDIT';

$curl = curl_init();

curl_setopt($curl, CURLOPT_PUT, 1);
$data = json_encode($data, JSON_UNESCAPED_SLASHES);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
]);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, 'someSecretUsername:someSecretPassword');
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5);  //num seconds to try connecting
curl_setopt($curl, CURLOPT_TIMEOUT, 30); //max number of seconds to allow execution

$result = curl_exec($curl);

$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// View response
print_r(json_decode($result, true));

if($statusCode == '200') {
  echo $result;
}
else {
  echo "Error #:" . $statusCode;
}
curl_close($curl);

#!/usr/bin/perl

use LWP::UserAgent;
use HTTP::Request;
use HTTP::Request::Common;
use JSON::XS;
use IO::Socket::SSL qw(debug3); # verbose for troubleshooting

eval {  

   my $data = {
       'overlayName' => MyOverlayName',
       'overlayBoxDefinitionList' => [
           {
               'boxTypeId' => 5,
               'startXPercent' => 5.798,
               'startYPercent' => 25.755,
               'documentPage' => 1,
               'boxProperties' => {
                   'fontSize' => 24,
                   'boxWidth' => 520.55,
                   'boxHeight' => 120.44,
                   'characterLimit' => 40,
                   'description' => 'First Name',
                   'prePopulateVariable' => 'firstName'
               }
           },
           {
               'boxTypeId' => 2,
               'startXPercent' => 71.336,
               'startYPercent' => 10.151,
               'documentPage' => 1
           }
       ]
   };

   $data = JSON::XS->new->utf8->encode ($data);

   my $existingOverlayId = 1;

   my $url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays/' . existingOverlayId . '?command=EDIT';

   my $req = HTTP::Request->new( 'PUT', $url );
   $req->authorization_basic( 'SomeSecretUsername', 'SomeSecretPassword' );
   $req->content_type('application/json');
   $req->content_length( length($data) );
   $req->content( $data );

   my $lwp = LWP::UserAgent->new;
   $lwp->timeout(30);
   my $response = $lwp->request( $req );

   if ( $response->is_success ) {
      print "Success: " . $response->decoded_content;
   }
   else {
      die $response->status_line . ": " . $response->decoded_content;
   }
};
if ( $@ ) {
   print "Error: $@\n";
}

#!/usr/bin/ruby

require 'curl'
require 'curb'
require 'json'
require 'base64'

begin

  data = {
    'overlayName' => MyOverlayName',
       'overlayBoxDefinitionList' => [
           {
               'boxTypeId' => 5,
               'startXPercent' => 5.798,
               'startYPercent' => 25.755,
               'documentPage' => 1,
               'boxProperties' => {
                   'fontSize' => 24,
                   'boxWidth' => 520.55,
                   'boxHeight' => 120.44,
                   'characterLimit' => 40,
                   'description' => 'First Name',
                   'prePopulateVariable' => 'firstName'
               }
           },
           {
               'boxTypeId' => 2,
               'startXPercent' => 71.336,
               'startYPercent' => 10.151,
               'documentPage' => 1
           }
       ]
   }

   c = Curl::Easy.new
   existingOverlayId = 1
   c.url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays/' + existingOverlayId + '?command=EDIT'
   c.http_auth_types = :basic
   c.username = 'SomeSecretUsername'
   c.password = 'SomeSecretPassword'
   c.connect_timeout = 5
   c.timeout = 30
   c.verbose = true

   headers={}
   headers['Content-Type'] = 'application/json'
   headers['Content-Length'] = data.to_json.length
   payload = data.to_json

   c.headers = headers
   c.http_post(payload)

   puts JSON.parse c.body_str

   if c.response_code == 200 then
      puts "Success " + c.status
   else
      puts "Error " + c.status
   end
rescue
   puts "Caught: #$!\n"
end

<?php

&existingOverlayId = 1;

$url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays/' . existingOverlayId . '?command=DELETE';

$curl = curl_init();

curl_setopt($curl, CURLOPT_PUT, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Content-Length: 0'
]);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, 'someSecretUsername:someSecretPassword');
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5);  //num seconds to try connecting
curl_setopt($curl, CURLOPT_TIMEOUT, 30); //max number of seconds to allow execution

$result = curl_exec($curl);

$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// View response
print_r(json_decode($result, true));

if($statusCode == '200') {
  echo $result;
}
else {
  echo "Error #:" . $statusCode;
}
curl_close($curl);

#!/usr/bin/perl

use LWP::UserAgent;
use HTTP::Request;
use HTTP::Request::Common;
use JSON::XS;
use IO::Socket::SSL qw(debug3); # verbose for troubleshooting

eval {

   $data = JSON::XS->new->utf8->encode ($data);

   my $existingOverlayId = 1;
   my $url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays/' . existingOverlayId . '?command=DELETE';

   my $req = HTTP::Request->new( 'PUT', $url );
   $req->authorization_basic( 'SomeSecretUsername', 'SomeSecretPassword' );
   $req->content_type('application/json');
   $req->content_length(0);

   my $lwp = LWP::UserAgent->new;
   $lwp->timeout(30);
   my $response = $lwp->request( $req );

   if ( $response->is_success ) {
      print "Success: " . $response->decoded_content;
   }
   else {
      die $response->status_line . ": " . $response->decoded_content;
   }
};
if ( $@ ) {
   print "Error: $@\n";
}

#!/usr/bin/ruby

require 'curl'
require 'curb'
require 'json'
require 'base64'

begin

  c = Curl::Easy.new
  existingOverlayId = 1
  c.url = 'https://flowdemo.pdcflow.com/api/v2_0/overlays/' + existingOverlayId + '?command=DELETE'
  c.http_auth_types = :basic
  c.username = 'SomeSecretUsername'
  c.password = 'SomeSecretPassword'
  c.connect_timeout = 5
  c.timeout = 30
  c.verbose = true

  headers={}
  headers['Content-Type'] = 'application/json'
  headers['Content-Length'] = 0
  payload = data.to_json

  c.headers = headers
  c.http_put()

  puts JSON.parse c.body_str

  if c.response_code == 200 then
    puts "Success " + c.status
  else
    puts "Error " + c.status
  end
rescue
  puts "Caught: #$!\n"
end

<?php
   $roundTripList = [
      'rtName'=>'personalIdNumber',
      'rtValue'=>'1234abcd'
   ];

$portalPrePopulateVariables = [
    'firstName'  =>'firstName',
    'lastName'  =>'lastName',
    'emailAddress'  =>'my@my.com',
    'streetAddressOne'  =>'streetAddressOne',
    'streetAddressTwo'  =>'streetAddressTwo',
    'city'  =>'city',
    'country'  =>'US',
    'zip'  =>'84401',
    'state'  =>'UT',
    'zipPlusFour'  =>'1234',
    'phoneNumber'  =>'8017782224',
    'accountNumber'  =>'234134',
    'memo'  =>'memo',
    'paymentAmount'  =>'100.00',
    'roundTrip'  => $roundTripList
];

$componentData = [
    'portalUrl' => 'https://appdemo.pdcflow.com/1234',
    'portalPrePopulateVariables' => $portalPrePopulateVariables
];

$componentList = [
    'componentType' => 'PAYMENT_PORTAL',
    'data' => $componentData
];

$data = [
    'customMessage' => 'Thank you for buying!',
    'description' => 'Agreement for mortgage.',
    'emailAddress' => 'frontenduser@pdc4u.com',
    'firstName' => 'Adam',
    'lastName' => 'Test',
    'maxPinAttempts' => '2',
    'mobileNumber' => '7777777777',
    'pinDescription' => 'Last four of your social security number',
    'verificationPageHeader' => 'Text that will be displayed at the top of the verification page',
    'redirectLink' => 'https://www.pdcflow.com',
    'requestGeolocation' => 'true',
    'roundTripNVPS' => $roundTripList,
    'companyOverride' => [
        'companyName' => 'Our Child Company'
    ],
    'componentList' => [
        $componentList
    ],
    'document' => [
        'documentId' => '1',
        'overlayId' => '1',
        'prePopulateVariables' => [
            'firstName' => 'Adam'
        ]
    ],
    'imageUpload' => [
        'imageUploadDescription' => 'Upload photo id',
        'imageUploadRequested' => 'true',
    ],
    'standaloneSignatureRequested' => 'true',
    'templateName' => 'SignatureOnly',
    'timeoutMinutes' => '4.5',
    'transactionOrigin' => 'EXT',
    'username' => 'someuser@pdc4u.com',
    'verificationPin' => '1235',
    'postbackUrl' => 'https://www.testpostbackaddress.com'
];

$url = 'https://flowdemo.pdcflow.com/api/v2_0/signatures';

$curl = curl_init();

curl_setopt($curl, CURLOPT_POST, 1);
$data = json_encode($data, JSON_UNESCAPED_SLASHES);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
]);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, 'someSecretUsername:someSecretPassword');
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5);  //num seconds to try connecting
curl_setopt($curl, CURLOPT_TIMEOUT, 30); //max number of seconds to allow execution

$result = curl_exec($curl);

$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// View response
print_r(json_decode($result, true));

if($statusCode == '200') {
  echo $result;
}
else {
  echo "Error #:" . $statusCode;
}
curl_close($curl);

<?php
$fileUploadList = [
  [
    'fileType' => 'IMAGE',
    'isRequired' => true,
    'description' => 'Upload the Front Image'
  ],
  [
    'fileType' => 'IMAGE',
    'isRequired' => false,
    'description' => 'Upload the Back Image'
  ],
  [
    'fileType' => 'PDF',
    'isRequired' => true,
    'description' => 'Upload the PDF Contract'
  ],
  [
    'fileType' => 'FILE',
    'isRequired' => false,
    'description' => 'Upload the Image or PDF'
  ]
];

$componentList = [
  'componentType' => 'FILE_UPLOAD',
  'data' => [
    'fileUploadList' => $fileUploadList
  ]
];

$data = [
  'firstName' => 'Adam',
  'lastName' => 'Test',
  'maxPinAttempts' => '2',
  'mobileNumber' => '7777777777',
  'emailAddress' => 'frontenduser@pdc4u.com',
  'customMessage' => 'Thank you for buying!',
  'description' => 'Agreement for mortgage.',
  'verificationPin' => '1235',
  'pinDescription' => 'Last four of your social security number',
  'verificationPageHeader' => 'Text that will be displayed at the top of the verification page',
  'redirectLink' => 'https://www.pdcflow.com',
  'requestGeolocation' => 'true',
  'standaloneSignatureRequested' => 'true',
  'templateName' => 'SignatureOnly',
  'timeoutMinutes' => '5',
  'transactionOrigin' => 'EXT',
  'username' => 'someuser@pdc4u.com',
  'componentList' => [
    $componentList
  ]
];

$url = 'https://flowdemo.pdcflow.com/api/v2_0/signatures';

$curl = curl_init();

curl_setopt($curl, CURLOPT_POST, 1);
$data = json_encode($data, JSON_UNESCAPED_SLASHES);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'Content-Type: application/json',
  'Content-Length: ' . strlen($data)
]);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, 'someSecretUsername:someSecretPassword');
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5);  //num seconds to try connecting
curl_setopt($curl, CURLOPT_TIMEOUT, 30); //max number of seconds to allow execution

$result = curl_exec($curl);

$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// View response
print_r(json_decode($result, true));

if($statusCode == '200') {
  echo $result;
}
else {
  echo "Error #:" . $statusCode;
}
curl_close($curl);