---
title: "Authenticate user based on secretkey and appname"
method: POST
path: "/api/InitiateEmbeddedSigning"
tags: ["Workflows"]
---

# Authenticate user based on secretkey and appname

`POST /api/InitiateEmbeddedSigning`

## Headers

- `Authorization` string, required
- `UserName` string

## Request body

- EmsignerAPIBusinessObjectEmbeddedSigningViewModelEmbeddedSigningRequest
  - `ClientID` string
  - `ClientName` string
  - `RequestFrom` string, required — Request of origination
  - `WorkflowType` integer, required — 2-Serial Flexiform,5-In person
  - `ReferenceNo` string — Referenceno-unique identification number from the source system
  - `Name` string, required — Name of the originator
  - `EmailId` string, required — Email Id of the originator
  - `State` string
  - `Denomination` integer
  - `Reminder` string
  - `RedirectURL` string
  - `EnvelopeExpiry` integer
  - `DoNotNotifyCustomer` boolean
  - `DonotSendCompletionMailToParticipants` boolean
  - `EnableAutoClosePopup` boolean
  - `AllowSignatoryCountOverride` boolean
  - `CollectPaymentFromParticipant` boolean
  - `InitiateNESLFlow` boolean
  - `eStampType` string
  - `EstampAmount` string
  - `FetchEstampDeatilsUsingRefNo` boolean
  - `SuppressEstampPage` boolean
  - `SignatoryEmailIds` string[]
  - `FailoverProfileId` string
  - `EmailMessage` string
  - `SignatureSettings` EmsignerAPIBusinessObjectSignatureSettings[]
    - `ModeOfSignature` string
    - `ModeOfAuthentication` string
    - `CaptureSelfie` boolean
    - `VerifyDemographicData` boolean
    - `Automatedsigningenabled` boolean
    - `VerifyPhotoWithVideo` boolean
    - `Name` string
    - `MobileNo` string
    - `CountryCode` string
    - `DOB` string
    - `Gender` string
    - `NotificationEmail` string
    - `IdentificationNumber` string
    - `eSignAuthMode` integer
    - `Location` string
    - `Reason` string
  - `lstDocumentDetails` EmsignerAPIBusinessObjectValidateAPPViewModelDocumentDetails[], required — List of document details
    - `DocumentName` string, required — Name of the document
    - `PullFileDataFromURL` boolean
    - `FileData` string, required — FileData in base64 format
    - `TemplateId` integer
    - `ControlDetails` EmsignerAPIBusinessObjectValidateAPPViewModelBulkPFConfigViewModel[]
      - `ControlID` integer
      - `AssignedTo` integer
      - `PageNo` string
      - `Page` string
      - `Left` integer
      - `Top` integer
      - `Height` integer
      - `Width` integer
      - `FontType` string
      - `FontSize` integer
      - `PlaceHolder` string
      - `ValidationType` string
      - `SearchText` string
      - `Anchor` string
      - `InitialSearchText` string
      - `InitialAnchor` string
      - `EmateraiSearchtext` string
      - `EmateraiaAnchor` string
      - `SignerType` integer
      - `ControlValue` string
    - `QRCodeCordinats` BusinessObjectBusinessObjectOnlineFlexiQRCoordinate[]
      - `Left` integer
      - `Height` integer
      - `PageNumber` string
      - `SelectedPage` string
      - `Top` integer
      - `Width` integer
    - `MergeDocumentDetails` EmsignerAPIBusinessObjectMergeDocumentmentDetails[]
      - `DocumentName` string
      - `FileData` string
      - `AddSignaturePlaceholder` boolean
      - `ParentDocumentId` integer
  - `TemplateList` BusinessObjectBusinessObjectTemplateDetails[]
    - `TemplateId` integer
    - `ControlDetails` BusinessObjectBusinessObjectFormData[]
      - `TagName` string
      - `Value` string
    - `MergeDocumentDetails` EmsignerAPIBusinessObjectMergeDocumentmentDetails[]
      - `DocumentName` string
      - `FileData` string
      - `AddSignaturePlaceholder` boolean
      - `ParentDocumentId` integer
    - `FileData` string
    - `DocumentName` string
  - `listAttachmentDetails` BusinessObjectBusinessObjectAttachmentDetails[]
    - `DocumentName` string, required — Name of the attachment
    - `Base64fileData` string, required — Base64fileData of the PDF document
    - `Description` string — Comments
    - `DocumentPassword` string — DocumentPassword
  - `eStampPayload` BusinessObjectBusinessObjectEstampPayload
    - `loan` BusinessObjectBusinessObjectLoan
      - `loanno` string
      - `snctnno` string
      - `regType` string
      - `txnID` string
      - `signFlag` string
      - `estampFlag` string
      - `f2f` string
      - `state` string
      - `brname` string
      - `braddr` string
      - `estampdtls` BusinessObjectBusinessObjectEstampdtl[]
        - `firstparty` string
        - `secondparty` string
        - `stampDutyAmount` string
        - `considerationPrice` string
        - `descriptionofDocument` string
        - `stampdutyPaidby` string
        - `articleCode` string
        - `documentID` string
        - `firstPartyOVDType` string
        - `firstPartyOVDValue` string
        - `secondPartyOVDType` string
        - `secondPartyOVDValue` string
        - `firstPartyPin` integer
        - `secondPartyPin` integer
      - `prtcptentty` BusinessObjectBusinessObjectPrtcptentty[]
        - `prtcptenttyId` string
        - `fulnm` string
        - `cntrprtycntnm` string
        - `cntrprtyaddr` string
        - `reltocntrct` string
        - `emlid` string
        - `cntrprtycntmobno` string
        - `panno` string
        - `ovdtype` string
        - `ovdid` string
        - `doi` string
        - `lglcnstn` string
        - `partytyp` string
      - `loandtls` BusinessObjectBusinessObjectLoandtls
        - `loanno` string
        - `snctnno` string
        - `dtofsnctn` string
        - `emiamt` string
        - `rtofint` string
        - `snctnamt` string
        - `tenure` string
        - `ntrofcrdt` string
        - `isacctclosed` string
        - `fundtyp` string
        - `currofsanc` string
        - `crdtsubtyp` string
        - `fcltynm` string
        - `amtovrdue` string
      - `documentdtls` BusinessObjectBusinessObjectDocumentdtl[]
        - `documentID` string
        - `docData` string
        - `docRefNo` string
      - `scrtydtls` BusinessObjectBusinessObjectScrtydtl[]
        - `dscofscrty` string
        - `asstyp` string
        - `typofchrg` string
        - `assetid` string
      - `entty_dtls` BusinessObjectBusinessObjectEnttydtls
        - `entty_pan` string
        - `entty_name` string
        - `lgl_cnstn` string
        - `doi` string
        - `eml_id` string
        - `reg_addr` string
        - `reg_pin` string
        - `comm_addr` string
        - `cntct_no` string
        - `comm_pin` string
  - `OfflineStamps` EmsignerAPIBusinessObjectBulkeStamp
    - `State` string
    - `Denomination` integer[]

