post
https://{host}/api/v2/projects
Create Project
Create a new signature request project by uploading a PDF document. This endpoint is typically used to initiate a document signing workflow, either as a draft or to send to recipients for signature or approval.
HTTP Method & URL
-
Method:
POST -
URL:
{{host}}/api/v2/projects?user_type=ENTERPRISE_API
Authentication
-
Type: Bearer Token (recommended)
-
Header:
Authorization: Bearer {USER-TOKEN}
Query Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| user_type | string | Yes | Specifies the user type. Must be ENTERPRISE_API. | ENTERPRISE_API |
Request Body (multipart/form-data)
| Key | Type | Required | Description | Example Value |
|---|---|---|---|---|
| file | file | Yes | PDF file to upload for the project. | DOC-demo-PDF-form-1.pdf |
| user_list_editable | boolean | No | If false, recipients cannot be edited after creation. | false |
| creator_as_viewer | boolean | No | If false, creator is not added as a viewer. | false |
| document_stamp | string (JSON) | No | JSON string describing the electronic notarial/official seal and related notary or authority information to be applied to the document. | { "seal": { "type": "seal", "enp_name": "...", "enp_role_number": "123456" }, "notary_info": { "name": "Juan Dela Cruz", "commission_number": "NTR-001" } } |
| type | string | No | Specifies the project type. Use DOCUMENT for a standard signing project or TEMPLATE to create a reusable template. | DOCUMENT |
| document_password | string | No | Password to protect the completed document. When set, recipients will need this password to open the final signed PDF. | password |
Example Request Body:
file: /path/to/document.pdf
user_list_editable: false
creator_as_viewer: false
document_stamp: {"seal":{...},"notary_info":{...}}
type: DOCUMENT
document_password: password
Example Request
POST {{host}}/api/v2/projects?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}
Content-Type: multipart/form-data
[email protected]
user_list_editable=false
creator_as_viewer=false
document_stamp={"seal":{...},"notary_info":{...}}
type=DOCUMENT
document_password=password
Example Successful Response
{
"message": "",
"data": {
"access_type": "",
"id": 0,
"sender_id": 0,
"uuid": "",
"reference_number": "",
"type": "",
"category": "",
"source": "",
"status": "",
"name": "",
"file_name": "",
"url": "",
"description": "",
"signatory_type": "",
"validation_status": "",
"signer_mark_page": null,
"signer_mark_x": null,
"signer_mark_y": null,
"creator_id": 0,
"creator_name": "",
"created_at": "",
"updated_at": ""
}
}
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…