Enum Catalog¶

Enums used across request/response bodies, with exact values as implemented.

A drift worth knowing about¶

Two fields are duplicated behind the scenes and have drifted slightly depending on which part of the API returns them:

Enum	Full value set	Where you might see a narrower copy
`WorkFlowStatus`	`DRAFT, SENT, VOID, COMPLETED, APPROVED`	Some places recognize only `DRAFT, SENT, VOID, COMPLETED` (no `APPROVED`)
`RecipientRole`	`SIGNER, APPROVER, CC, ASSISTANT`	Some places recognize only `SIGNER`

Practical implication: the values above (with APPROVED/APPROVER/ASSISTANT) are the full, authoritative set — don't assume every corner of the API recognizes all of them equally.

Workflow & documents¶

WorkFlowType: SELFSIGN, COUNTERSIGN, POWERSURVEY

WorkflowSequence: SELF, ORDERED, UNORDERED, SURVEY

WorkFlowStatus: DRAFT, SENT, VOID, COMPLETED, APPROVED

RecipientRole: SIGNER, APPROVER, CC, ASSISTANT — ASSISTANT is system-assigned only (see Sending & Signing → hidden assistant pre-review), never client-settable.

FieldType: SIGNATURE, TEXT, CHECKBOX, NAME, EMAIL, NUMBER, DROPDOWN, NOTE, TEXTAREA, DIGITAL_SIGNATURE, INITIALS, IMAGE, DATE

FieldStatus: PROCESSED, NOT_PROCESSED

FieldEventType: SESSION_START, FIELD_VIEWED, FIELD_FOCUSED, FIELD_GLANCED, FIELD_FILLED, SUBMITTED

ConsentSource: WEB, MOBILE, UNKNOWN

Users & organizations¶

UserStatus: REGISTERED, ACTIVE, GUEST, INACTIVE, DELETED

UserLinkStatus: ACTIVE, EXPIRED

OrgMemberStatus: INVITED, JOINED, DECLINED

InviteStatus: ACCEPTED, DECLINED

BusinessAppStatus: ENABLED, DISABLED

GrantType: PASSWORD, G_AUTHENTICATOR, GOOGLE_AUTH, CLIENT_CREDENTIALS, REFRESH_TOKEN — see Authentication.

Roles & permissions¶

UserRolePermissionModule (custom Organization → Roles): BILLING_DETAILS, BRANDING, BUSINESS_APPS, TEMPLATES, ROLES, ORGANIZATIONS, USERS — matches the Organization page's own tabs.

Role status: ACTIVE, INACTIVE, DISABLED.

Connectors¶

Connectors — top-level purpose: EMAIL, SIGN, CA.

Connectors.Email provider values: SMTP, SENDGRID, AMAZON_SES, MICROSOFT_OAUTH2. Each provider has its own required config-key set (used in Organization → Email Settings):

Provider	Required config keys
`SMTP`	`SMTP_SERVER`, `SMTP_PORT`, `SSL_TLS`, `AUTHENTICATION`, `USER_ID`, `PASSWORD`, `EMAIL_FROM`
`SENDGRID`	`API_KEY`, `EMAIL_FROM`
`AMAZON_SES`	`API_KEY`, `ACCESS_KEY`, `REGION`, `EMAIL_FROM`
`MICROSOFT_OAUTH2`	`TENANT_ID`, `CLIENT_ID`, `CLIENT_SECRET`, `OAUTH_SCOPE`, `EMAIL_FROM`

Connectors.Sign provider values: ETUGRA_MIDDLEWARE, ETUGRA_SIGNER_APP, CSC_2, CRYPTO_ENGINE — referenced when picking a remote signing provider (see Sending & Signing → Remote/CSC signing bridge).

SECRET_CONFIG_KEYS: config keys masked (********) whenever a connector's configuration is returned in a response — includes PASSWORD, CLIENT_SECRET, API_KEY, SECRET_KEY, and equivalents. Never expect these values to round-trip back through a GET call.

Signature qualifiers¶

Referenced informally rather than as one shared enum: SES (simple), AES (advanced), QES (qualified) — gated per-organization by your plan and per-user by quotaElectronic/quotaAdvanced/quotaQualified (see Settings → Signature Settings).