Account


Earned badges

Achievement: Latest Unlocked

Topic Started

Topics
As the remote agent I want to programatically update a SENT package to DECLINED.
Executing a ./api/packages/ POST which includes a status update along with the "data" node. I cannot find the max length of this node.
I have an issue where I am adding 2 signers to a package that have the same name. They have unique IDs and different email addresses.
I have the following Approval being set for a 3 page document and the alignment is considerably off. What is the unit of measurement for the top/left/width/height values?

Replies Created

Reply to: update approvals

0 votes
{{uri}}/packages/{{packageId}}/documents/{{documentId}}/approvals
Performing a PUT multiple times to the above api is overwriting the first PUT. Can I perform multiple PUTs to add additional approvals to a document? Or do I have to PUT once with all my SIGNATUREs?
{
	"role": "Id1",
	"id": "Id1",
	"fields": [
		{
			"top": 145.999,
			"left": 150.60000000000002,
			"subtype": "FULLNAME",
			"width": 252,
			"page": 0,
			"type": "SIGNATURE",
			"height": 36
		}
	]
}
{
	"role": "Id2",
	"id": "Id2",
	"fields": [
		{
			"top": 45.999,
			"left": 93.60000000000001,
			"subtype": "FULLNAME",
			"width": 252,
			"page": 0,
			"type": "SIGNATURE",
			"height": 36
		}
	]
}

Reply to: update approvals

0 votes

