2.6 KiB
2.6 KiB
API Data Samples (Adobe Sign)
1. Library Document Metadata (/libraryDocuments/{libraryDocumentId})
{
"libraryDocumentId": "abc123",
"id": "abc123",
"name": "Sample NDA Template",
"status": "ACTIVE",
"ownerEmail": "someone@example.com",
"createdDate": "2026-04-14T15:40:00Z",
"sharingMode": "ACCOUNT",
"locale": "en_US",
"participants": [
{
"recipientSetRole": "SIGNER",
"recipientSetMemberInfos": [
{ "name": "Signer 1", "email": "signer1@example.com" }
]
}
],
"fileInfos": [
{
"label": "Main PDF",
"transientDocumentId": "XYZ987",
"url": "https://secure.na1.adobesign.com/public/document?..."
}
]
}
2. Form Fields (/libraryDocuments/{libraryDocumentId}/formFields)
[
{
"fieldName": "FullName",
"type": "TEXT_FIELD",
"required": true,
"readOnly": false,
"defaultValue": "",
"locations": [
{ "pageNumber": 1, "rect": { "left": 120, "top": 250, "width": 200, "height": 15 } }
],
"recipientIndex": 0
},
{
"fieldName": "SignatureField1",
"type": "SIGNATURE",
"required": true,
"locations": [
{ "pageNumber": 2, "rect": { "left": 320, "top": 450, "width": 120, "height": 35 } }
],
"recipientIndex": 1
}
]
3. Recipients (/libraryDocuments/{libraryDocumentId}/recipients)
[
{
"recipientSetId": "1",
"recipientSetRole": "SIGNER",
"recipientSetMemberInfos": [
{ "email": "signer1@example.com", "name": "Signer One", "role": "SIGNER" }
],
"order": 1
},
{
"recipientSetId": "2",
"recipientSetRole": "APPROVER",
"recipientSetMemberInfos": [
{ "email": "approver@example.com", "name": "Approver Person", "role": "APPROVER" }
],
"order": 2
}
]
4. Workflow Info (/libraryDocuments/{libraryDocumentId}/workflows)
[
{
"workflowId": "w123",
"workflowName": "NDA Approval Chain",
"steps": [
{ "stepType": "SIGNER", "participantSetRole": "SIGNER", "order": 1 },
{ "stepType": "APPROVER", "participantSetRole": "APPROVER", "order": 2 }
]
}
]
5. Audit (/libraryDocuments/{libraryDocumentId}/auditTrail)
[
{
"eventType": "CREATED",
"actingUserEmail": "someone@example.com",
"date": "2026-04-14T15:40:00Z",
"description": "Template was created."
},
{
"eventType": "SHARED",
"actingUserEmail": "admin@example.com",
"date": "2026-04-15T12:14:00Z",
"description": "Template shared with account."
}
]
Expand/add new samples as we work through real templates.