Conga Sign API Integration
Composer API can be used to integrate with Conga Sign's API to generate a document and then send it for e-signature using Conga Sign powered by OneSpan.
Using this method to pass a Composer generated document through Conga Sign API can only create one Conga Sign package per request.
Generating the Composer Merge Document
First, we use the Composer Document Generation API to generate the document. For more information regarding starting an API Solution, see Getting Started with Composer APIs.
Integrating Conga Sign powered by OneSpan
Apply the following details in the Composer Document Generation signCommands schema:
For the Provider, input "Conga Sign Powered by OneSpan." For the Payload, use any of the components listed in the Package Schema of the Conga Sign Package API below.
You must include an escape character (\) inside the JSON tag. Example:
"{\"tag\":\"value\"}"
Example 1:
"SignCommands": {
"Provider": "Conga Sign Powered by OneSpan",
"Payload": "{\"name\":\"Demo Quote E-Sign\",\"status\":\"DRAFT\"}
}Example 2:
"SignCommands": {
"Provider": "Conga Sign Powered by OneSpan",
"Payload": "{\"name\":\"Simple sign\",\"roles\":[{\"signers\":[{\"firstName\":\"Fake\",\"lastName\":\"Signer\",\"email\":\fsigner@conga.com\}],\"name\":\"Signer Name\",\"type\":\"SIGNER\",\"id\":\"SignerNameRoleId\"}],\"status\":\"DRAFT\",\"autocomplete\":true,\"documents\":[{\"name\":\"ComposerTemplate\",\"approvals\":[{\"fields\":[{\"value\":\"MyValue\",\"name\":\"MyField\",\"type\":\"SIGNATURE\",\"id\":\"MyId\",\"page\":0,\"left\":0,\"extract\":true,\"subtype\":\"FULLNAME\",\"width\":200,\"top\":0,\"height\":50}],\"role\":\"SignerNameRoleId\",\"optional\":false,\"enforceCaptureSignature\":true}]}]}"
}Conga Sign API
You can poll the status service with the correlation id from the merge request. Once completed, you will receive an envelope containing the status details and the package ID.
Conga Sign Templates
You can use a previously created Conga Sign merge template to have all merge fields prepopulated. Alternatively, you can define where the merge fields are placed in a blank document by placing the merge field values and their corresponding coordinate locations in your document in the payload section. For more information on creating templates, see Conga Sign Templates.
