Signer Roles
Define the roles that will sign your document.
Signer Roles
Signer roles are templates — they define who will sign (e.g. "Client", "Witness") without specifying actual people. Real signers are added when you create a submission.
GET
/api/v1/documents/{id}/signer-rolesRequired scope:read:documents
POST
/api/v1/documents/{id}/signer-rolesCreate a signer role
Required scope:write:documents
DELETE
/api/v1/documents/{id}/signer-roles/{rid}Delete a role
Required scope:write:documents
Create a signer role
The API auto-assigns a color and a role identifier (signer_1, signer_2, etc.).
curl -X POST https://formalingo.com/api/v1/documents/DOC_ID/signer-roles \
-H "Authorization: Bearer af_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{ "label": "Client" }'Response201
{
"success": true,
"data": {
"id": "role-uuid",
"documentId": "doc-uuid",
"role": "signer_1",
"label": "Client",
"color": "#2563EB",
"order": 0
}
}The role value (e.g. signer_1) is what you reference when placing fields (assigneeRole) and when creating submissions.