Helpers

auth.createCodeChallenge

Create the PKCE code challenge for a verifier: the base64url-encoded SHA-256 of it. Isomorphic, using WebCrypto in both browsers and Node 18 or later.

createCodeChallenge(verifier: string): Promise<string>

auth.createCodeVerifier

Create a PKCE code verifier: 43 characters of URL-safe randomness, per RFC 7636. Keep it where it will survive the round trip to the provider (`sessionStorage` in a browser), pass its challenge to `getSocialLoginUrl()`, and send it back with the `login-code` grant.

createCodeVerifier(): string

auth.getMFAChallenge

Companion to `isMFARequired()` that returns the challenge body, or null if the error is something else. Handy in `catch` blocks that just need the `mfa_token`.

getMFAChallenge(e: unknown): IMFARequiredError | null

auth.isMFARequired

Type guard for the `mfa_required` challenge. A sign-in for a user with MFA enabled fails with a 403 carrying `{error: 'mfa_required', mfa_token}`, and the app finishes the sign-in with an mfa grant. Use `getMFAChallenge()` instead if it is easier to work with the body directly.

isMFARequired(e: unknown): boolean

auth.createCodeChallenge

Create the PKCE code challenge for a verifier: the base64url-encoded SHA-256 of it. Isomorphic, using WebCrypto in both browsers and Node 18 or later.

create_code_challenge(verifier: str) -> str

auth.createCodeVerifier

Create a PKCE code verifier: 43 characters of URL-safe randomness, per RFC 7636. Keep it where it will survive the round trip to the provider (`sessionStorage` in a browser), pass its challenge to `getSocialLoginUrl()`, and send it back with the `login-code` grant.

create_code_verifier() -> str

auth.getMFAChallenge

Companion to `isMFARequired()` that returns the challenge body, or null if the error is something else. Handy in `catch` blocks that just need the `mfa_token`.

get_mfa_challenge(error: object) -> MFAChallenge | None

auth.isMFARequired

Type guard for the `mfa_required` challenge. A sign-in for a user with MFA enabled fails with a 403 carrying `{error: 'mfa_required', mfa_token}`, and the app finishes the sign-in with an mfa grant. Use `getMFAChallenge()` instead if it is easier to work with the body directly.

is_mfa_required(error: object) -> TypeGuard[MFARequiredError]

auth.createCodeChallenge

Create the PKCE code challenge for a verifier: the base64url-encoded SHA-256 of it. Isomorphic, using WebCrypto in both browsers and Node 18 or later.

string CreateCodeChallenge(string verifier)

auth.createCodeVerifier

Create a PKCE code verifier: 43 characters of URL-safe randomness, per RFC 7636. Keep it where it will survive the round trip to the provider (`sessionStorage` in a browser), pass its challenge to `getSocialLoginUrl()`, and send it back with the `login-code` grant.

string CreateCodeVerifier()

auth.getMFAChallenge

Companion to `isMFARequired()` that returns the challenge body, or null if the error is something else. Handy in `catch` blocks that just need the `mfa_token`.

Not yet available for C#.

auth.isMFARequired

Type guard for the `mfa_required` challenge. A sign-in for a user with MFA enabled fails with a 403 carrying `{error: 'mfa_required', mfa_token}`, and the app finishes the sign-in with an mfa grant. Use `getMFAChallenge()` instead if it is easier to work with the body directly.

Not yet available for C#.

color.getRGB

Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.

getRGB(rgba: string): string

color.getRGBA

Given a signer role index, return the color code for that signer.

getRGBA(roleIndex: number): 'rgba(255, 193, 7, 0.4)' | 'rgba(134, 134, 134, 0.3)' | 'rgba(156, 39, 176, .4)' | 'rgba(33, 150, 243, .4)' | 'rgba(220, 231, 117, 0.3)' | 'rgba(121, 134, 203, 0.3)' | 'rgba(77, 182, 172, 0.3)' | 'rgba(255, 202, 165, 0.3)' | 'rgba(2, 247, 190, 0.3)' | 'rgba(255, 138, 101, 0.3)' | 'rgba(82, 255, 79, 0.3)' | 'rgba(229, 115, 155, 0.3)'

color.getRoleColor

Helper function to obtain a color code given a role name given various possible inputs.

getRoleColor(name: string, roles: TRole[], index?: number): string | undefined

color.nameToRGBA

Given a role name, return a color code for it. This works by computing a hash code so the specific color returned is not specified explicitly, but will be the same for every call with the same input value.

nameToRGBA(str: string): string | undefined

color.getRGB

Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.

Not yet available for Python.

color.getRGBA

Given a signer role index, return the color code for that signer.

Not yet available for Python.

color.getRoleColor