## Response `200`

OK

- EMDMSHelperReturnObjectBusinessObjectBusinessObjectInitiateAndSignWorkFlowResponse
  - `IsSuccess` boolean
  - `Messages` string[]
  - `ErrorCode` integer
  - `Response` BusinessObjectBusinessObjectInitiateAndSignWorkFlowResponse
    - `ReferenceNo` string
    - `DocumentNumberList` string[]
    - `DocumentIdList` integer[]
    - `Status` boolean
    - `WorkflowId` integer
    - `SignatoryDetails` EmsignerAPIBusinessObjectSignatoryInformation[]
      - `SequenceNumber` integer
      - `IdentificationNumber` string
      - `Name` string
      - `EmailId` string
      - `MobileNo` string
      - `URL` string
    - `URL` string
    - `ParallelSigningURLs` EmsignerAPIBusinessObjectParallelSigningURL[]
      - `SequenceNumber` integer
      - `IdentificationNumber` string
      - `Name` string
      - `EmailId` string
      - `MobileNo` string
      - `URL` string
    - `TransactionNumber` string
    - `RedirectURL` string
    - `ResponseCode` string
    - `TemplateId` integer

---

[API](https://skmtc.dev/emsigner/apis/emsignerapi.md) · [All operations](https://skmtc.dev/emsigner/apis/emsignerapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/emsigner/emsignerapi/revisions/7d5d55e0d91d/schema)