Creates a new EviSign for the authenticated site/user context.
Security
basicAuth
Body fields
LookupKey: Client-provided identifier used to look up a specific EviSign.Subject(required): Subject line used for the EviSign submission.Document(required): Base64-encoded binary content of the main document to be signed.SigningParties: List of signing parties required to sign the document.Name: Signing party display name.Address: Notification address used to deliver signature access.SigningMethod: Signature method required for this party.SignatureAppearances: Signature appearance descriptors (JSON format).SignatureQuestions: Additional questions shown during signing.Key: Question key identifier.Label: Question label shown to the signer.TypeName: Field type name for the question input.DefaultValue: Default value used when no explicit value is provided.Required: Indicates whether the question is mandatory.ValidationRegex: Validation regex applied to the question value.ValidationMessage: Validation message returned when regex validation fails.ToolTip: Tooltip text shown for the question.SelectListItems: Available options when TypeName is a select-list field.UseWikiText: Indicates whether Label should be rendered as wiki text.
PhoneNumber: Phone number used for SMS PIN signature.SignDelivery: Indicates whether delivery must be signed first.EmailAddress: Email address used for email PIN signature.SignatureChallenge: Challenge question used for Challenge signing.SignatureChallengeResponse: Challenge response used for Challenge signing.LegalName: Legal name of the signing party.AddressType: Address type of the signing party.DisableSignRequests: Indicates whether signature request notifications are disabled.RequiresCaptcha: Indicates whether captcha is required for this party.Language: Language used for this signing party.SigningOrder: Signing order position for this party.Role: Role assigned to this party.DisableFinalNotification: Indicates whether final notifications are disabled for this party.DisableStateNotifications: Indicates whether state change notifications are disabled for this party.Required: Indicates whether this party is required to sign.TimeToWait: Time to wait for this signer, in minutes.SignStep: Signature step used for commitment/signature flow.FinalNotificationAddress: Address used for final notifications.DeliverySubDomain: Delivery subdomain used for this party.DeliveryCustomUrl: Custom redirect URL used with DeliverySubDomain.DeliveryWebView: Delivery WebView target for this party.AllowVoicePinFallback: Indicates whether voice PIN fallback is allowed.DeliveryProfile: Delivery profile identifier for this party.SignerGeoLocationPolicy: Geolocation policy applied during delivery.EntityIdKind: Legal identifier type of the entity.EntityId: Legal identifier value of the entity.PersonIdKind: Legal identifier type of the signer.PersonId: Legal identifier value of the signer.DelegatedSignature: Delegated signature configuration.WhatsAppPinPolicy: WhatsApp PIN policy applied to delegated signature flows.
WhatsAppPinPolicy: WhatsApp PIN policy.SignatureRequestPolicy: Channel policy for signature request delivery attempts.SignatureRequestTemplate: Template name for signature request email notifications.SignatureRequestTemplateValues: Placeholder values used to render SignatureRequestTemplate.ProgressNotificationTemplate: Template name for progress email notifications.ProgressNotificationTemplateValues: Placeholder values used to render ProgressNotificationTemplate.FinalNotificationTemplate: Template name for final email notifications.FinalNotificationTemplateValues: Placeholder values used to render FinalNotificationTemplate.SignatureReminderTemplate: Template name for signature reminder email notifications.SignatureReminderTemplateValues: Placeholder values used to render SignatureReminderTemplate.LiteFlow: Indicates whether LiteFlow is enabled for this party.
InterestedParties: List of interested parties notified about the EviSign lifecycle.Address: Interested party email address.ProgressNotificationTemplate: Notification template identifier used for progress updates.ProgressNotificationTemplateValues: Placeholder values used to render ProgressNotificationTemplate.
Options: Optional settings that customize EviSign submission behavior.TimeToLive: Time to live in minutes for the EviSign lifecycle.SignatureRequestInfoText: Informational text shown in signature request notifications.LandingPageInfoText: Informational text shown on the signing landing page.FinalNotificationInfoText: Informational text shown in the final notification.SignedRedirectUrl: URL where signers are redirected after signing successfully.EvidenceAccessControlMethod: Access control method required to open evidence in custody.EvidenceAccessControlChallenge: Challenge question used when EvidenceAccessControlMethod is Challenge.EvidenceAccessControlChallengeResponse: Challenge answer used when EvidenceAccessControlMethod is Challenge.AttachToSignatureRequest: Indicates how attachments are included in signature request notifications.AttachToFinalNotification: Indicates how attachments are included in final notifications.AdditionalCommitments: Additional commitments shown during the signing process.CustomFields: Custom fields stored as additional metadata on the submitted EviSign.Key(required): Custom field key identifier.Label(required): Display label for the custom field.Value(required): Submitted value for the custom field.IsLookupKey: Indicates whether this field is used as lookup key.TypeName: Field type identifier used by dynamic form rendering.DefaultValue: Default value used when no explicit value is provided.Required: Indicates whether a value is required for this field.ValidationRegex: Validation regex applied to the field value.ValidationMessage: Validation message returned when regex validation fails.
NotaryRetentionPeriod: Notary retention period in years. Values greater than zero enable notary custody.NotaryProfile: Notary profile identifier. Required when NotaryRetentionPeriod is greater than zero.OnlineRetentionPeriod: Online retention period in years.CertificationLevel: Certification level applied to the submitted evidence.FinalRejectedNotificationInfoText: Informational text shown in rejection notifications.SignatureReminderInfoText: Informational text shown in signature reminder notifications.ExpiredNotificationInfoText: Informational text shown in expiration notifications.Language: UI/content language used for signer-facing pages and notifications.AffidavitLanguage: Language used for affidavit generation.SecurityTags: Security tags associated with the generated evidence.PushNotificationUrl: Callback URL that receives POST push notifications for message events.PushNotificationFilter: Push notification events to send to PushNotificationUrl.CostCentre: Cost center identifier associated with the submission.CommitmentOptions: Commitment behavior options used in signer interactions.CommitmentCommentsAllowed: Indicates whether commitment comments are allowed.InterestedPartiesNotifications: Interested-party notification event names to emit.GenerateSignedDocument: Indicates whether the signed document should be generated.Reminders: Reminder scheduling configuration.Initial: Initial delay before sending the first reminder.Repeat: Interval used to send repeated reminders.Days: Days of the week when reminders can be sent.TimeRange: Allowed daily time range for sending reminders.Max: Maximum number of reminders to send.Stop: Condition or limit that stops reminder delivery.TimeZone: Time zone used to evaluate reminder schedule settings.
PushNotificationExtraData: Extra payload included in each push notification callback.GenerateSignedDocumentOptions: Configuration used when GenerateSignedDocument is enabled.CertificationCertificate: Certificate identifier used to generate the signed document.
RequireRejectReason: Indicates whether signers must provide a reject reason when rejecting.RejectReasons: List of allowed reject reasons presented to signers.SummaryAffidavit: Summary affidavit generation settings.Masking: List of masking patterns applied to affidavit content.IncludeDocument: Indicates whether the main document is included.IncludeAttachments: Indicates whether attachments are included.IncludeEvents: Indicates whether events are included.IncludedCommitments: Commitment roles to include in the summary affidavit.
AffidavitKinds: Explicit affidavit kinds requested for this submission.DisablePlatformReferences: Indicates whether platform references should be hidden in generated artifacts.OwnerNotificationTemplate: Owner notification template identifier.OwnerNotificationTemplateValues: Placeholder values used to render OwnerNotificationTemplate.LtaStorage: Indicates whether long-term archive storage is requested.CustomLayoutLogoUrl: Custom logo URL used by the signature layout.
Attachments: Optional supporting attachments included with the EviSign submission.ContentId: Attachment content identifier.DisplayName: Attachment display name.Filename: Attachment file name.MimeType: Attachment MIME type.ContentDescription: Attachment content description.ContentDisposition: Attachment content disposition.ContentLocation: Attachment content location.ContentEncoding: Content encoding of the attachment payload.Data: Attachment binary content.Attributes: Attachment key-value attributes (for example, RequireContentCommitment=true).Key: Attribute key.Value: Attribute value.Values: Attribute values.
Issuer: Display name of the issuer shown to parties.From: Sender email address used for recipient-facing communications.DisableSenderHeader: Indicates whether the sender header should be omitted.ReplyTo: Reply-to email address for recipient responses.
Base64-encoded binary content of the main document to be signed.
List of signing parties required to sign the document.
List of interested parties notified about the EviSign lifecycle.
Optional supporting attachments included with the EviSign submission.
Controls whether the sender header is omitted. Omission sets false, overriding the site default.
Default:false
- Productionhttps://api.evicertia.com/v1/evisign/submit
- Pre-production / QAhttps://api.ecertia.com/v1/evisign/submit
curl -i -X POST \
-u '<username>:<password>' \
https://api.evicertia.com/v1/evisign/submit \
-H 'Content-Type: application/json' \
-H 'X-Evi-IdempotencyToken: string' \
-d '{
"LookupKey": "CONTRACT-001",
"Subject": "Contract for signature",
"Document": "JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAzMDAgMjAwXSAvQ29udGVudHMgNCAwIFIgL1Jlc291cmNlcyA8PCAvRm9udCA8PCAvRjEgNSAwIFIgPj4gPj4gPj4KZW5kb2JqCjQgMCBvYmoKPDwgL0xlbmd0aCA0OCA+PgpzdHJlYW0KQlQgL0YxIDEyIFRmIDMwIDEwMCBUZCAoRXhhbXBsZSBjb250cmFjdCkgVGogRVQKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjw8IC9UeXBlIC9Gb250IC9TdWJ0eXBlIC9UeXBlMSAvQmFzZUZvbnQgL0hlbHZldGljYSA+PgplbmRvYmoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAowMDAwMDAwMjQxIDAwMDAwIG4gCjAwMDAwMDAzMzggMDAwMDAgbiAKdHJhaWxlcgo8PCAvU2l6ZSA2IC9Sb290IDEgMCBSID4+CnN0YXJ0eHJlZgo0MDgKJSVFT0YK",
"SigningParties": [
{
"Name": "Alex Example",
"Address": "signer@example.com",
"AddressType": "Email",
"SigningMethod": "WebClick",
"Role": "Signer"
}
],
"Options": {
"TimeToLive": 1440,
"CommitmentOptions": "AcceptOrReject",
"PushNotificationUrl": "https://integrator.example.com/callbacks/evisign",
"PushNotificationFilter": [
"Processed",
"FullySigned",
"Closed",
"AffidavitPublished"
],
"AffidavitKinds": [
"Submitted",
"PartyCommitted",
"Main",
"OnDemand"
]
}
}'EviSign message accepted and persisted.
Response
{ "uniqueId": "string" }