Enums & Reference Data
Reference values used across the API.
Authentication Type
Authentication methods available for signature requests and user verification.
| Value | Name | Description |
|---|---|---|
| 0 | None | No authentication is required. |
| 1 | Nafath KYC | Users authenticate through Nafath for the first time then will be login with Sadq credentials |
| 2 | SMS | An OTP is sent via SMS to verify the user's identity. |
| 3 | An OTP is sent via email for authentication. | |
| 5 | DigitalSign | For Digital signature authentication for documents Only |
| 7 | Nafath App | Authentication through the Nafath mobile application every time |
| 9 | Absher OTP | Users authenticate using an OTP from the Absher platform. |
| 10 | An authentication OTP is sent to WhatsApp. |
Field Type
Types of fields available in documents for signatures and data entry.
| Value | Name | Description |
|---|---|---|
| Signature | Signature | Represents a signature field for capturing and displaying signatures. |
| initial | Intial | Represents an Initial field for capturing and displaying initials. |
| stamp | Stamp | Represents a stamp field for capturing and displaying stamps. |
| signDate | SignDate | Auto-populated with the signing date when the recipient signs. |
| radio | Radio button | Radio button field for single-choice selections. |
| checkbox | Checkbox | Checkbox field for multiple-choice selections. |
| TextField | TextField | Text input field for entering custom text. |
Webhook Status
Status values for envelope via webhook.
| Value | Name | Description |
|---|---|---|
| 1 | Success | Envelope is completed |
| 2 | Rejected | Envelope has been rejected |
Webhook log Status
Status values for webhook delivery.
| Value | Name | Description |
|---|---|---|
| 0 | PENDING | Webhook is pending delivery |
| 1 | SUCCESS | Webhook delivered successfully |
| 2 | RECALL | Webhook was recalled/retried |
| 4 | FAILEDFROMCLIENT | Delivery failed at client endpoint |
Gender
Gender identification values.
| Value | Name | Description |
|---|---|---|
| 1 | Male | |
| 2 | Female | |
| 3 | Other | |
| 4 | Don't Exposed |
SMS Provider Type
Available SMS service providers.
| Value | Name | Description |
|---|---|---|
| 1 | Imissive | |
| 2 | Msegat | |
| 3 | Unifonic | |
| 4 | FourJawaly | |
| 5 | InfinitoProvider |
Text Alignment Type
Text alignment options for document fields.
| Value | Name | Description |
|---|---|---|
| 0 | AlignLeft | |
| 1 | AlignCenter | |
| 2 | AlignRight |
Destination Type
Types of recipients in signature workflows.
| Value | Name | Description |
|---|---|---|
| 0 | Creator | |
| 1 | Signer | |
| 2 | CC | |
| 3 | Reviewer | |
| 4 | Department |
Invitation Language
Language options for invitation emails and SMS.
| Value | Name | Description |
|---|---|---|
| 1 | Arabic | Send invitation in Arabic language |
| 2 | English | Send invitation in English language |
ID Types
Types of identification documents.
| Value | Name | Description |
|---|---|---|
| 1 | National ID Card | |
| 2 | Resident ID | |
| 3 | Passport |
File Template Share Type
Sharing visibility options for file templates.
| Value | Name | Description |
|---|---|---|
| 0 | Private | Template is private to the creator |
| 1 | Public | Template is publicly accessible |
| 2 | Shared | Template is shared with specific users |
Document/Request Status
Common status values for documents and signature requests.
| Value | Name | Description |
|---|---|---|
| 0 | Pending | Waiting for action |
| 1 | In Progress | One or more signers have started |
| 2 | Completed | All required signers have completed |
| 3 | Cancelled | Request was cancelled |
| 4 | Rejected | One or more signers declined |
| 5 | Expired | Request expired before completion |
Permissions
Available system permissions for user access control.
| Value | Name | Description |
|---|---|---|
| 1 | ViewAccounts | View account information |
| 2 | AddAccount | Create new accounts |
| 3 | UpdateAccount | Modify existing accounts |
| 4 | ViewUsers | View user information |
| 5 | AddUser | Create new users |
| 6 | UpdateUser | Modify existing users |
| 7 | DeleteUser | Remove users from the system |
| 8 | DeleteAccount | Remove accounts from the system |
| 9 | UpdateConfiguration | Modify system configuration |
| 10 | UploadFile | Upload files to the system |
| 11 | ViewSignatureRequestList | View list of signature requests |
| 12 | ViewDocumentSigners | View signers of a document |
| 13 | DownloadFile | Download files from the system |
| 14 | UploadContent | Upload content to the system |
| 15 | ReInviteUser | Resend invitations to users |
| 16 | UpdateUserPermission | Modify user permissions |
| 17 | DeleteSignatureRequest | Remove signature requests |
| 18 | ShareUsingWhatsApp | Share documents via WhatsApp |
| 19 | ViewUserDelegations | View delegation information |
| 20 | AddUserDelegations | Create new delegations |
| 22 | AdminDashboard | Access admin dashboard |
| 23 | AddConfigurationAdmin | Add system configuration (admin only) |
| 24 | UpdateConfigurationAdmin | Update system configuration (admin only) |
| 25 | GetConfiguration | Retrieve configuration settings |
| 26 | GenerateTemplates | Create document templates |
| 27 | ViewBranding | View branding settings |
| 28 | UpdateBranding | Modify branding settings |
| 29 | ViewDepartments | View department information |
| 30 | AddDepartment | Create new departments |
| 31 | UpdateDepartment | Modify existing departments |
| 32 | DeleteDepartment | Remove departments |
| 33 | ViewDepartmentDocumentsList | View documents in a department |
| 34 | AddAndUseStamp | Add and apply stamps to documents |
| 35 | AddUserToDepartment | Assign users to departments |
| 36 | AddDepartmentForUser | Assign departments to users |
| 37 | SignatureRequestToDepartments | Send signature requests to departments |
| 38 | BulkSend | Send bulk signature requests |
| 39 | ViewTemplates | View document templates |
| 40 | SendDocumentUsingEmail | Send documents via email |
| 41 | SendDocumentUsingSMS | Send documents via SMS |
| 42 | SendDocumentUsingNafath | Send documents via Nafath |
| 43 | SendDocumentUsingEmdah | Send documents via Emdah |
| 44 | SigningOnBehalfOfCompany | Sign documents as company representative |
| 45 | ChangeEmail | Modify user email address |
| 46 | ChangePhone | Modify user phone number |
| 47 | SendDocumentUsingNafathApp | Send documents via Nafath App |
| 48 | AddGroupUsers | Create user groups |
| 49 | ManageRoles | Manage user roles |
| 50 | WhatsApp integration access | |
| 51 | ConsumptionReport | View consumption reports |
| 52 | RequestReport | View request reports |
| 53 | ShowArchivingTab | Access archiving features |
| 54 | CreateFolderOrFile | Create folders and files in archive |
| 55 | DeleteFolderOrFile | Remove folders and files from archive |
| 56 | ShareFolderOrFile | Share archived folders and files |
| 57 | MoveFolderOrFile | Move folders and files in archive |
| 58 | ShowStorageUsed | View storage usage information |
| 62 | Escalation | Escalate signature requests |
| 63 | SendDocumentUsingPinCode | Send documents with PIN code authentication |
| 64 | UserDeleteHisProfile | Allow users to delete their own profiles |
| 65 | CommercialInquiryHistory | View commercial inquiry history |
| 66 | RestoreSignatureRequest | Restore deleted signature requests |
| 67 | DeleteSignatureRequestPermanently | Permanently remove signature requests |
| 68 | SendDocumentUsingAbsher | Send documents via Absher |
| 69 | SelfSign | Sign documents as the creator |
| 70 | SignatureRequestKPI | View signature request KPIs |
| 71 | AnalyzeDocumentsByAI | Use AI to analyze documents |
| 72 | Watermark | Add watermarks to documents |
| 73 | EmailTemplateConfiguration | Configure email templates |
| 74 | ConsumptionMonthlyReport | View monthly consumption reports |
| 75 | ManageAccountRejectionReason | Manage rejection reasons |
| 76 | UpdatePasswordConfiguration | Modify password policies |
| 79 | EditAndPreviewDesignPages | Edit and preview page designs |
| 80 | UseOrganizationStamp | Apply organization stamps |
| 81 | ViewRequestsByDestinationsReport | View destination reports |
| 82 | EditWebhooks | Edit webhook configurations |
| 83 | DeleteWebhooks | Delete webhooks |
| 84 | ViewWebhooksReports | View webhook reports |
| 85 | ViewWebhooks | View webhooks |
| 86 | AddWebhooks | Add new webhooks |
| 87 | Metadata | Manage document metadata |
| 88 | ViewAuditLog | View audit logs |
| 89 | SmartTasksFromRequests | Create smart tasks from requests |
| 90 | DailyRequestSummary | View daily request summary |
| 91 | NotifyMeAboutKeyEmails | Receive notifications for key emails |
| 92 | SmartSignaturePrioritization | Enable smart signature prioritization |
| 93 | ViewAiTokenConsumptionReport | View AI token consumption |
| 94 | AddRenewal | Add renewal requests |
| 95 | GenerateDocumentWithAI | Generate documents using AI |
| 96 | Manage2FA | Manage two-factor authentication |
| 97 | MetadataAutomation | Automate metadata extraction |
| 98 | WordSearch | Search within document content |
| 99 | CreateRoom | Create collaboration rooms |
| 100 | ManageRoomsCustomPermissions | Manage room custom permissions |
| 101 | CreateContract | Create contracts |
| 106 | ApproveReview | Approve contract reviews |
| 109 | ManagePlaybook | Manage contract playbooks |
| 110 | ViewWorkflow | View contract workflows |
| 111 | ManageWorkflow | Manage contract workflows |
| 113 | FillContractUsingAI | Fill contracts using AI |
| 115 | WorkflowPage | Access workflow page |