Skip to main content
GET
/
signatures
/
{id}
Get Signature
curl --request GET \
  --url https://connect.penbox.io/v1/signatures/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "items": 123,
  "method": "<string>",
  "merge": true,
  "cost": 123,
  "locale": "<string>"
}
Retrieve signature information or download the signature file.

​
Path Parameters

​
id
string
required
Signature UUID

​
Headers

​
Accept
string
Response format:
  • application/json - Get signature metadata (default)
  • application/octet-stream - Download signature file

​
Response Structure (JSON)

When Accept: application/json is used: 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:35:00Z",
  "name": "Contract Signature",
  "key": "customer_signature",
  "status": "completed",
  "items": 3,
  "method": "electronic",
  "merge": true,
  "cost": 2.50,
  "locale": "en"
}

​
Response Fields (JSON)

​
id
string
Signature UUID
​
created_at
string
Creation timestamp
​
updated_at
string
Last update timestamp
​
name
string
Signature name
​
key
string
Signature identifier key
​
status
string
Signature status (e.g., “pending”, “completed”, “declined”)
​
items
number
Number of items/pages to be signed
​
method
string
Signature method (e.g., “electronic”, “qualified”)
​
merge
boolean
Whether to merge signatures into a single document
​
cost
number
Signature cost (if applicable)
​
locale
string
Language/locale code

​
Response (Binary)

When Accept: application/octet-stream is used, returns the signature file (typically PDF format).

​
Response Codes

CodeDescription
200Success - Signature retrieved
401Unauthorized - Invalid access token
404Not Found - Signature doesn’t exist
429Too Many Requests - Rate limit exceeded
500Server Error - Internal error
Signatures are typically generated when a form response includes signature fields. The signature file contains the legally binding signed documents.

Authorizations

​
Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Headers

​
Accept
enum<string>
default:application/json

Response format: application/json for metadata or application/octet-stream for file download

Available options:
application/json,
application/octet-stream

Path Parameters

​
id
string<uuid>
required

Signature UUID

Response

Successful response

​
id
string<uuid>
required

Signature UUID

​
name
string
required

Signature name

​
status
string
required

Signature status (e.g., pending, completed, declined)

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp

​
key
string

Signature identifier key

​
items
integer

Number of items/pages to be signed

​
method
string

Signature method (e.g., electronic, qualified)

​
merge
boolean

Whether to merge signatures into a single document

​
cost
number | null

Signature cost (if applicable)

​
locale
string

Language/locale code