...
As response you get the draftId. For more information about drafts please have a look at: Draft Story
Get template configuration
With the following api call (https://demo.esignanywhere.net/api/v6/template/{templateId}/configuration you get the complete configuration of the template. Please see the next sample:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"MetaData": "string",
"AddDocumentTimestamp": true,
"ShareWithTeam": true,
"LockFormFieldsOnFinish": true,
"SendFinishedDocumentsToAllSignersAndMustView": true,
"Activities": [
{
"Id": "string",
"Action": {
"SendCopy": {
"RecipientConfiguration": {
"PersonalMessage": "string"
},
"CopyingGroup": 0
},
"Sign": {
"RecipientConfiguration": {
"PersonalMessage": "string",
"AuthenticationConfiguration": {
"AccessCode": {
"Code": "string"
},
"SmsOneTimePassword": {
"PhoneNumber": "string"
},
"SwedishBankId": {
"PersonalNumber": "string",
"AllowAnyPersonalNumber": true
},
"OAuthAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
],
"SamlAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
]
},
"SendEmails": true,
"AllowAccessAfterFinish": true,
"IncludedEmailAppLinks": {
"Android": true,
"iOS": true,
"Windows": true
},
"AllowDelegation": true,
"RequireViewContentBeforeFormFilling": true
},
"FinishActionConfiguration": {
"SignAnyWhereViewer": {
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForIos": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForAndroid": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForWindows": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"KioskSdk": {
"RedirectUri": "string"
}
},
"SignatureDataConfiguration": {
"DisposableCertificate": {
"DocumentIssuingCountry": "string",
"IdentificationIssuingCountry": "string",
"IdentificationType": "None",
"PhoneNumber": "string",
"DocumentType": "IdentityCard",
"DocumentIssuedBy": "string",
"DocumentIssuedOn": "2023-04-18",
"DocumentExpiryDate": "2023-04-18",
"SerialNumber": "string",
"DocumentNumber": "string"
},
"RemoteCertificate": {
"UserId": "string",
"DeviceId": "string"
},
"SwissComOnDemand": {
"PhoneNumber": "string",
"CommonName": "string",
"Country": "string",
"Locality": "string",
"OrganizationUnit": "string",
"Organization": "string",
"SerialNumber": "string",
"StateOrProvince": "string",
"Pseudonym": "string"
},
"SmsOneTimePassword": {
"PhoneNumber": "string"
},
"ATrustCertificate": {
"PhoneNumber": "string"
},
"SwedishBankId": {
"PersonalNumber": "string",
"AllowAnyPersonalNumber": true
},
"SignaturePluginData": [
{
"PluginId": "string",
"Fields": [
{
"Key": "string",
"Value": "string"
}
]
}
]
},
"BatchConfiguration": {
"Mode": "Basic",
"RequireScrollingOverAllSignaturesBeforeSigning": true
},
"SigningGroup": 0
},
"View": {
"RecipientConfiguration": {
"PersonalMessage": "string",
"AuthenticationConfiguration": {
"AccessCode": {
"Code": "string"
},
"SmsOneTimePassword": {
"PhoneNumber": "string"
},
"SwedishBankId": {
"PersonalNumber": "string",
"AllowAnyPersonalNumber": true
},
"OAuthAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
],
"SamlAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
]
},
"SendEmails": true,
"AllowAccessAfterFinish": true
},
"ViewingGroup": 0
},
"SignAsP7M": {
"RecipientConfiguration": {
"PersonalMessage": "string",
"AuthenticationConfiguration": {
"AccessCode": {
"Code": "string"
},
"SmsOneTimePassword": {
"PhoneNumber": "string"
},
"SwedishBankId": {
"PersonalNumber": "string",
"AllowAnyPersonalNumber": true
},
"OAuthAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
],
"SamlAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
]
},
"SendEmails": true,
"AllowAccessAfterFinish": true,
"IncludedEmailAppLinks": {
"Android": true,
"iOS": true,
"Windows": true
},
"AllowDelegation": true,
"RequireViewContentBeforeFormFilling": true
},
"SignatureMethods": {
"LocalCertificate": true,
"DisposableCertificate": {
"DocumentIssuingCountry": "string",
"IdentificationIssuingCountry": "string",
"IdentificationType": "None",
"PhoneNumber": "string",
"DocumentType": "IdentityCard",
"DocumentIssuedBy": "string",
"DocumentIssuedOn": "2023-04-18",
"DocumentExpiryDate": "2023-04-18",
"SerialNumber": "string",
"DocumentNumber": "string"
},
"RemoteCertificate": {
"UserId": "string",
"DeviceId": "string"
},
"SignaturePluginData": [
{
"PluginId": "string",
"Fields": [
{
"Key": "string",
"Value": "string"
}
]
}
]
},
"SignAsP7MGroup": 0
},
"SignBulk": {
"RecipientConfigurations": [
{
"RecipientConfiguration": {
"PersonalMessage": "string",
"AuthenticationConfiguration": {
"AccessCode": {
"Code": "string"
},
"SmsOneTimePassword": {
"PhoneNumber": "string"
},
"SwedishBankId": {
"PersonalNumber": "string",
"AllowAnyPersonalNumber": true
},
"OAuthAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
],
"SamlAuthentications": [
{
"ProviderName": "string",
"Validations": [
{
"FieldReferenceId": "string",
"ExpectedValue": "string"
}
]
}
]
},
"SendEmails": true,
"AllowAccessAfterFinish": true,
"IncludedEmailAppLinks": {
"Android": true,
"iOS": true,
"Windows": true
},
"AllowDelegation": true,
"RequireViewContentBeforeFormFilling": true
},
"SignatureDataConfiguration": {
"DisposableCertificate": {
"DocumentIssuingCountry": "string",
"IdentificationIssuingCountry": "string",
"IdentificationType": "None",
"PhoneNumber": "string",
"DocumentType": "IdentityCard",
"DocumentIssuedBy": "string",
"DocumentIssuedOn": "2023-04-18",
"DocumentExpiryDate": "2023-04-18",
"SerialNumber": "string",
"DocumentNumber": "string"
},
"RemoteCertificate": {
"UserId": "string",
"DeviceId": "string"
},
"SwissComOnDemand": {
"PhoneNumber": "string",
"CommonName": "string",
"Country": "string",
"Locality": "string",
"OrganizationUnit": "string",
"Organization": "string",
"SerialNumber": "string",
"StateOrProvince": "string",
"Pseudonym": "string"
},
"SmsOneTimePassword": {
"PhoneNumber": "string"
},
"ATrustCertificate": {
"PhoneNumber": "string"
},
"SwedishBankId": {
"PersonalNumber": "string",
"AllowAnyPersonalNumber": true
},
"SignaturePluginData": [
{
"PluginId": "string",
"Fields": [
{
"Key": "string",
"Value": "string"
}
]
}
]
}
}
],
"FinishActionConfiguration": {
"SignAnyWhereViewer": {
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForIos": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForAndroid": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForWindows": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"KioskSdk": {
"RedirectUri": "string"
}
},
"BatchConfiguration": {
"Mode": "Basic",
"RequireScrollingOverAllSignaturesBeforeSigning": true
}
}
},
"VisibilityOptions": [
{
"DocumentNumber": 0,
"IsHidden": true
}
]
}
],
"EmailConfiguration": {
"Subject": "string",
"Message": "string",
"SenderDisplayName": "string"
},
"ReminderConfiguration": {
"Enabled": true,
"FirstReminderInDays": 0,
"ReminderResendIntervalInDays": 0,
"BeforeExpirationInDays": 0
},
"ExpirationConfiguration": {
"ExpirationInSeconds": 0,
"ExpirationDate": "2023-04-18T08:26:01.208Z"
},
"CallbackConfiguration": {
"CallbackUrl": "string",
"StatusUpdateCallbackUrl": "string",
"AfterSendCallbackUrl": "string",
"ActivityActionCallbackConfiguration": {
"Url": "string",
"ActionCallbackSelection": {
"ConfirmTransactionCode": true,
"AgreementAccepted": true,
"AgreementRejected": true,
"PrepareAuthenticationSuccess": true,
"AuthenticationFailed": true,
"AuthenticationSuccess": true,
"AuditTrailRequested": true,
"AuditTrailXmlRequested": true,
"CalledPage": true,
"DocumentDownloaded": true,
"FlattenedDocumentDownloaded": true,
"AddedAnnotation": true,
"AddedAttachment": true,
"AppendedDocument": true,
"FormsFilled": true,
"ConfirmReading": true,
"SendTransactionCode": true,
"PrepareSignWorkstepDocument": true,
"SignWorkstepDocument": true,
"UndoAction": true,
"WorkstepCreated": true,
"WorkstepFinished": true,
"WorkstepRejected": true,
"DisablePolicyAndValidityChecks": true,
"EnablePolicyAndValidityChecks": true,
"AppendFileToWorkstep": true,
"AppendTasksToWorkstep": true,
"SetOptionalDocumentState": true,
"PreparePayloadForBatch": true
}
}
},
"AgreementConfiguration": {
"Translations": [
{
"LanguageCode": "AF",
"Text": "string",
"Header": "string",
"IsDefault": true
}
]
},
"AgentRedirectConfiguration": {
"Policy": "Workflow",
"Allow": true,
"IFrameAllowList": [
"string"
]
},
"RedirectConfiguration": {
"AfterSendRedirectUrl": "string",
"BeforeSendRedirectUrl": "string"
},
"DefaultSignatureTypeConfiguration": {
"ClickToSign": {
"IsDefault": true
},
"DrawToSign": {
"IsDefault": true
},
"TypeToSign": {
"IsDefault": true
},
"LocalCertificate": {
"IsDefault": true
},
"DisposableCertificate": {
"IsDefault": true
},
"Biometric": {
"IsDefault": true
},
"RemoteCertificate": {
"IsDefault": true
},
"OneTimePassword": {
"IsDefault": true
}
}
} |