caps object you can use to gate UI and API calls without any additional round trips.
All requests to /v1/signing/* require a valid Clerk session JWT in the Authorization: Bearer header. The session endpoint itself returns 200 for any authenticated Clerk user, but returns 403 if that user has no linked signing identity (no manager, admin, or signer row with a matching clerk_user_id).
GET /v1/signing/me is a legacy alias for this endpoint. Both paths return the identical payload. Prefer /v1/signing/session in new integrations.Request
Response
Returns aSigningSessionJson object.
Your Clerk user ID (
sub claim from the JWT). This is the primary key used to look up all signing identity rows.Your manager identity record, if one is linked to your account. Numeric ID fields are serialized as strings.
null if you are not a manager.Your admin identity record, if one exists.
null if you are not an admin. Admin accounts carry elevated read access across all organizations.All signer records linked to your account. A single user may be a signer on multiple packages. Empty array if you have no signer assignments.
Which roles you currently hold. Each element is one of
"manager", "admin", or "signer". A user may hold more than one role simultaneously—for example, a manager who is also assigned as a signer on a package.Module access tiers derived by merging all roles assigned to you across your organization and location memberships. When you have access through multiple roles, the maximum tier per module wins, and vault booleans are OR-ed together.
null if you are not a manager.Fixed full-capability set for admin users (
"full" on every tier, all vault booleans true). null if you are not an admin. The shape is identical to managerModules.Flattened capability object designed for fast client-side guards. Duplicates some information from
managerModules/adminModules but avoids conditional null-checks.Access tier values
| Value | Meaning |
|---|---|
"none" | No access to this module. Feature-level UI should be hidden. |
"read" | Read-only access. List and detail endpoints are permitted. |
"write" | Read + mutation access. Create, update, cancel, and resend endpoints are permitted. |
"full" | Administrative or destructive operations (when implemented). Admins always receive "full" on every module. |
Vault capabilities
All fields areboolean.
| Field | Description |
|---|---|
shareDeal | May share a deal with another party. |
claimDeal | May claim an unclaimed deal. |
transferDeal | May transfer a deal to another organization. |
transferDocuments | May transfer individual documents within a deal. |
transferDealBack | May reverse a deal transfer. |
archiveDeal | May archive a completed deal. |
linkDeals | May link two related deals together. |
uploadDocuments | May upload new documents to a deal. |
replaceUploadedDocuments | May replace previously uploaded documents. |
changeSettings | May change vault-level settings for a deal. |
externDealDocsVideos | May share deal documents and videos with external parties. |
externCompanyLocations | May expose company location data externally. |
externOrganizations | May expose organization data externally. |
exportSigningsList | May export the signings list. |
Error responses
| Status | Condition |
|---|---|
401 | Missing or invalid Clerk JWT. |
403 | Valid Clerk user but no manager, admin, or signer row is linked to this account. |