Helper function to obtain a color code given a role name given various possible inputs.

Not yet available for Python.

color.nameToRGBA

Given a role name, return a color code for it. This works by computing a hash code so the specific color returned is not specified explicitly, but will be the same for every call with the same input value.

Not yet available for Python.

color.getRGB

Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.

string GetRgb(string rgba)

color.getRGBA

Given a signer role index, return the color code for that signer.

string GetRgba(int roleIndex)

color.getRoleColor

Helper function to obtain a color code given a role name given various possible inputs.

string? GetRoleColor(string? name, IReadOnlyList<string>? roles, int? index = null)

color.nameToRGBA

Given a role name, return a color code for it. This works by computing a hash code so the specific color returned is not specified explicitly, but will be the same for every call with the same input value.

string? NameToRgba(string? name)

dateTime.formatShortTimeAgo

formatShortTimeAgo(val: any): string

dateTime.formatShortTimeAgo

format_short_time_ago(val: datetime | str | int | float | None) -> str

dateTime.formatShortTimeAgo

string FormatShortTimeAgo(DateTimeOffset? value)

entitlement.collapseEntitlements

collapseEntitlements(entitlements: IEntitlement[]): Partial<Record<TEntitlement, IEntitlement>>

entitlement.collapseEntitlements

collapse_entitlements(entitlements: list[Entitlement]) -> ActiveEntitlements

entitlement.collapseEntitlements

IReadOnlyDictionary<string, Entitlement> CollapseEntitlements(IEnumerable<Entitlement> entitlements)

envelope.canAccessEnvelope

Check to see if the profile ID is the envelope's sender or one of the recipients.

canAccessEnvelope(profile_id: string | null | undefined, envelope: IEnvelope): boolean

envelope.envelopeIsActive

Check to see if the envelope has pending actions.

envelopeIsActive(envelope: IEnvelope): boolean

envelope.envelopeIsComplete

Check to see if the envelope has been completed.

envelopeIsComplete(envelope: IEnvelope): boolean

envelope.getMyRecipient

Regardless of if the session is `user` or `signer`, returns the envelope's recipient that matches the user's session.

getMyRecipient(session: TSession, envelope: IEnvelope): IRecipient | undefined

envelope.getNextRecipient

getNextRecipient(envelope: IEnvelope): IRecipient

envelope.getRecipient

Get a recipient from an envelope via an email match.

getRecipient(email: string, envelope: IEnvelope): IRecipient | undefined

envelope.getRecipientsWithActions

Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).

getRecipientsWithActions(envelope: IEnvelope): IRecipient[]

envelope.getRecipientWithActions

Get a recipient that can act from an envelope via an email match.

getRecipientWithActions(email: string, envelope: IEnvelope): boolean | undefined

envelope.isEnvelopeOwner

Check to see if the profile ID owns the envelope.

isEnvelopeOwner(profile_id: string | null | undefined, envelope: IEnvelope): boolean

envelope.isEnvelopeRecipient

Check to see if the profile ID is a recipient within the envelope.

isEnvelopeRecipient(profile_id: string | null | undefined, envelope: IEnvelope): boolean

envelope.isFieldFilled

isFieldFilled(field: IEnvelopeField, allRecipientFields: IEnvelopeField[]): boolean | '' | null

envelope.isFieldValid

isFieldValid(field: IEnvelopeField, allRecipientFields: IEnvelopeField[]): boolean | '' | null

envelope.recipientCanAct

Returns true if the recipient can act.

recipientCanAct(recipient: IRecipient, recipientsWithActions: IRecipient[]): boolean

envelope.recipientHasAction

Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).

recipientHasAction(recipient: IRecipient): boolean

envelope.sortDocuments

Utility function to sort documents by their order, falling back to created_at. NOTE: This function mutates the input array.

sortDocuments(documents: object[]): object[]

envelope.sortFields

Utility function to sort fields by page, then by Y coordinate, then by X coordinate. NOTE: This function mutates the input array.

sortFields(fields: object[]): object[]

envelope.sortRecipients

Utility function to sort documents by their order, falling back to created_at. NOTE: This function mutates the input array.

sortRecipients(recipients?: object[]): object[] | undefined

envelope.useCanAccessEnvelope

Check to see if the profile ID is the envelope's sender or one of the recipients.

useCanAccessEnvelope(profile: IProfile | null | undefined, envelope: IEnvelope): boolean

envelope.userCanAct

Returns true if the user can act.

userCanAct(email: string, recipientsWithActions: IRecipient[]): boolean | undefined

envelope.userCanCancelEnvelope

Check to see if the user owns the envelope.

userCanCancelEnvelope(profile: IProfile | null | undefined, envelope: IEnvelope): boolean

