Recipients
Add Recipients
Add recipients to a document. Recipients can be signers, approvers, or CC.
Add recipients to a document. Recipients can be signers, approvers, or CC.
Authorization
bearerAuth AuthorizationBearer <token>
API key as Bearer token. Format: signsecure_xxxxxxxx...
In: header
Path Parameters
documentId*string
The document ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.signsecure.com/api/v1/documents/string/recipients" \ -H "Content-Type: application/json" \ -d '{ "recipients": [ { "email": "user@example.com", "name": "string" } ] }'{
"message": "string",
"recipients": [
{
"id": "string",
"name": "string",
"email": "string",
"role": "signer",
"order": 0,
"status": "pending",
"signatureMethod": "electronic"
}
]
}{
"code": "VALIDATION_ERROR",
"message": "recipients.0.email: Invalid email",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z",
"details": {
"validation": {
"fieldErrors": {
"recipients.0.email": [
"Invalid email"
]
},
"formErrors": [],
"issues": [
{
"path": "recipients.0.email",
"message": "Invalid email",
"code": "invalid_string"
}
]
}
}
}{
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}{
"code": "FORBIDDEN",
"message": "API key is disabled",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}{
"code": "NOT_FOUND",
"message": "Document not found",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "An internal error occurred",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}