Wednesday, September 09, 2026

Client - E-Signature
Action:
GET ENVELOPES
Method:
GET
URL: /api/v1/client/esignature/envelopes
Description: Fetch all e-signature envelopes associated with a Client Onboarding
Type Key DataType Notes
Headers api-key String Your Api-Key
Params OnboardingId Int32 Client Onboarding Identifier
Params ReturnFormat String Json or Xml (optional - defaults to Json)
Return Data: Json or XML collection of e-signature envelope records.
{
 "Envelopes": [
  {
   "Id": 1,
   "ClientId": 1,
   "OnboardingId": 300001,
   "EnvelopeId": "env-abc-123",
   "CreatedAt": "2020-12-31T12:34:56Z"
  }
 ]
}
Field Data Type
Envelopes Collection
 Id Int32
 ClientId Int16
 OnboardingId Int32
 EnvelopeId String
 CreatedAt DateTime
Action:
CREATE ENVELOPE
Method:
POST
URL: /api/v1/client/esignature/envelopes
Description: Create an e-signature envelope for a Client Onboarding and send it to the signer
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/json
Body OnboardingId Int32 Client Onboarding Identifier
Body SignerName String Full name of the signer
Body SignerEmail String Email address of the signer
Body TenantId String Tenant Identifier (must be a valid GUID)
Body Message String Optional message included with the signing request
Body Documents Collection One or more documents to be signed
Body  Name String Document name
Body  ContentBase64 String Base64 encoded document content
Body  FileExtension String File extension, e.g. pdf
Body  AnchorString String Optional signature anchor string within the document
Body ReturnFormat String Json or Xml (optional - defaults to Json)
Input Data: {
 "OnboardingId": 300001,
 "SignerName": "John Doe",
 "SignerEmail": "john@example.com",
 "TenantId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
 "Message": "Please sign",
 "Documents": [
  {
   "Name": "Terms",
   "ContentBase64": "JVBERi0xLjQK...",
   "FileExtension": "pdf",
   "AnchorString": "/sn1/"
  }
 ],
 "ReturnFormat": "json"
}
Return Data: Json or XML of the created e-signature envelope.
{
 "EnvelopeId": "env-abc-123",
 "CreatedAt": "2020-12-31T12:34:56Z"
}
Field Data Type
EnvelopeId String
CreatedAt DateTime
Action:
DELETE ENVELOPE
Method:
DELETE
URL: /api/v1/client/esignature/envelopes/{envelopeId}
Description: Delete an e-signature envelope
Type Key DataType Notes
Headers api-key String Your Api-Key
Params envelopeId String E-signature envelope identifier
Return Data:
200 OK
Action:
GET ENVELOPE STATUS
Method:
GET
URL: /api/v1/client/esignature/envelopes/{envelopeId}/status
Description: Fetch the current status of an e-signature envelope and its signers
Type Key DataType Notes
Headers api-key String Your Api-Key
Params envelopeId String E-signature envelope identifier
Params ReturnFormat String Json or Xml (optional - defaults to Json)
Return Data: Json or XML of the e-signature envelope status.
{
 "EnvelopeId": "env-abc-123",
 "Status": "completed",
 "StatusChangedAt": "2020-12-31T12:34:56Z",
 "Signers": [
  {
   "Name": "John Doe",
   "Email": "john@example.com",
   "Status": "completed",
   "SignedAt": "2020-12-31T12:34:56Z"
  }
 ]
}
Field Data Type
EnvelopeId String
Status String
StatusChangedAt DateTime (nullable)
Signers Collection
 Name String
 Email String
 Status String
 SignedAt DateTime (nullable)
Action:
GET DOCUMENT
Method:
GET
URL: /api/v1/client/esignature/envelopes/{envelopeId}/documents/{documentId}
Description: Download a signed document from an e-signature envelope as a PDF
Type Key DataType Notes
Headers api-key String Your Api-Key
Params envelopeId String E-signature envelope identifier
Params documentId String Document identifier within the envelope
Return Data: PDF file content (Content-Type: application/pdf).
Response is not cached (Cache-Control: no-store, no-cache, must-revalidate).
Field Data Type
PDF content Byte[]
Action:
GET CERTIFICATE
Method:
GET
URL: /api/v1/client/esignature/envelopes/{envelopeId}/certificate
Description: Download the signing certificate for an e-signature envelope as a PDF
Type Key DataType Notes
Headers api-key String Your Api-Key
Params envelopeId String E-signature envelope identifier
Return Data: PDF file content (Content-Type: application/pdf).
Response is not cached (Cache-Control: no-store, no-cache, must-revalidate).
Field Data Type
PDF content Byte[]
Action:
GET AUDIT TRAIL
Method:
GET
URL: /api/v1/client/esignature/envelopes/{envelopeId}/audit
Description: Fetch the audit trail for an e-signature envelope
Type Key DataType Notes
Headers api-key String Your Api-Key
Params envelopeId String E-signature envelope identifier
Params ReturnFormat String Json or Xml (optional - defaults to Json)
Return Data: Json or XML of the e-signature envelope audit trail.
{
 "Events": [
  {
   "Timestamp": "2020-12-31T12:34:56Z",
   "Action": "Signed",
   "UserName": "John Doe",
   "UserEmail": "john@example.com"
  }
 ]
}
Field Data Type
Events Collection
 Timestamp DateTime
 Action String
 UserName String
 UserEmail String