envelope.userCanFinishEnvelope

Check to see if the user owns the envelope.

userCanFinishEnvelope(profile: IProfile | null | undefined, envelope: IEnvelope): boolean

envelope.userCanResetEnvelope

Check to see if the user can reset the envelope: they own it, and it either expired or has a recipient who failed authentication. This may be used to pre-determine if the envelope may be reset before calling `resetEnvelope`, e.g. to disable a "Reset" button.

userCanResetEnvelope(profile: IProfile | null | undefined, envelope: IEnvelope): boolean

envelope.userCanSignNow

Returns true if the user can act.

userCanSignNow(profile: IProfile | null | undefined, envelope: IEnvelope): boolean | undefined

envelope.userIsEnvelopeOwner

Check to see if the user owns the envelope.

userIsEnvelopeOwner(profile: IProfile | null | undefined, envelope: IEnvelope): boolean

envelope.userIsEnvelopeRecipient

Check to see if the user is a recipient within the envelope.

userIsEnvelopeRecipient(profile: IProfile | null | undefined, envelope: IEnvelope): boolean

envelope.canAccessEnvelope

Check to see if the profile ID is the envelope's sender or one of the recipients.

Not yet available for Python.

envelope.envelopeIsActive

Check to see if the envelope has pending actions.

Not yet available for Python.

envelope.envelopeIsComplete

Check to see if the envelope has been completed.

Not yet available for Python.

envelope.getMyRecipient

Regardless of if the session is `user` or `signer`, returns the envelope's recipient that matches the user's session.

Not yet available for Python.

envelope.getNextRecipient

Not yet available for Python.

envelope.getRecipient

Get a recipient from an envelope via an email match.

Not yet available for Python.

envelope.getRecipientsWithActions

Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).

Not yet available for Python.

envelope.getRecipientWithActions

Get a recipient that can act from an envelope via an email match.

Not yet available for Python.

envelope.isEnvelopeOwner

Check to see if the profile ID owns the envelope.

Not yet available for Python.

envelope.isEnvelopeRecipient

Check to see if the profile ID is a recipient within the envelope.

Not yet available for Python.

envelope.isFieldFilled

Not yet available for Python.

envelope.isFieldValid

Not yet available for Python.

envelope.recipientCanAct

Returns true if the recipient can act.

Not yet available for Python.

envelope.recipientHasAction

Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).

Not yet available for Python.

envelope.sortDocuments

Utility function to sort documents by their order, falling back to created_at. NOTE: This function mutates the input array.

Not yet available for Python.

envelope.sortFields

Utility function to sort fields by page, then by Y coordinate, then by X coordinate. NOTE: This function mutates the input array.

Not yet available for Python.

envelope.sortRecipients

Utility function to sort documents by their order, falling back to created_at. NOTE: This function mutates the input array.

Not yet available for Python.

envelope.useCanAccessEnvelope

Check to see if the profile ID is the envelope's sender or one of the recipients.

Not yet available for Python.

envelope.userCanAct

Returns true if the user can act.

Not yet available for Python.

envelope.userCanCancelEnvelope

Check to see if the user owns the envelope.

Not yet available for Python.

envelope.userCanFinishEnvelope

Check to see if the user owns the envelope.

Not yet available for Python.

envelope.userCanResetEnvelope

Check to see if the user can reset the envelope: they own it, and it either expired or has a recipient who failed authentication. This may be used to pre-determine if the envelope may be reset before calling `resetEnvelope`, e.g. to disable a "Reset" button.

Not yet available for Python.

envelope.userCanSignNow

Returns true if the user can act.

Not yet available for Python.

envelope.userIsEnvelopeOwner

Check to see if the user owns the envelope.

Not yet available for Python.

envelope.userIsEnvelopeRecipient

Check to see if the user is a recipient within the envelope.

Not yet available for Python.

envelope.canAccessEnvelope

Check to see if the profile ID is the envelope's sender or one of the recipients.

bool CanAccessEnvelope(string? profileId, Envelope envelope)

envelope.envelopeIsActive

Check to see if the envelope has pending actions.

bool EnvelopeIsActive(Envelope envelope)

envelope.envelopeIsComplete

Check to see if the envelope has been completed.

bool EnvelopeIsComplete(Envelope envelope)

envelope.getMyRecipient

Regardless of if the session is `user` or `signer`, returns the envelope's recipient that matches the user's session.

Recipient? GetMyRecipient(VerdocsSession? session, Envelope envelope)

envelope.getNextRecipient

Recipient? GetNextRecipient(Envelope envelope)

envelope.getRecipient

Get a recipient from an envelope via an email match.

Recipient? GetRecipient(string email, Envelope envelope)