I attempted the suggestion in this thread (https://community.onespan.com/forum/multiple-signature-fields-showing-one) but get an error response. My package has those roles (see info) so I'm not sure what else I am missing.

{
  "messageKey": "error.validation.validateApproval.noRolesOnApproval",
  "message": "No role specified as part of this approval.",
  "code": 400,
  "name": "Validation Error"
}

Request Body

{
  "approvals": [
    {
      "role": "Id1",
      "id":"Id1",
      "signed": null,
      "accepted": null,
      "data": null,
      "fields": [
        {
          "page": 2,
          "subtype": "FULLNAME",
          "width": 252,
          "binding": null,
          "extract": false,
          "extractAnchor": null,
          "left": 150.60000000000002,
          "top": 145.999,
          "validation": null,
          "height": 36,
          "data": null,
          "type": "SIGNATURE",
          "value": ""
        }
      ],
      "name": "Id1"
    },
    {
      "role": "Id2",
       "id":"Id2",
		"signed": null,
      "accepted": null,
      "data": null,
      "fields": [
        {
          "page": 3,
          "subtype": "FULLNAME",
          "width": 252,
          "binding": null,
          "extract": false,
          "extractAnchor": null,
          "left": 93.60000000000001,
          "top": 45.999,
          "validation": null,
          "height": 36,
          "data": null,
          "type": "SIGNATURE",
          "value": ""
        }
      ],
      "name": "Id2"
    }
  ]
}

Package Information

{
    "status": "DRAFT",
    "description": "Package Description",
    "language": "en",
    "roles": [
        {
            "id": "EUsOngubJCUB",
            "emailMessage": null,
            "locked": false,
            "reassign": false,
            "specialTypes": [],
            "attachmentRequirements": [],
            "data": null,
            "index": 0,
            "type": "SENDER",
            "signers": [{
                "group": null,
                "language": "en",
                "signature": null,
                "id": "K1TiGqYmrRE1",
                "delivery": {
                    "provider": false,
                    "download": true,
                    "email": true
                },
                "knowledgeBasedAuthentication": null,
                "auth": {
                    "scheme": "NONE",
                    "challenges": []
                },
                "title": null,
                "external": null,
                "updated": "2017-04-26T22:06:54Z",
                "userCustomFields": [],
                "company": "nCino",
                "email": "[email protected]",
                "firstName": "Rich",
                "lastName": "Bateman",
                "phone": "",
                "professionalIdentityFields": [],
                "data": null,
                "address": null,
                "created": "2017-04-26T22:06:54Z",
                "name": "",
                "specialTypes": []
            }],
            "name": "Owner"
        },
        {
            "id": "Id1",
            "emailMessage": null,
            "locked": false,
            "reassign": false,
            "specialTypes": [],
            "attachmentRequirements": [],
            "data": null,
            "index": 0,
            "type": "SIGNER",
            "signers": [{
                "group": null,
                "language": "en",
                "signature": null,
                "id": "c4a0a00a-ea07-49fa-b345-be5e25fb2adc",
                "delivery": {
                    "provider": false,
                    "download": false,
                    "email": false
                },
                "knowledgeBasedAuthentication": null,
                "auth": {
                    "scheme": "NONE",
                    "challenges": []
                },
                "title": "",
                "external": null,
                "updated": "2017-04-26T22:07:47Z",
                "userCustomFields": [],
                "company": "",
                "email": "[email protected]",
                "firstName": "Sam",
                "lastName": "Iam",
                "phone": "",
                "professionalIdentityFields": [],
                "data": null,
                "address": null,
                "created": "2017-04-26T22:07:47Z",
                "name": "",
                "specialTypes": []
            }],
            "name": "RoleName1"
        },
        {
            "id": "Id2",
            "emailMessage": null,
            "locked": false,
            "reassign": false,
            "specialTypes": [],
            "attachmentRequirements": [],
            "data": null,
            "index": 0,
            "type": "SIGNER",
            "signers": [{
                "group": null,
                "language": "en",
                "signature": null,
                "id": "0c228433-81e0-44b4-9b60-dce2a1283c5a",
                "delivery": {
                    "provider": false,
                    "download": false,
                    "email": false
                },
                "knowledgeBasedAuthentication": null,
                "auth": {
                    "scheme": "NONE",
                    "challenges": []
                },
                "title": "",
                "external": null,
                "updated": "2017-04-26T22:08:16Z",
                "userCustomFields": [],
                "company": "",
                "email": "[email protected]",
                "firstName": "Sam",
                "lastName": "Iam",
                "phone": "",
                "professionalIdentityFields": [],
                "data": null,
                "address": null,
                "created": "2017-04-26T22:08:16Z",
                "name": "",
                "specialTypes": []
            }],
            "name": "RoleName2"
        }
    ],
    "id": "Vaii8A_vSNBqR9uz76A2cxZhPds=",
    "visibility": "ACCOUNT",
    "completed": null,
    "autocomplete": true,
    "sender": {
        "status": "ACTIVE",
        "language": "en",
        "signature": null,
        "id": "K1TiGqYmrRE1",
        "account": {
            "id": "FDm1dI2SVxk0",
            "created": "2017-03-07T20:12:24Z",
            "updated": "2017-03-07T20:12:23Z",
            "company": {
                "id": "c1VpEjeuJHYR",
                "data": null,
                "address": {
                    "city": null,
                    "address1": null,
                    "address2": null,
                    "country": null,
                    "zipcode": null,
                    "state": null
                },
                "name": "nCino"
            },
            "customFields": [
                {
                    "required": false,
                    "id": "contentVersionId",
                    "translations": [{
                        "description": "",
                        "language": "en",
                        "id": "",
                        "data": null,
                        "name": "contentVersionId"
                    }],
                    "data": null,
                    "value": "",
                    "name": ""
                },
                {
                    "required": false,
                    "id": "externalTransactionId",
                    "translations": [{
                        "description": "",
                        "language": "en",
                        "id": "",
                        "data": null,
                        "name": "externalTransactionId"
                    }],
                    "data": null,
                    "value": "",
                    "name": ""
                }
            ],
            "licenses": [{
                "status": "ACTIVE",
                "transactions": [],
                "paidUntil": "2018-03-07T20:12:24Z",
                "plan": {
                    "group": "",
                    "description": "E-Sign Hundreds of Documents with Unlimited Signers",
                    "id": "sandbox",
                    "features": null,
                    "price": {
                        "amount": 0,
                        "currency": {
                            "id": "USD",
                            "data": null,
                            "name": "US Dollar"
                        }
                    },
                    "original": null,
                    "cycle": "YEAR",
                    "contract": "YEAR",
                    "freeCycles": null,
                    "quotas": [
                        {
                            "scope": "ACCOUNT",
                            "cycle": null,
                            "limit": 5,
                            "target": "SENDER"
                        },
                        {
                            "scope": "SENDER",
                            "cycle": null,
                            "limit": 500,
                            "target": "DOCUMENT"
                        },
                        {
                            "scope": "SENDER",
                            "cycle": null,
                            "limit": 500,
                            "target": "STORAGE"
                        }
                    ],
                    "data": null,
                    "name": "Sandbox"
                },
                "created": "2017-03-07T20:12:24Z"
            }],
            "logoUrl": "",
            "providers": null,
            "data": null,
            "owner": "K1TiGqYmrRE1",
            "name": "Rich Bateman"
        },
        "title": null,
        "external": null,
        "updated": "2017-03-07T20:12:23Z",
        "locked": null,
        "userCustomFields": [],
        "activated": null,
        "company": "nCino",
        "email": "[email protected]",
        "firstName": "Rich",
        "lastName": "Bateman",
        "memberships": [],
        "phone": "+1 512-843-0665",
        "professionalIdentityFields": [],
        "data": {
            "serviceCredentials": "{}",
            "showIntro": false
        },
        "address": null,
        "created": "2017-03-07T20:12:24Z",
        "type": "MANAGER",
        "name": "",
        "specialTypes": [],
        "hasDelegates": false
    },
    "documents": [
        {
            "status": "",
            "description": "Must be accepted and agreed to before starting the signing process.",
            "id": "default-consent",
            "signedHash": null,
            "approvals": [],
            "pages": [
                {
                    "id": "",
                    "height": 1030,
                    "width": 796,
                    "left": 0,
                    "top": 0,
                    "version": 0,
                    "index": 0
                },
                {
                    "id": "",
                    "height": 1030,
                    "width": 796,
                    "left": 0,
                    "top": 0,
                    "version": 0,
                    "index": 1
                }
            ],
            "external": null,
            "extract": false,
            "data": null,
            "index": 0,
            "fields": [],
            "name": "Electronic Disclosures and Signatures Consent",
            "size": 0
        },
        {
            "status": "",
            "description": "Example Description",
            "id": "Document1",
            "signedHash": null,
            "approvals": [],
            "pages": [
                {
                    "id": "",
                    "height": 1030,
                    "width": 796,
                    "left": 0,
                    "top": 0,
                    "version": 0,
                    "index": 0
                },
                {
                    "id": "",
                    "height": 1030,
                    "width": 796,
                    "left": 0,
                    "top": 0,
                    "version": 0,
                    "index": 1
                },
                {
                    "id": "",
                    "height": 1030,
                    "width": 796,
                    "left": 0,
                    "top": 0,
                    "version": 0,
                    "index": 2
                }
            ],
            "external": null,
            "extract": false,
            "data": null,
            "index": 1,
            "fields": [],
            "name": "Example Document",
            "size": 31004
        }
    ],
    "consent": "default-consent",
    "due": null,
    "emailMessage": "[email protected]",
    "limits": null,
    "notarized": false,
    "notaryRoleId": null,
    "settings": {"ceremony": {
        "layout": {
            "header": {
                "feedback": true,
                "breadcrumbs": true,
                "globalActions": {
                    "confirm": true,
                    "download": true,
                    "hideEvidenceSummary": false,
                    "saveAsLayout": true
                },
                "globalNavigation": true,
                "sessionBar": true,
                "titleBar": {
                    "title": true,
                    "progressBar": true
                }
            },
            "footer": null,
            "brandingBar": null,
            "iframe": false,
            "navigator": true
        },
        "events": {"complete": {
            "dialog": true,
            "redirect": null
        }},
        "enforceCaptureSignature": false,
        "declineButton": true,
        "declineReasons": [],
        "disableDeclineOther": false,
        "disableDownloadForUncompletedPackage": false,
        "disableFirstInPersonAffidavit": false,
        "disableInPersonAffidavit": false,
        "disableOptOutOther": false,
        "disableSecondInPersonAffidavit": false,
        "documentToolbarOptions": null,
        "handOver": null,
        "hideCaptureText": false,
        "hideLanguageDropdown": false,
        "hidePackageOwnerInPerson": false,
        "hideWatermark": false,
        "maxAuthFailsAllowed": 3,
        "optOutButton": true,
        "optOutReasons": [],
        "style": null,
        "inPerson": false
    }},
    "signedDocumentDelivery": null,
    "trashed": false,
    "updated": "2017-04-26T22:08:16Z",
    "data": {
        "First Name": "Bill",
        "Last Name": "Johnson",
        "Signing Order": "1",
        "origin": "api",
        "currentSignerProgress": {
            "documentsToConfirmCount": "0",
            "documentsConfirmedCount": "0",
            "approvalsToConfirmCount": "0",
            "approvalsConfirmedCount": "0",
            "documentsPartiallyCompletedCount": "0",
            "approvalsToSignNowCount": "0"
        },
        "overallProgress": {
            "documentsToCompleteCount": "2",
            "documentsCompletedCount": "2",
            "documentsToConfirmCount": "0",
            "documentsConfirmedCount": "0",
            "documentsPartiallyCompletedCount": "0"
        }
    },
    "messages": [],
    "type": "PACKAGE",
    "name": "Package for Test",
    "bulkSendable": false
}

Reply to: Add a New Document to an Existing Package

0 votes
Reference: https://developer.esignlive.com/guides/feature-guides/signatures/ I'm starting top down from your post (noob). I can create package and add document just fine. On to Signatures and this is what I'm getting for response - POST url: https://sandbox.esignlive.com/api/packages/8sZBIINEducdbChajGu4g-vgIPM=/documents/ce105de465c75bf598a3d4ba68080117b9d271a4ae139256/approvals Payload:
{
    "role": "Signer1",
    "id": "signature1",
    "fields": [{
        "top": 510,
        "left": 215,
        "width": 200,
        "height": 50,
        "page": 0,
        "type": "SIGNATURE",
        "subtype": "FULLNAME"
    }]
}
Response:
{
  "messageKey": "error.validation.validateApproval.noRolesOnApproval",
  "message": "No role specified as part of this approval.",
  "code": 400,
  "name": "Validation Error"
}

Subscriptions

Topics Replies Freshness Views Users
As the remote agent I want to programatically update a SENT package to DECLINED.
3 5 years 7 months ago 79
Profile picture for user Duo_Liang
Profile picture for user tatternutz
Executing a ./api/packages/ POST which includes a status update along with the "data" node. I cannot find the max length of this node.
1 5 years 8 months ago 21
Profile picture for user Duo_Liang
I have an issue where I am adding 2 signers to a package that have the same name. They have unique IDs and different email addresses.
1 5 years 9 months ago 51
Profile picture for user Duo_Liang
Can you please point me or give me example of json needs to be added to add signing date in a document (Using REST API)
13 3 years 2 months ago 675
Profile picture for user Duo_Liang
Profile picture for user tatternutz
I have the following Approval being set for a 3 page document and the alignment is considerably off. What is the unit of measurement for the top/left/width/height values?
13 7 years 1 month ago 36
Profile picture for user tatternutz
Profile picture for user mwilliams

Code Share

This user has not submitted any code shares.

Subscriptions Release Notes

This user is not subscribed to any release notes.