Signatures Module API

API reference for signature workflow helpers.

BriteCore v2 Signatures API endpoint wrappers.

This module provides wrappers for DocuSign authentication, configuration, signature retrieval, envelope recreation, and envelope status updates.

britecore_sdk.api.api_calls.v2.signatures.docusign_auth(action=None, **kwargs)[source]

Perform a DocuSign authentication action.

POST /api/v2/signatures/docusign_auth

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.docusign_config(data=None, **kwargs)[source]

Retrieve or update DocuSign configuration.

POST /api/v2/signatures/docusign_config

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.get_signatures(revision_id=None, **kwargs)[source]

Retrieve signature records for a revision.

POST /api/v2/signatures/get_signatures

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.recreate_envelope(revision_id=None, **kwargs)[source]

Recreate a DocuSign envelope for a revision.

POST /api/v2/signatures/recreate_envelope

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.update_signatures(envelope_id=None, signers=None, status=None, **kwargs)[source]

Update signature records for an envelope.

POST /api/v2/signatures/update_signatures

Parameters:

  • envelope_id (str | None)

  • signers (str | None)

  • status (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.void_envelope(envelope_id=None, revision_id=None, void_reason=None, **kwargs)[source]

Void a DocuSign envelope.

POST /api/v2/signatures/void_envelope

Parameters:

  • envelope_id (Any | None)

  • revision_id (Any | None)

  • void_reason (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.flush_cache(**kwargs)[source]

Flush Cache.

POST /api/v2/signatures/flush_cache

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.signatures.get_envelope(revision_id=None, envelope_id=None, **kwargs)[source]

Get Envelope.

POST /api/v2/signatures/get_envelope

Parameters:

  • revision_id (Any | None)

  • envelope_id (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any