envelope.getRecipientsWithActions

Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).

IReadOnlyList<Recipient> GetRecipientsWithActions(Envelope envelope)

envelope.getRecipientWithActions

Get a recipient that can act from an envelope via an email match.

bool GetRecipientWithActions(string email, Envelope envelope)

envelope.isEnvelopeOwner

Check to see if the profile ID owns the envelope.

bool IsEnvelopeOwner(string? profileId, Envelope envelope)

envelope.isEnvelopeRecipient

Check to see if the profile ID is a recipient within the envelope.

bool IsEnvelopeRecipient(string? profileId, Envelope envelope)

envelope.isFieldFilled

bool IsFieldFilled(EnvelopeField field, IReadOnlyList<EnvelopeField> allRecipientFields)

envelope.isFieldValid

bool IsFieldValid(EnvelopeField field, IReadOnlyList<EnvelopeField> allRecipientFields)

envelope.recipientCanAct

Returns true if the recipient can act.

bool RecipientCanAct(Recipient recipient, IReadOnlyList<Recipient> recipientsWithActions)

envelope.recipientHasAction

Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).

bool RecipientHasAction(Recipient recipient)

envelope.sortDocuments

Utility function to sort documents by their order, falling back to created_at. NOTE: This function mutates the input array.

List<EnvelopeDocument> SortDocuments(List<EnvelopeDocument> documents)

envelope.sortFields

Utility function to sort fields by page, then by Y coordinate, then by X coordinate. NOTE: This function mutates the input array.

List<EnvelopeField> SortFields(List<EnvelopeField> fields)

envelope.sortRecipients

Utility function to sort documents by their order, falling back to created_at. NOTE: This function mutates the input array.

List<Recipient>? SortRecipients(List<Recipient>? recipients)

envelope.useCanAccessEnvelope

Check to see if the profile ID is the envelope's sender or one of the recipients.

Not yet available for C#.

envelope.userCanAct

Returns true if the user can act.

bool UserCanAct(string email, IReadOnlyList<Recipient> recipientsWithActions)

envelope.userCanCancelEnvelope

Check to see if the user owns the envelope.

bool UserCanCancelEnvelope(Profile? profile, Envelope envelope)

envelope.userCanFinishEnvelope

Check to see if the user owns the envelope.

bool UserCanFinishEnvelope(Profile? profile, Envelope envelope)

envelope.userCanResetEnvelope

Check to see if the user can reset the envelope: they own it, and it either expired or has a recipient who failed authentication. This may be used to pre-determine if the envelope may be reset before calling `resetEnvelope`, e.g. to disable a "Reset" button.

Not yet available for C#.

envelope.userCanSignNow

Returns true if the user can act.

bool UserCanSignNow(Profile? profile, Envelope envelope)

envelope.userIsEnvelopeOwner

Check to see if the user owns the envelope.

bool UserIsEnvelopeOwner(Profile? profile, Envelope envelope)

envelope.userIsEnvelopeRecipient

Check to see if the user is a recipient within the envelope.

bool UserIsEnvelopeRecipient(Profile? profile, Envelope envelope)

field.blobToBase64

blobToBase64(image: Blob): Promise<unknown>

field.getRLeft

getRLeft(x: number, ratio: number): number

field.getRTop

getRTop(y: number, fieldHeight: number, iTextHeight: number, yRatio: number): number

field.getRValue

getRValue(y: number, ratio: number): number

field.rescale

rescale(r: number, n: number): number

field.blobToBase64

Not yet available for Python.

field.getRLeft

Not yet available for Python.

field.getRTop

Not yet available for Python.

field.getRValue

Not yet available for Python.

field.rescale

Not yet available for Python.

field.blobToBase64

Not yet available for C#.

field.getRLeft

Not yet available for C#.

field.getRTop

Not yet available for C#.

field.getRValue

Not yet available for C#.

field.rescale

Not yet available for C#.

fieldUtil.getRTop

Returns the rendered top offset for a field. Flips the y axis: PDF y grows upward from the page bottom, screen y grows downward from the top.

Not yet available for Node.js.

fieldUtil.getRLeft

Returns the rendered left offset for a field: its PDF x scaled to pixels.

Not yet available for Node.js.

fieldUtil.getRValue

Returns a document-space value scaled to rendered pixels.

Not yet available for Node.js.

fieldUtil.rescale

Returns a value scaled by a ratio.

Not yet available for Node.js.

fieldUtil.blobToBase64

Encodes raw bytes as a base64 string. Adapted from the js-sdk's blobToBase64, which reads a browser Blob through FileReader and resolves a data URL. A byte array carries no MIME type, so this returns the bare base64 payload; use BytesToDataUrl when the "data:<type>;base64," prefix is needed.

