Last updated on
Apr 27, 2021
Environment
Adobe Sign REST API Swagger App
https://secure.echosign.com/public/docs/restapi/v5
Steps
Use POST /agreements to create an agreement. Sends it out for signatures, and returns the agreementID in the response to the client. Below is the JSON format to send agreement using Phone authentication method.
{
"documentCreationInfo": {
"mergeFieldInfo": null,
"recipientSetInfos": [{
"signingOrder": null,
"recipientSetRole": "SIGNER",
"recipientSetMemberInfos": [{
"securityOptions": null,
"email": "Signer@email.com"
}],
"privateMessage": null,
"securityOptions": [{
"authenticationMethod": "PHONE",
"phoneInfos": [{
"phone": "1111111111",
"countryCode": "+1"
}]
}]
}],
"signatureType": "ESIGN",
"callbackInfo": null,
"message": "Please review and sign this document.",
"locale": "en_US",
"vaultingInfo": null,
"securityOptions": null,
"reminderFrequency": null,
"ccs": null,
"postSignOptions": null,
"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",
"daysUntilSigningDeadline": null,
"formFieldLayerTemplates": [],
"name": "Adobe Sign Agreement-Phone authentication testing",
"formFields": null,
"fileInfos": [{
"libraryDocumentName": null,
"transientDocumentId": "3AAABLblqZhDZuoYYYYYYYYYYYYXXXXXXXXXhBCmYOBGwrjCnsrQWjJbeWSSSSSSSSSCNbcK3OOOOOON1onGS2yrruLzl4i_Q3bf0xHimDw_XXXXXXXXXmPLoST0R3GmN2RYxTRXYGJ6dMTnBQ*",
"documentURL": null,
"libraryDocumentId": null
}]
},
"options": {
"autoLoginUser": true,
"authoringRequested": false,
"noChrome": true,
"sendThroughWeb": null,
"sendThroughWebOptions": null,
"locale": "en_US"
}
}
Additional information
authenticationMethod (string) = ['NONE' or 'INHERITED_FROM_DOCUMENT' or 'PASSWORD' or 'WEB_IDENTITY' or 'KBA' or 'PHONE' or 'ADOBE_SIGN']: The authentication method for the recipients to have access to view and sign the document,
Click here for more information on Signer Authentication methods.
