Home/API Docs/Participants & Signatories

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

API Module

Participants & Signatories

Manage signatories, witnesses, observers, and co-applicants participating in a notarization session. Generate and refresh secure video call tokens.

4 Endpoints

API Key Authentication

Prefix:/sessions

Jump directly to endpoint:

POSTAdd Participant to Session GETList Session Participants GETGet Participant Details POSTRegenerate Participant Token

POST/sessions/:sessionId/participants

API Key Requiredapplication/json

Add Participant to Session

Attaches a participant to a notarization session. Automatically generates a unique, cryptographically signed participant token and video room join URL.

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

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
sessionId	string	Session UUID or Ref ID (e.g. SES-2611-8934).	SES-2611-8934

Request Body Parameters

Format: application/json

Field	Type	Required	Description
name	string	Required	Full name of the participant as per ID. Example: `Ananya Verma`
role	enum	Required	Role of participant in the session. Example: `co_applicant` Allowed:customerco_applicantwitnessobserversigneruser
email	string	Optional	Email address of participant. Example: `ananya.verma@example.com`
externalId	string	Optional	Your internal tracking ID or customer ID. Example: `CUST-9921`
identitySource	string	Optional	Identity verification source (e.g. aadhaar, passport, pan). Example: `aadhaar`
metadata	object	Optional	Arbitrary custom metadata key-value pairs stored with participant. Example: `{"department": "legal", "branchCode": "BLR-01"}`

cURL — Add Participant to Session

curl -X POST "https://eznotary.in/api/v1/sessions/:sessionId/participants" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Ananya Verma",
  "role": "co_applicant",
  "email": "ananya.verma@example.com",
  "externalId": "CUST-9921",
  "identitySource": "aadhaar",
  "metadata": {
    "department": "legal",
    "branchCode": "BLR-01"
  }
}'

GET/sessions/:sessionId/participants

API Key Required

List Session Participants

Returns all participant records including their join tokens, roles, verification statuses, and external IDs.

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

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
sessionId	string	Session UUID or Ref ID.	SES-2611-8934

cURL — List Session Participants

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

GET/sessions/:sessionId/participants/:id

API Key Required

Get Participant Details

Retrieves a single participant record by their participant UUID or reference ID (e.g. PAR-8821).

URL:https://eznotary.in/api/v1/sessions/:sessionId/participants/: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
sessionId	string	Session UUID or Ref ID.	SES-2611-8934
id	string	Participant UUID or Ref ID (e.g. PAR-8821).	PAR-8821

cURL — Get Participant Details

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

POST/sessions/:sessionId/participants/:id/token

API Key Required

Regenerate Participant Token

Issues a fresh participant JWT token and updates their join link. Useful if an existing link expired or needs to be resent securely.

URL:https://eznotary.in/api/v1/sessions/:sessionId/participants/:id/token

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
sessionId	string	Session UUID or Ref ID.	SES-2611-8934
id	string	Participant UUID or Ref ID.	PAR-8821

cURL — Regenerate Participant Token

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

Previous ModuleNotarization Sessions

Next ModuleeSign Requests