> For the complete documentation index, see [llms.txt](https://docs.emsigner.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.emsigner.com/apis/api-reference/embedded-signing/embedded-signing-v1.md).

# Embedded Signing (v1)

## POST /api/Public/enc/InitiateEmbeddedSigning

> Initiate embedded signing (encrypted)

```json
{"openapi":"3.0.1","info":{"title":"emSigner Core API","version":"v1"},"tags":[{"name":"InitiateEmbeddedSigning"}],"servers":[{"url":"https://demoapi-core.emsigner.com","description":"Demo / Sandbox"},{"url":"{baseUrl}","description":"Custom environment","variables":{"baseUrl":{"default":"https://demoapi-core.emsigner.com","description":"Base URL of your emSigner environment (e.g. production or on-prem API host)"}}}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT access token from POST /auth/token. Paste the token without the \"Bearer \" prefix.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"emSignerCoreAPI.Shared.DTOs.EncryptedRequestDto":{"type":"object","properties":{"kid":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"data":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/Public/enc/InitiateEmbeddedSigning":{"post":{"tags":["InitiateEmbeddedSigning"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.EncryptedRequestDto"}}}},"responses":{"200":{"description":"OK"}},"summary":"Initiate embedded signing (encrypted)","operationId":"post_enc_InitiateEmbeddedSigning"}}}}
```

## POST /api/Public/InitiateEmbeddedSigning

> Initiate embedded signing

```json
{"openapi":"3.0.1","info":{"title":"emSigner Core API","version":"v1"},"tags":[{"name":"InitiateEmbeddedSigning"}],"servers":[{"url":"https://demoapi-core.emsigner.com","description":"Demo / Sandbox"},{"url":"{baseUrl}","description":"Custom environment","variables":{"baseUrl":{"default":"https://demoapi-core.emsigner.com","description":"Base URL of your emSigner environment (e.g. production or on-prem API host)"}}}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT access token from POST /auth/token. Paste the token without the \"Bearer \" prefix.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"emSignerCoreAPI.Shared.DTOs.EmbeddedSigningRequestDto":{"required":["emailId","name"],"type":"object","properties":{"clientID":{"maxLength":50,"minLength":0,"type":"string","nullable":true},"clientName":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"requestFrom":{"maxLength":50,"minLength":0,"type":"string","nullable":true},"workflowType":{"maximum":10,"minimum":1,"type":"integer","format":"int32"},"referenceNo":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"name":{"maxLength":150,"minLength":0,"type":"string"},"emailId":{"maxLength":200,"minLength":0,"type":"string","format":"email"},"state":{"maxLength":50,"minLength":0,"type":"string","nullable":true},"denomination":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"offlineStamps":{"$ref":"#/components/schemas/BulkeStamp"},"reminder":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"redirectURL":{"maxLength":500,"minLength":0,"type":"string","format":"uri","nullable":true},"envelopeExpiry":{"type":"string","nullable":true},"failoverProfileId":{"type":"string","nullable":true},"doNotNotifyCustomer":{"type":"boolean"},"donotSendCompletionMailToParticipants":{"type":"boolean"},"enableAutoClosePopup":{"type":"boolean"},"allowSignatoryCountOverride":{"type":"boolean"},"collectPaymentFromParticipant":{"type":"boolean"},"initiateNESLFlow":{"type":"boolean"},"invoice":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.InvoiceAddressDetails"},"eStampType":{"maxLength":20,"minLength":0,"type":"string","nullable":true},"estampAmount":{"pattern":"^\\d+(\\.\\d{1,2})?$","type":"string","nullable":true},"fetchEstampDeatilsUsingRefNo":{"type":"boolean"},"suppressEstampPage":{"type":"boolean"},"envelopeName":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"documentPassword":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"signatoryEmailIds":{"type":"array","items":{"type":"string"},"nullable":true},"signatureSettings":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.SignatureSettings"},"nullable":true},"lstDocumentDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.lstDocumentDetails"},"nullable":true},"templateList":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.TemplateDetails"},"nullable":true},"listAttachmentDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.AttachmentDetails"},"nullable":true},"eStampPayload":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.EstampPayload"},"shcilEstamp":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.ShcilEstampRequest"}},"additionalProperties":false},"BulkeStamp":{"type":"object","properties":{"state":{"type":"string","nullable":true},"denomination":{"type":"array","items":{"$ref":"#/components/schemas/OfflineStampItem"},"nullable":true}},"additionalProperties":false},"OfflineStampItem":{"type":"object","properties":{"denomination":{"type":"integer","format":"int32"},"referenceNo":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.InvoiceAddressDetails":{"type":"object","properties":{"address":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"pincode":{"type":"string","nullable":true},"stateCode":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.SignatureSettings":{"type":"object","properties":{"modeOfSignature":{"maxLength":20,"minLength":0,"type":"string","nullable":true},"modeOfAuthentication":{"maxLength":20,"minLength":0,"type":"string","nullable":true},"captureSelfie":{"type":"boolean"},"verifyDemographicData":{"type":"boolean"},"automatedsigningenabled":{"type":"boolean"},"verifyPhotoWithVideo":{"type":"boolean"},"name":{"maxLength":150,"minLength":0,"type":"string","nullable":true},"mobileNo":{"type":"string","format":"tel","nullable":true},"countryCode":{"maxLength":10,"minLength":0,"type":"string","nullable":true},"dob":{"type":"string","format":"date","nullable":true},"gender":{"pattern":"^(Male|Female|Other|M|F)$","type":"string","nullable":true},"identificationNumber":{"maxLength":50,"minLength":0,"type":"string","format":"email","nullable":true},"eSignAuthMode":{"maximum":5,"minimum":0,"type":"integer","format":"int32"},"location":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"reason":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"notificationEmail":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.lstDocumentDetails":{"type":"object","properties":{"documentName":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"pullFileDataFromURL":{"type":"boolean"},"fileData":{"pattern":"^[A-Za-z0-9+/=]*$","type":"string","nullable":true},"templateId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"controlDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.BulkPFConfigViewModel"},"nullable":true},"qrCodeCordinats":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.OnlineFlexiQRCoordinate"},"nullable":true},"mergeDocumentDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.MergeDocumentmentDetails"},"nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.BulkPFConfigViewModel":{"type":"object","properties":{"controlID":{"maximum":20,"minimum":0,"type":"integer","format":"int32"},"assignedTo":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"pageNo":{"maxLength":10,"minLength":0,"type":"string","nullable":true},"page":{"maxLength":20,"minLength":0,"type":"string","nullable":true},"left":{"maximum":2000,"minimum":0,"type":"integer","format":"int32"},"top":{"maximum":2000,"minimum":0,"type":"integer","format":"int32"},"height":{"maximum":2000,"minimum":0,"type":"integer","format":"int32"},"width":{"maximum":2000,"minimum":0,"type":"integer","format":"int32"},"fontType":{"maxLength":50,"minLength":0,"type":"string","nullable":true},"fontSize":{"maximum":72,"minimum":6,"type":"integer","format":"int32"},"placeHolder":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"validationType":{"maxLength":50,"minLength":0,"type":"string","nullable":true},"searchText":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"anchor":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"sigWidth":{"maximum":2000,"minimum":0,"type":"integer","format":"int32","nullable":true},"sigHeight":{"maximum":2000,"minimum":0,"type":"integer","format":"int32","nullable":true},"sigOffsetX":{"maximum":500,"minimum":-500,"type":"integer","format":"int32","nullable":true},"sigOffsetY":{"maximum":500,"minimum":-500,"type":"integer","format":"int32","nullable":true},"initialSearchText":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"initialAnchor":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"emateraiSearchtext":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"emateraiaAnchor":{"maxLength":200,"minLength":0,"type":"string","nullable":true},"signerType":{"maximum":5,"minimum":0,"type":"integer","format":"int32"},"controlValue":{"maxLength":500,"minLength":0,"type":"string","nullable":true},"fontColor":{"type":"string","nullable":true},"isMandatory":{"type":"integer","format":"int32","nullable":true},"fieldName":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"fieldType":{"maxLength":50,"minLength":0,"type":"string","nullable":true},"fieldValue":{"maxLength":500,"minLength":0,"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.OnlineFlexiQRCoordinate":{"type":"object","properties":{"left":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"pageNumber":{"type":"string","nullable":true},"selectedPage":{"type":"string","nullable":true},"top":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.MergeDocumentmentDetails":{"type":"object","properties":{"documentName":{"maxLength":150,"minLength":0,"type":"string","nullable":true},"fileData":{"type":"string","format":"multiline","nullable":true},"addSignaturePlaceholder":{"type":"boolean"},"parentDocumentId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"controlDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.BulkPFConfigViewModel"},"nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.TemplateDetails":{"type":"object","properties":{"templateId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"controlDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.FormData"},"nullable":true},"mergeDocumentDetails":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.MergeDocumentmentDetails"},"nullable":true},"fileData":{"pattern":"^[A-Za-z0-9+/=]*$","type":"string","nullable":true},"documentName":{"maxLength":200,"minLength":0,"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.FormData":{"type":"object","properties":{"tagName":{"maxLength":100,"minLength":0,"type":"string","nullable":true},"value":{"maxLength":500,"minLength":0,"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.AttachmentDetails":{"required":["description"],"type":"object","properties":{"documentName":{"maxLength":200,"minLength":0,"pattern":"^[^\\\\/:*?\"<>|]+(\\.[a-zA-Z0-9]{2,5})$","type":"string","nullable":true},"base64fileData":{"pattern":"^[A-Za-z0-9+/=]*$","type":"string","nullable":true},"description":{"maxLength":500,"minLength":0,"pattern":"^[a-zA-Z0-9 .,_-]+$","type":"string"},"documentPassword":{"maxLength":100,"minLength":0,"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.EstampPayload":{"type":"object","properties":{"loan":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.Loan"}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.Loan":{"type":"object","properties":{"txnID":{"type":"string","nullable":true},"loanno":{"type":"string","nullable":true},"snctnno":{"type":"string","nullable":true},"regType":{"type":"string","nullable":true},"signFlag":{"type":"string","nullable":true},"estampFlag":{"type":"string","nullable":true},"f2f":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"estampdtls":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.EstampDetail"},"nullable":true},"prtcptentty":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.Participant"},"nullable":true},"loandtls":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.Loandtls"},"eSignCordinates":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.ESignCoordinate"},"nullable":true},"documentdtls":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.DocumentDtl"},"nullable":true},"scrtydtls":{"type":"array","items":{"$ref":"#/components/schemas/eStamp.Scrtydtl"},"nullable":true},"entty_dtls":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.Enttydtls"}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.EstampDetail":{"type":"object","properties":{"firstparty":{"type":"string","nullable":true},"secondparty":{"type":"string","nullable":true},"stampDutyAmount":{"type":"string","nullable":true},"considerationPrice":{"type":"string","nullable":true},"descriptionofDocument":{"type":"string","nullable":true},"stampdutyPaidby":{"type":"string","nullable":true},"articleCode":{"type":"string","nullable":true},"documentID":{"type":"string","nullable":true},"firstPartyOVDType":{"type":"string","nullable":true},"firstPartyOVDValue":{"type":"string","nullable":true},"secondPartyOVDType":{"type":"string","nullable":true},"secondPartyOVDValue":{"type":"string","nullable":true},"firstPartyPin":{"type":"integer","format":"int32"},"secondPartyPin":{"type":"integer","format":"int32"}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.Participant":{"type":"object","properties":{"prtcptenttyId":{"type":"string","nullable":true},"fulnm":{"type":"string","nullable":true},"cntrprtycntnm":{"type":"string","nullable":true},"cntrprtyaddr":{"type":"string","nullable":true},"reltocntrct":{"type":"string","nullable":true},"emlid":{"type":"string","nullable":true},"cntrprtycntmobno":{"type":"string","nullable":true},"panno":{"type":"string","nullable":true},"ovdtype":{"type":"string","nullable":true},"ovdid":{"type":"string","nullable":true},"doi":{"type":"string","nullable":true},"lglcnstn":{"type":"string","nullable":true},"partytyp":{"type":"string","nullable":true},"seqno":{"type":"integer","format":"int32"}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.Loandtls":{"type":"object","properties":{"loanno":{"type":"string","nullable":true},"snctnno":{"type":"string","nullable":true},"dtofsnctn":{"type":"string","nullable":true},"emiamt":{"type":"string","nullable":true},"rtofint":{"type":"string","nullable":true},"snctnamt":{"type":"string","nullable":true},"tenure":{"type":"string","nullable":true},"ntrofcrdt":{"type":"string","nullable":true},"isacctclosed":{"type":"string","nullable":true},"fundtyp":{"type":"string","nullable":true},"currofsanc":{"type":"string","nullable":true},"crdtsubtyp":{"type":"string","nullable":true},"fcltynm":{"type":"string","nullable":true},"amtovrdue":{"type":"string","nullable":true},"chgamt":{"type":"string","nullable":true},"dtofdbrs":{"type":"string","nullable":true},"intamt":{"type":"string","nullable":true},"oldaccno":{"type":"string","nullable":true},"priamt":{"type":"string","nullable":true},"remarkparta":{"type":"string","nullable":true},"toutstndamt":{"type":"string","nullable":true},"bu":{"type":"string","nullable":true},"dp":{"type":"string","nullable":true},"loc":{"type":"string","nullable":true},"rpyfrq":{"type":"string","nullable":true},"lndngarrg":{"type":"string","nullable":true},"dpd":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.ESignCoordinate":{"type":"object","properties":{"prtcptenttyId":{"type":"integer","format":"int32"},"documentID":{"type":"integer","format":"int32"},"coordinates":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.DocumentDtl":{"type":"object","properties":{"documentID":{"type":"string","nullable":true},"docData":{"type":"string","nullable":true},"docRefNo":{"type":"string","nullable":true}},"additionalProperties":false},"eStamp.Scrtydtl":{"type":"object","properties":{"loanno":{"type":"string","nullable":true},"dscofscrty":{"type":"string","nullable":true},"asstyp":{"type":"string","nullable":true},"typofchrg":{"type":"string","nullable":true},"assetid":{"type":"string","nullable":true},"dtofcrtn":{"type":"string","nullable":true},"dtofvltn":{"type":"string","nullable":true},"scrtyidcersai":{"type":"string","nullable":true},"scrtyidroc":{"type":"string","nullable":true},"vlofscrty":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.Enttydtls":{"type":"object","properties":{"entty_pan":{"type":"string","nullable":true},"entty_name":{"type":"string","nullable":true},"lgl_cnstn":{"type":"string","nullable":true},"doi":{"type":"string","nullable":true},"eml_id":{"type":"string","nullable":true},"reg_addr":{"type":"string","nullable":true},"reg_pin":{"type":"string","nullable":true},"comm_addr":{"type":"string","nullable":true},"cntct_no":{"type":"string","nullable":true},"comm_pin":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.ShcilEstampRequest":{"type":"object","properties":{"state":{"type":"string","nullable":true},"considerationPrice":{"type":"number","format":"double"},"stampDuty":{"type":"number","format":"double","nullable":true},"templateId":{"type":"string","nullable":true},"propertyDescription":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.StampTemplateFieldValue"},"nullable":true},"participants":{"type":"array","items":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.ShcilParticipant"},"nullable":true},"articleCode":{"type":"string","nullable":true},"articleSubCode":{"type":"string","nullable":true},"stampDutyPaidBy":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.StampTemplateFieldValue":{"type":"object","properties":{"id":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"emSignerCoreAPI.Shared.DTOs.ShcilParticipant":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/Public/InitiateEmbeddedSigning":{"post":{"tags":["InitiateEmbeddedSigning"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/emSignerCoreAPI.Shared.DTOs.EmbeddedSigningRequestDto"}}}},"responses":{"200":{"description":"OK"}},"summary":"Initiate embedded signing","operationId":"post_InitiateEmbeddedSigning"}}}}
```