API Reference

Obtain Access Token

/Authentication/Authority/Token

Envelopes

Initiate and manage signing envelopes and document packages

10 endpoints

Initiate Envelope

/api/v1/envelopes/initiate

Initiate Envelope Base64

/api/v1/envelopes/initiate-base64

Initiate Envelope by Template

/api/v1/envelopes/initiate-by-template

Bulk Initiate Envelope Base64

/api/v1/envelopes/bulk/initiate-base64

Bulk Initiate Envelope Files

/api/v1/envelopes/bulk-files

Add Files to Envelope

/api/v1/envelopes/{envelopeId}/files

Download Envelope Files

/api/v1/envelopes/{envelopeId}/files

Cancel Envelope

/api/v1/envelopes/{envelopeId}/cancel

Get Envelope Status

/api/v1/envelopes/{envelopeId}/status

Download Completed Envelope Files

/api/v1/envelopes/{envelopeId}/files/completed

Invitations

Send, extend, and remind signing invitations

9 endpoints

Send Invitation

/api/v1/invitations

Send Bulk Invitations

/api/v1/invitations/bulk/send

Send Invitation by Envelope

/api/v1/invitations/envelope

Extend Single Invitation

/api/v1/invitations/extend

Extend Envelope Invitations

/api/v1/envelopes/extend-invitations

Send Reminder

/api/v1/invitations/reminders/send

Send Bulk Reminders

/api/v1/invitations/bulk/reminders/send

Send Invitation V2

/api/v2/invitations

Send Invitation V3

/api/v3/invitations

Sign

Direct signing operations including multi-file and templates

3 endpoints

Sign Document V2

/api/v2/sign

Sign Multiple Documents V2

/api/v2/sign/multi-files

Sign by Template V2

/api/v2/sign/by-template

eSign

Electronic and digital signature operations via Nafath/PKI

12 endpoints

ESign Test

/api/v1/esign/test

Sign Hash

/api/v1/esign/hash/sign

Validate Signers

/api/v1/esign/hash/validate-signers

Sign with Digital Certificate

/api/v1/esign/digital-certificate/sign

Initiate Sign Information

/api/v1/esign/initiate-info

Initiate Request with Destinations

/api/v1/esign/requests/initiate

Nafath Sign v1

/api/v1/esign/nafath/sign

Nafath Sign v2

/api/v2/esign/nafath/sign

Saudi Root Digital Sign

/api/v1/esign/digital-sign

Get Nafath Keys

/api/v1/esign/nafath/keys

Get Java Keys

/api/v1/esign/java/keys

Get Nafath QR URL

/api/v1/esign/nafath/qr-url

Documents

Download and manage signed document files

5 endpoints

Download Document File

/api/v1/documents/{id}

Download Signed File

/api/v1/documents/{id}/signed

Download Completed File Base64

/api/v1/documents/{id}/completed/base64

Download File Content Base64 v1

/api/v1/documents/{id}/content-base64

Download File Content Base64 v2

/api/v2/documents/{id}/content-base64

Templates

List and retrieve reusable signing templates

2 endpoints

List Templates

/api/v1/templates

Get Template by ID

/api/v1/templates/{templateId}

Users

User management, permissions and signature uploads

11 endpoints

Create User

/api/v1/users

Delete User

/api/v1/users/delete

Add User Permissions

/api/v1/users/permissions/add

Remove User Permissions

/api/v1/users/permissions/remove

Update User

/api/v1/users/{userId}

Upload Signature

/api/v1/users/signatures/upload

Upload Signatures Bulk

/api/v1/users/signatures/upload-bulk

Get Signature by ID

/api/v1/users/signatures/{signatureId}

List User Signatures

/api/v1/users/{userId}/signatures

List My Signatures

/api/v1/users/me/signatures

Delete Signature

/api/v1/users/signatures/{signatureId}

Workflows

Create and manage document signing workflows

5 endpoints

Create Workflow

/api/v1/workflows

Update Workflow

/api/v1/workflows/{workflowId}

List Workflows

/api/v1/workflows

Get Workflow by ID

/api/v1/workflows/{id}

Delete Workflow

/api/v1/workflows/{id}

Webhooks

Configure and manage webhook subscriptions and logs

8 endpoints

Create Webhook

/api/v1/webhooks

Create Webhooks Bulk

/api/v1/webhooks/bulk

List Webhooks

/api/v1/webhooks

Get Webhook by ID

/api/v1/webhooks/{id}

Delete Webhook

/api/v1/webhooks/{id}

Update Webhook

/api/v1/webhooks

Get Webhook Logs

/api/v1/webhooks/logs

Recall Webhook

/api/v1/webhooks/recall

Configuration

Update tenant SMS provider and system configuration

3 endpoints

Update SMS Provider

/api/v1/configuration/sms-provider

Update Configuration

/api/v1/configuration/update

Update Configuration PUT

/api/v1/configuration

KYB

Know Your Business — CR checks, Absher OTP, delegacy lookups

8 endpoints

Check CR v1

/api/v1/kyb/check-cr/{commercialNumber}

Check CR v2

/api/v2/kyb/check-cr/{commercialNumber}

Absher OTP with CR

/api/v1/kyb/absher-otp/{commercialNumber}/{nationalId}

Absher OTP Individual

/api/v1/kyb/absher-otp/{nationalId}

Get Related Companies v1

/api/v1/kyb/related/{nationalId}

Get Related Companies v2

/api/v2/kyb/related/{nationalId}

Check Delegacy

/api/v1/kyb/delegacy/{nationalId}/{delegatedReferenceId}

Get National Address

/api/v1/kyb/spl/national-address/{crNumber}

Archiving & Delegations

File archiving categories and delegation management

10 endpoints

Get Archive Categories

/api/v1/archiving/categories

Create Archive Category

/api/v1/archiving/categories

Upload Archive Files

/api/v1/archiving/files/upload

Create Delegation

/api/v1/delegations

Forward to Delegate

/api/v1/delegations/forward

Update Delegation Status

/api/v1/delegations/status

Delete Delegation

/api/v1/delegations/{id}

Create Bulk Signature Request

/api/v1/signature-requests/bulk

Download Excel Sample

/api/v1/signature-requests/bulk/excel-sample

Search Bulk Templates

/api/v1/signature-requests/bulk/templates

Reports & Requests

Consumption reports, request listings and bulk signature jobs

3 endpoints

Get Consumption Report

/api/v1/reports/consumption

Generate Requests Report

/api/v1/reports/requests