Not yet available for Node.js.

fieldUtil.getRTop

Returns the rendered top offset for a field. Flips the y axis: PDF y grows upward from the page bottom, screen y grows downward from the top.

Not yet available for Python.

fieldUtil.getRLeft

Returns the rendered left offset for a field: its PDF x scaled to pixels.

Not yet available for Python.

fieldUtil.getRValue

Returns a document-space value scaled to rendered pixels.

Not yet available for Python.

fieldUtil.rescale

Returns a value scaled by a ratio.

Not yet available for Python.

fieldUtil.blobToBase64

Encodes raw bytes as a base64 string. Adapted from the js-sdk's blobToBase64, which reads a browser Blob through FileReader and resolves a data URL. A byte array carries no MIME type, so this returns the bare base64 payload; use BytesToDataUrl when the "data:<type>;base64," prefix is needed.

Not yet available for Python.

fieldUtil.getRTop

Returns the rendered top offset for a field. Flips the y axis: PDF y grows upward from the page bottom, screen y grows downward from the top.

double GetRTop(double y, double fieldHeight, double iTextHeight, double yRatio)

fieldUtil.getRLeft

Returns the rendered left offset for a field: its PDF x scaled to pixels.

double GetRLeft(double x, double ratio)

fieldUtil.getRValue

Returns a document-space value scaled to rendered pixels.

double GetRValue(double y, double ratio)

fieldUtil.rescale

Returns a value scaled by a ratio.

double Rescale(double r, double n)

fieldUtil.blobToBase64

Encodes raw bytes as a base64 string. Adapted from the js-sdk's blobToBase64, which reads a browser Blob through FileReader and resolves a data URL. A byte array carries no MIME type, so this returns the bare base64 payload; use BytesToDataUrl when the "data:<type>;base64," prefix is needed.

string BytesToBase64(byte[] data)

file.downloadBlob

Trigger a download dialog to save a blob as a file on disk.

downloadBlob(blob: Blob, name: string = 'file.pdf'): void

file.fileToDataUrl

Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"

fileToDataUrl(file: File): Promise<IFileWithData>

file.downloadBlob

Trigger a download dialog to save a blob as a file on disk.

Not yet available for Python.

file.fileToDataUrl

Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"

bytes_to_data_url(data: bytes, content_type: str) -> str

file.downloadBlob

Trigger a download dialog to save a blob as a file on disk.

Not yet available for C#.

file.fileToDataUrl

Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"

string BytesToDataUrl(byte[] data, string contentType)

locale.getCountryByCode

getCountryByCode(code: string): ICountry | null

locale.getMatchingCountry

getMatchingCountry(code: string, substrings: number): number

locale.getPlusOneCountry

getPlusOneCountry(code: string): ICountry | null

locale.isAmericanSamoa

isAmericanSamoa(code: string): boolean

locale.isCanada

isCanada(code: string): boolean

locale.isDominicanRepublic

isDominicanRepublic(code: string): boolean

locale.isFrenchGuiana

isFrenchGuiana(code: string): boolean

locale.isGuadeloupe

isGuadeloupe(code: string): boolean

locale.isMartinique

isMartinique(code: string): boolean

locale.isMayotte

isMayotte(code: string): boolean

locale.isPuertoRico

isPuertoRico(code: string): boolean

locale.getCountryByCode

Not yet available for Python.

locale.getMatchingCountry

Not yet available for Python.

locale.getPlusOneCountry

Not yet available for Python.

locale.isAmericanSamoa

Not yet available for Python.

locale.isCanada

Not yet available for Python.

locale.isDominicanRepublic

Not yet available for Python.

locale.isFrenchGuiana

Not yet available for Python.

locale.isGuadeloupe

Not yet available for Python.

locale.isMartinique

Not yet available for Python.

locale.isMayotte

Not yet available for Python.

locale.isPuertoRico

Not yet available for Python.

locale.getCountryByCode

Country? GetCountryByCode(string code)

locale.getMatchingCountry

int GetMatchingCountry(string code, int substrings)

locale.getPlusOneCountry

Country? GetPlusOneCountry(string code)

locale.isAmericanSamoa

bool IsAmericanSamoa(string code)

locale.isCanada

bool IsCanada(string code)

locale.isDominicanRepublic

bool IsDominicanRepublic(string code)

locale.isFrenchGuiana

bool IsFrenchGuiana(string code)

locale.isGuadeloupe

bool IsGuadeloupe(string code)

locale.isMartinique

bool IsMartinique(string code)

locale.isMayotte

bool IsMayotte(string code)

locale.isPuertoRico

bool IsPuertoRico(string code)

permission.userHasPermissions

