Home/API Docs/Notarization Sessions

Target:https://eznotary.in/api/v1

API Module

Notarization Sessions

Manage end-to-end online notarization sessions including scheduling, instant sessions, document uploads, and notary audit logs.

13 Endpoints

API Key Authentication

Prefix:/sessions

Jump directly to endpoint:

POSTCreate Notarization Session GETList Sessions GETGet Session Details POSTCancel Session POSTUpload / Update Session Documents GETList Session Documents GETDownload Notarized Document GETGet Document Types GETGet Notary Available Slots GETGet Reschedule Slots for Session PATCHReschedule Session GETGet Session Audit Trail GETDownload Audit Trail Report PDF

POST/sessions

API Key Requiredmultipart/form-data

Create Notarization Session

Initiates an online notarization session. You can upload an initial PDF document using multipart/form-data or configure signatories. Supports both scheduled sessions and on-demand instant sessions. Deducts session credits from your wallet.

URL:https://eznotary.in/api/v1/sessions

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Request Body Parameters

Format: multipart/form-data

Field	Type	Required	Description
name	string	Required	Descriptive title or name of the notarization session. Example: `Employment Contract Notarization - Acme Corp`
documentType	enum	Required	Category of document being notarized. Example: `Affidavit` Allowed:AffidavitAgreementPower of AttorneyDeclarationPetitionPropertyNOCTranscriptEmploymentMiscellaneousOther
date	string	Required	Scheduled date of session in YYYY-MM-DD format. Example: `2026-11-15`
startTime	string	Required	Session start time in 24-hour HH:mm format. Example: `14:30`
endTime	string	Required	Session end time in 24-hour HH:mm format. Example: `15:00`
partiesInvolved	enum	Required	Type of signing parties involved in this session. Example: `individual` Allowed:individualmultiple-parties
numberOfParties	number	Optional	Number of parties attending (max 5). Defaults to 1. Example: `2`
externalReference	string	Optional	Your internal tracking identifier or loan/application reference ID. Example: `APP-LN-2026-88912`
document	file (binary)	Optional	PDF document file to be notarized. Maximum 25MB. Example: `contract.pdf`
isInstantSession	boolean	Optional	Set to true for on-demand notarization without scheduling. Example: `false`
signatories	array of objects (JSON string in form-data)	Optional	List of participants / signatories with their details.
↳fullName	string	Optional	Full legal name as per government ID. Example: `Rajesh Sharma`
↳email	string	Required	Signatory email address for invites & status notifications. Example: `rajesh.sharma@example.com`
↳phone	string	Required	Signatory 10-digit mobile number. Example: `9876543210`
↳countryCode	string	Optional	Country calling code without plus symbol. Defaults to 91. Example: `91`
↳role	enum	Optional	Role of participant. Example: `signer` Allowed:customerco_applicantwitnessobserversigneruser
↳externalUserId	string	Optional	Your internal user identifier for this signatory. Example: `USR-88219`

cURL — Create Notarization Session

curl -X POST "https://eznotary.in/api/v1/sessions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -F "document=@/path/to/contract.pdf" \
  -F "name=Affidavit of Residence - Rajesh Sharma" \
  -F "documentType=Affidavit" \
  -F "date=2026-11-15" \
  -F "startTime=14:30" \
  -F "endTime=15:00" \
  -F "partiesInvolved=individual" \
  -F "externalReference=APP-LN-2026-88912" \
  -F 'signatories=[{"fullName":"Rajesh Sharma","email":"rajesh.sharma@example.com","phone":"9876543210","countryCode":"91","role":"signer","externalUserId":"USR-88219"}]'

GET/sessions

API Key Required

List Sessions

Retrieves a paginated list of sessions. Filter by status (pending, completed, rejected, cancelled_by_user), date range, upcoming flag, or keyword search across reference IDs and client names.

URL:https://eznotary.in/api/v1/sessions

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Query Parameters

Parameter	Type	Required	Description	Example
page	number	Optional	Page number for pagination.	1
limit	number	Optional	Number of sessions to return per page (max 100).	20
status	string	Optional	Filter by session status: pending, completed, rejected, cancelled_by_user, on-hold.	pending
from	string	Optional	Start date filter in YYYY-MM-DD format.	2026-11-01
to	string	Optional	End date filter in YYYY-MM-DD format.	2026-11-30
search	string	Optional	Search string matched against external reference, participant name, or refId.	APP-LN-2026
upcoming	boolean	Optional	If true, returns only upcoming sessions ordered chronologically.	true

cURL — List Sessions

curl -X GET "https://eznotary.in/api/v1/sessions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

GET/sessions/:id

API Key Required

Get Session Details

Fetches the complete session record, including assigned notary info, participant statuses, document attachments, audit timestamps, and join links. Accepts either internal UUID or friendly reference ID (e.g. SES-2611-8934).

URL:https://eznotary.in/api/v1/sessions/:id

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID (e.g. SES-2611-8934).	SES-2611-8934

cURL — Get Session Details

curl -X GET "https://eznotary.in/api/v1/sessions/:id" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

POST/sessions/:id/cancel

API Key Required

Cancel Session

Cancels an active or pending notarization session. Notifies participants and frees up the notary slot. Credits may be refunded to your tenant wallet based on cancellation policy timing.

URL:https://eznotary.in/api/v1/sessions/:id/cancel

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

