صادقSadq®
GuidesAdmin

API Reference

72 endpoints across 14 groups · v1, v2, v3

Integration Guides

Step-by-step workflows for common integration scenarios

View all

Invitation Model Integration Guide

Complete step-by-step guide for integrating with the Sadq Invitation Model API — from authentication through webhook setup to document signing.

Initiate Envelope by Template Guide

Step-by-step guide to building a reusable signing template in the Sadq portal, then initiating an envelope from it and sending the signing invitation via the API.

Authentication

Obtain and manage API access tokens

1 endpoints
POST

Obtain Access Token

/Authentication/Authority/Token

Envelopes

Initiate and manage signing envelopes and document packages

10 endpoints
POST

Initiate Envelope

/api/v1/envelopes/initiate

POST

Initiate Envelope Base64

/api/v1/envelopes/initiate-base64

POST

Initiate Envelope by Template

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

POST

Bulk Initiate Envelope Base64

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

POST

Add Files to Envelope

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

GET

Download Envelope Files

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

POST

Cancel Envelope

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

GET

Get Envelope Status

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

GET

Download Completed Envelope Files

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

POST

Envelope Creation & Signing Invitation Process

/api/v1/envelopes/bulk/initiate-and-invite

Invitations

Send, extend, and remind signing invitations

9 endpoints
POST

Send Invitation

/api/v1/invitations

POST

Send Bulk Invitations

/api/v1/invitations/bulk/send

POST

Send Invitation by Envelope

/api/v1/invitations/envelope

PUT

Extend Single Invitation

/api/v1/invitations/extend

PUT

Extend Envelope Invitations

/api/v1/envelopes/extend-invitations

POST

Send Reminder

/api/v1/invitations/reminders/send

POST

Send Bulk Reminders

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

POST

Send Invitation V2

/api/v2/invitations

POST

Send Invitation V3

/api/v3/invitations

Sign

Direct signing operations including multi-file and templates

3 endpoints
POST

Sign Document V2

/api/v2/sign

POST

Sign by Template V2

/api/v2/sign/by-template

GET

Digital Sign

/api/v2/sign/digital

eSign

Electronic and digital signature operations via Nafath/PKI

2 endpoints
POST

Hash Sign V1

/api/v1/esign/nafath/sign

POST

Hash Sign V2

/api/v2/esign/nafath/sign

Documents

Download and manage signed document files

5 endpoints
GET

Download Document File

/api/v1/documents/{id}

GET

Download Signed File

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

GET

Download Completed File Base64

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

GET

Download File v1

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

GET

Download File v2

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

Templates

List and retrieve reusable signing templates

2 endpoints
GET

List Templates

/api/v1/templates

GET

Get Template by ID

/api/v1/templates/{templateId}

Users

User management, permissions and signature uploads

5 endpoints
POST

Create User

/api/v1/users

POST

Delete User

/api/v1/users/delete

POST

Add User Permissions

/api/v1/users/permissions/add

POST

Remove User Permissions

/api/v1/users/permissions/remove

PUT

Update User

/api/v1/users/{userId}

Workflows

Create and manage document signing workflows

5 endpoints
POST

Create Workflow

/api/v1/workflows

PUT

Update Workflow

/api/v1/workflows/{workflowId}

GET

List Workflows

/api/v1/workflows

GET

Get Workflow by ID

/api/v1/workflows/{id}

DELETE

Delete Workflow

/api/v1/workflows/{id}

Webhooks

Configure and manage webhook subscriptions and logs

8 endpoints
POST

Create Webhook

/api/v1/webhooks

POST

Create Webhooks Bulk

/api/v1/webhooks/bulk

GET

List Webhooks

/api/v1/webhooks

GET

Get Webhook by ID

/api/v1/webhooks/{id}

DELETE

Delete Webhook

/api/v1/webhooks/{id}

PUT

Update Webhook

/api/v1/webhooks

POST

Recall Webhook

/api/v1/webhooks/recall

GET

Get Webhook Logs

/api/v1/webhooks/logs

Configuration

Update tenant SMS provider and system configuration

2 endpoints
PUT

Update SMS Provider

/api/v1/configuration/sms-provider

POST

Update Configuration

/api/v1/configuration/update

KYB

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

6 endpoints
GET

Check CR v1

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

GET

Check CR v2

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

GET

Absher OTP with CR

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

GET

Absher OTP Individual

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

GET

Check Delegacy

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

GET

Get National Address

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

Archiving & Delegations

File archiving categories and delegation management

9 endpoints
GET

Get Archive Categories

/api/v1/archiving/categories

POST

Create Archive Category

/api/v1/archiving/categories

POST

Upload Archive Files

/api/v1/archiving/files/upload

POST

Create Delegation

/api/v1/delegations

POST

Forward to Delegate

/api/v1/delegations/forward

PUT

Update Delegation Status

/api/v1/delegations/status

DELETE

Delete Delegation

/api/v1/delegations/{id}

POST

Create Bulk Signature Request

/api/v1/signature-requests/bulk

POST

Search Bulk Templates

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

Reports & Requests

Consumption reports, request listings and bulk signature jobs

5 endpoints
GET

Get Consumption Report

/api/v1/reports/consumption

POST

Generate Requests Report

/api/v1/reports/requests

GET

Get Requests List

/api/v1/requests/list

GET

Request filter

/api/v1/requests/user-list

POST

Requests by Destinations Report

/api/v1/reports/requests-by-destinations