Confirm whether the user has all of the specified permissions, resolving the profile's direct permissions, the permissions granted by its roles, and any group profiles.

userHasPermissions(profile: IProfile | null | undefined, permissions: TPermission[]): boolean

permission.userHasPermissions

Confirm whether the user has all of the specified permissions, resolving the profile's direct permissions, the permissions granted by its roles, and any group profiles.

user_has_permissions(profile: Profile | None, permissions: list[Permission]) -> bool

permission.userHasPermissions

Confirm whether the user has all of the specified permissions, resolving the profile's direct permissions, the permissions granted by its roles, and any group profiles.

bool UserHasPermissions(Profile? profile, IEnumerable<string> permissions)

primitive.formatFullName

Format a profile's full name

formatFullName(source?: object | null): string

primitive.formatInitials

Format a profile's initials

formatInitials(profile?: IProfile): string

primitive.fullNameToInitials

Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".

fullNameToInitials(name: string): string

primitive.integerSequence

Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful in rendering operations when there is no source array to .map() across.

integerSequence(start: number, count: number): number[]

primitive.formatFullName

Format a profile's full name

format_full_name(source: Any = None) -> str

primitive.formatInitials

Format a profile's initials

format_initials(profile: Any = None) -> str

primitive.fullNameToInitials

Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".

full_name_to_initials(name: str) -> str

primitive.integerSequence

Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful in rendering operations when there is no source array to .map() across.

integer_sequence(start: int, count: int) -> list[int]

primitive.formatFullName

Format a profile's full name

string FormatFullName(string? firstName, string? lastName)

primitive.formatInitials

Format a profile's initials

string FormatInitials(Profile? profile)

primitive.fullNameToInitials

Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".

string FullNameToInitials(string name)

primitive.integerSequence

Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful in rendering operations when there is no source array to .map() across.

IReadOnlyList<int> IntegerSequence(int start, int count)

string.capitalize

Capitalize the first letter of a string.

capitalize(str: string): string

string.convertToE164

Convert a phone-number-like string to E164 format.

convertToE164(input: string): string

string.randomString

randomString(length: number): string

string.capitalize

Capitalize the first letter of a string.

capitalize(value: str) -> str

string.convertToE164

Convert a phone-number-like string to E164 format.

convert_to_e164(value: str | None) -> str

string.randomString

random_string(length: int) -> str

string.capitalize

Capitalize the first letter of a string.

string Capitalize(string value)

string.convertToE164

Convert a phone-number-like string to E164 format.

string ConvertToE164(string? input)

string.randomString

string RandomString(int length)

template.canPerformTemplateAction

canPerformTemplateAction(profile: IProfile | null | undefined, action: TTemplateAction, template?: ITemplate): object

template.getFieldsForRole

getFieldsForRole(template: ITemplate, role_name: string): ITemplateField[]

template.hasRequiredPermissions

hasRequiredPermissions(profile: IProfile | null | undefined, permissions: TPermission[]): boolean

template.userCanBuildTemplate

Check to see if the user can "build" the template (use the field builder). The user must have write access to the template, and the template must have at least one signer role.

userCanBuildTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userCanChangeOrgVisibility

Check to see if the user can change whether a template is personal vs org-shared.