cURL — Cancel Session

curl -X POST "https://eznotary.in/api/v1/sessions/:id/cancel" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

POST/sessions/:id/documents

API Key Requiredmultipart/form-data

Upload / Update Session Documents

Uploads new document(s) for the session via multipart/form-data. Archives previously active documents and sets the newly uploaded file as the primary document for notary review and stamping.

URL:https://eznotary.in/api/v1/sessions/:id/documents

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

Request Body Parameters

Format: multipart/form-data

Field	Type	Required	Description
documents	array of files (binary)	Required	PDF files to attach to this session. Allowed format: .pdf, max 25MB each. Example: `final_deed.pdf`

cURL — Upload / Update Session Documents

curl -X POST "https://eznotary.in/api/v1/sessions/:id/documents" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -F "documents=@/path/to/final_deed.pdf"

GET/sessions/:id/documents

API Key Required

List Session Documents

Retrieves all document records associated with the session, including archived versions and notarized outputs.

URL:https://eznotary.in/api/v1/sessions/:id/documents

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

cURL — List Session Documents

curl -X GET "https://eznotary.in/api/v1/sessions/:id/documents" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

GET/sessions/:id/documents/download-notarized

API Key Required

Download Notarized Document

Returns temporary pre-signed download URL or redirects to the finalized PDF containing digital notary signatures, verifiable cryptographic QR code, and audit trail stamp.

URL:https://eznotary.in/api/v1/sessions/:id/documents/download-notarized

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

cURL — Download Notarized Document

curl -X GET "https://eznotary.in/api/v1/sessions/:id/documents/download-notarized" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

GET/sessions/document-types

API Key Required

Get Document Types

Fetches the list of active and supported document types for creating notarization sessions. Also accessible via /document-types.

URL:https://eznotary.in/api/v1/sessions/document-types

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Query Parameters

Parameter	Type	Required	Description	Example
search	string	Optional	Optional search keyword to filter document types by name.	Affidavit

cURL — Get Document Types

curl -X GET "https://eznotary.in/api/v1/sessions/document-types" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

GET/sessions/notary/available-time

API Key Required

Get Notary Available Slots

Returns all open calendar slots for the assigned notary network on the specified date.

URL:https://eznotary.in/api/v1/sessions/notary/available-time

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Query Parameters

Parameter	Type	Required	Description	Example
date	string	Required	Date to query in YYYY-MM-DD format.	2026-11-16

cURL — Get Notary Available Slots

curl -X GET "https://eznotary.in/api/v1/sessions/notary/available-time" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

GET/sessions/:id/available-slots

API Key Required

Get Reschedule Slots for Session

Fetches open time slots matching the specific assigned notary and requirements of an existing session.

URL:https://eznotary.in/api/v1/sessions/:id/available-slots

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

Query Parameters

Parameter	Type	Required	Description	Example
date	string	Required	Date to fetch available slots for in YYYY-MM-DD format.	2026-11-18

cURL — Get Reschedule Slots for Session

curl -X GET "https://eznotary.in/api/v1/sessions/:id/available-slots" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

PATCH/sessions/:id/reschedule

API Key Requiredapplication/json

Reschedule Session

Updates the scheduled date and time window. Sends updated calendar invitations and notifications to all participants. Emits session.rescheduled webhook.

URL:https://eznotary.in/api/v1/sessions/:id/reschedule

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

Request Body Parameters

Format: application/json

Field	Type	Required	Description
date	string	Required	New date in YYYY-MM-DD format. Example: `2026-11-18`
startTime	string	Required	New start time in 24-hour HH:mm format. Example: `15:00`
endTime	string	Required	New end time in 24-hour HH:mm format. Example: `15:30`
reason	string	Optional	Optional reason for rescheduling recorded in audit trail. Example: `Client requested postponement due to travel.`

cURL — Reschedule Session

curl -X PATCH "https://eznotary.in/api/v1/sessions/:id/reschedule" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "date": "2026-11-18",
  "startTime": "15:00",
  "endTime": "15:30",
  "reason": "Client requested postponement due to travel."
}'

GET/sessions/:id/audit

API Key Required

Get Session Audit Trail

Provides complete chronological logs of all events: session creation, document upload, participant join/leave, KYC checks, notary sealing, and IP metadata compliant with Information Technology Act, 2000.

URL:https://eznotary.in/api/v1/sessions/:id/audit

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

cURL — Get Session Audit Trail

curl -X GET "https://eznotary.in/api/v1/sessions/:id/audit" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

GET/sessions/:id/audit/download

API Key Required

Download Audit Trail Report PDF

Generates a pre-signed download URL for the official, tamper-evident Audit Trail Report & Compliance Certificate PDF containing complete chronological chain of custody, participant verification details, and cryptographic SHA-256 hashes.

URL:https://eznotary.in/api/v1/sessions/:id/audit/download

Request Parameters

Headers

Header	Type	Required	Description
x-api-key	string	Required	Tenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secret	string	Required	Tenant API Secret key paired with your API key.

Path Parameters

Parameter	Type	Description	Example
id	string	Session UUID or Ref ID.	SES-2611-8934

cURL — Download Audit Trail Report PDF

curl -X GET "https://eznotary.in/api/v1/sessions/:id/audit/download" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"

PreviousAuthentication

Next ModuleParticipants & Signatories