userCanChangeOrgVisibility(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userCanCreateOrgTemplate

Check to see if the user can create an org-shared template.

userCanCreateOrgTemplate(profile: IProfile | null | undefined): boolean

template.userCanCreatePersonalTemplate

Check to see if the user can create a personal/private template.

userCanCreatePersonalTemplate(profile: IProfile | null | undefined): boolean

template.userCanCreatePublicTemplate

Check to see if the user can create a public template.

userCanCreatePublicTemplate(profile: IProfile | null | undefined): boolean

template.userCanCreateTemplate

Confirm whether the user can create a new template.

userCanCreateTemplate(profile: IProfile | null | undefined): boolean

template.userCanDeleteTemplate

Check to see if the user can change whether a template is personal vs org-shared.

userCanDeleteTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean

template.userCanMakeTemplatePrivate

Check to see if the user can change whether a template is personal vs org-shared.

userCanMakeTemplatePrivate(profile: IProfile | null | undefined, template: ITemplate): boolean

template.userCanMakeTemplatePublic

Check to see if the user can change whether a template is personal vs org-shared.

userCanMakeTemplatePublic(profile: IProfile | null | undefined, template: ITemplate): boolean

template.userCanMakeTemplateShared

Check to see if the user can change whether a template is personal vs org-shared.

userCanMakeTemplateShared(profile: IProfile | null | undefined, template: ITemplate): boolean

template.userCanPreviewTemplate

Check to see if the user can preview the template. The user must have read access to the template, the template must have at least one signer, and every signer must have at least one field.

userCanPreviewTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userCanReadTemplate

Check to see if the user can read/view a template.

userCanReadTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userCanSendTemplate

Confirm whether the user can create an envelope using the specified template.

userCanSendTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userCanUpdateTemplate

Check to see if the user can update a tempate.

userCanUpdateTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userHasSharedTemplate

Check to see if a template is "shared" with the user.

userHasSharedTemplate(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.userIsTemplateCreator

Check to see if the user created the template.

userIsTemplateCreator(profile: IProfile | null | undefined, template: ITemplate): boolean | null | undefined

template.canPerformTemplateAction

Not yet available for Python.

template.getFieldsForRole

Not yet available for Python.

template.hasRequiredPermissions

Not yet available for Python.

template.userCanBuildTemplate

Check to see if the user can "build" the template (use the field builder). The user must have write access to the template, and the template must have at least one signer role.

Not yet available for Python.

template.userCanChangeOrgVisibility

Check to see if the user can change whether a template is personal vs org-shared.

Not yet available for Python.

template.userCanCreateOrgTemplate

Check to see if the user can create an org-shared template.

Not yet available for Python.

template.userCanCreatePersonalTemplate

Check to see if the user can create a personal/private template.

Not yet available for Python.

template.userCanCreatePublicTemplate

Check to see if the user can create a public template.

Not yet available for Python.

template.userCanCreateTemplate

Confirm whether the user can create a new template.

Not yet available for Python.

template.userCanDeleteTemplate

Check to see if the user can change whether a template is personal vs org-shared.

Not yet available for Python.

template.userCanMakeTemplatePrivate

Check to see if the user can change whether a template is personal vs org-shared.

Not yet available for Python.

template.userCanMakeTemplatePublic

Check to see if the user can change whether a template is personal vs org-shared.

Not yet available for Python.

template.userCanMakeTemplateShared

Check to see if the user can change whether a template is personal vs org-shared.

Not yet available for Python.

template.userCanPreviewTemplate

Check to see if the user can preview the template. The user must have read access to the template, the template must have at least one signer, and every signer must have at least one field.

Not yet available for Python.

template.userCanReadTemplate

Check to see if the user can read/view a template.

Not yet available for Python.

template.userCanSendTemplate

Confirm whether the user can create an envelope using the specified template.

Not yet available for Python.

template.userCanUpdateTemplate

Check to see if the user can update a tempate.

Not yet available for Python.

template.userHasSharedTemplate

Check to see if a template is "shared" with the user.

Not yet available for Python.

template.userIsTemplateCreator

Check to see if the user created the template.

Not yet available for Python.

template.canPerformTemplateAction

ValueTuple<bool, string> CanPerformTemplateAction(Profile? profile, string action, Template? template = null)

template.getFieldsForRole

IReadOnlyList<TemplateField> GetFieldsForRole(Template template, string roleName)

template.hasRequiredPermissions

bool HasRequiredPermissions(Profile? profile, IEnumerable<string> permissions)

template.userCanBuildTemplate

Check to see if the user can "build" the template (use the field builder). The user must have write access to the template, and the template must have at least one signer role.

bool UserCanBuildTemplate(Profile? profile, Template template)

template.userCanChangeOrgVisibility

Check to see if the user can change whether a template is personal vs org-shared.

bool UserCanChangeOrgVisibility(Profile? profile, Template template)

template.userCanCreateOrgTemplate

Check to see if the user can create an org-shared template.

bool UserCanCreateOrgTemplate(Profile? profile)

template.userCanCreatePersonalTemplate

Check to see if the user can create a personal/private template.

bool UserCanCreatePersonalTemplate(Profile? profile)

template.userCanCreatePublicTemplate

Check to see if the user can create a public template.

bool UserCanCreatePublicTemplate(Profile? profile)

template.userCanCreateTemplate

Confirm whether the user can create a new template.

bool UserCanCreateTemplate(Profile? profile)

template.userCanDeleteTemplate

Check to see if the user can change whether a template is personal vs org-shared.

bool UserCanDeleteTemplate(Profile? profile, Template template)

template.userCanMakeTemplatePrivate

Check to see if the user can change whether a template is personal vs org-shared.

bool UserCanMakeTemplatePrivate(Profile? profile, Template template)

template.userCanMakeTemplatePublic

Check to see if the user can change whether a template is personal vs org-shared.

bool UserCanMakeTemplatePublic(Profile? profile, Template template)

template.userCanMakeTemplateShared

Check to see if the user can change whether a template is personal vs org-shared.

bool UserCanMakeTemplateShared(Profile? profile, Template template)

template.userCanPreviewTemplate

Check to see if the user can preview the template. The user must have read access to the template, the template must have at least one signer, and every signer must have at least one field.

bool UserCanPreviewTemplate(Profile? profile, Template template)

template.userCanReadTemplate

Check to see if the user can read/view a template.

bool UserCanReadTemplate(Profile? profile, Template template)

template.userCanSendTemplate

Confirm whether the user can create an envelope using the specified template.

bool UserCanSendTemplate(Profile? profile, Template template)

template.userCanUpdateTemplate

Check to see if the user can update a tempate.

bool UserCanUpdateTemplate(Profile? profile, Template template)

template.userHasSharedTemplate

Check to see if a template is "shared" with the user.

bool UserHasSharedTemplate(Profile? profile, Template? template)

template.userIsTemplateCreator

Check to see if the user created the template.

bool UserIsTemplateCreator(Profile? profile, Template? template)

token.AtoB

Simplified, Node/Browser-safe alternative to atob() for base64 decoding. Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js

AtoB(str: string): string

token.decodeAccessTokenBody

Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g. `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing will be removed. Note that user and signing sessions have different access token formats. The calling application should distinguish between the two based on the context of the authenticated session, or by the presence of the `document_id` field, which will only be present for signing sessions.

decodeAccessTokenBody(token: string): TSession

token.decodeJWTBody

Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.

decodeJWTBody(token: string): any

token.AtoB

Simplified, Node/Browser-safe alternative to atob() for base64 decoding. Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js

Not yet available for Python.

token.decodeAccessTokenBody

Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g. `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing will be removed. Note that user and signing sessions have different access token formats. The calling application should distinguish between the two based on the context of the authenticated session, or by the presence of the `document_id` field, which will only be present for signing sessions.

decode_access_token_body(token: str | None) -> dict[str, Any] | None

token.decodeJWTBody

Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.

decode_jwt_body(token: str | None) -> Any

token.AtoB

Simplified, Node/Browser-safe alternative to atob() for base64 decoding. Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js

Not yet available for C#.

token.decodeAccessTokenBody

Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g. `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing will be removed. Note that user and signing sessions have different access token formats. The calling application should distinguish between the two based on the context of the authenticated session, or by the presence of the `document_id` field, which will only be present for signing sessions.

VerdocsSession? DecodeAccessTokenBody(string? token)

token.decodeJWTBody

Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.

JsonElement DecodeJwtBody(string? token)

validator.getValidators

Get a list of available validators for field inputs. Note that validators always check strings, because that is all a user can enter in an HTML input field. Numeric-format validators should perform any necessary conversions internally. Validators never throw - they just return a boolean. indicating whether the value is valid.

getValidators(): string[]

validator.isValidEmail

Check whether a string is a validly-formatted email address.

isValidEmail(email: string | undefined): boolean

validator.isValidInput

isValidInput(value: string, validator: string): boolean

validator.isValidPhone

Check whether a string looks like a valid phone number, in domestic or international format.

isValidPhone(phone: string | undefined): boolean

validator.isValidRoleName

isValidRoleName(value: string, roles: IRole[]): boolean

validator.isValidTag

isValidTag(value: string, tags: string[]): boolean

validator.getValidators

Get a list of available validators for field inputs. Note that validators always check strings, because that is all a user can enter in an HTML input field. Numeric-format validators should perform any necessary conversions internally. Validators never throw - they just return a boolean. indicating whether the value is valid.

get_validators() -> list[str]

validator.isValidEmail

Check whether a string is a validly-formatted email address.

is_valid_email(email: str | None) -> bool

validator.isValidInput

is_valid_input(value: str, validator: str) -> bool

validator.isValidPhone

Check whether a string looks like a valid phone number, in domestic or international format.

is_valid_phone(phone: str | None) -> bool

validator.isValidRoleName

is_valid_role_name(value: str, roles: list[Role]) -> bool

validator.isValidTag

is_valid_tag(value: str, tags: list[str]) -> bool

validator.getValidators

Get a list of available validators for field inputs. Note that validators always check strings, because that is all a user can enter in an HTML input field. Numeric-format validators should perform any necessary conversions internally. Validators never throw - they just return a boolean. indicating whether the value is valid.

IReadOnlyList<string> GetValidators()

validator.isValidEmail

Check whether a string is a validly-formatted email address.

bool IsValidEmail(string? email)

validator.isValidInput

bool IsValidInput(string value, string validator)

validator.isValidPhone

Check whether a string looks like a valid phone number, in domestic or international format.

bool IsValidPhone(string? phone)

validator.isValidRoleName

bool IsValidRoleName(string value, IEnumerable<Role> roles)

validator.isValidTag

bool IsValidTag(string value, IEnumerable<string> tags)