compliance
esign
business
customer-session

Start or resume signing an agreement (business)

Changed on

Composes (or resumes) the calling member's e-signature envelope and returns it, plus a one-time embedded signing session when one can be issued. With purpose msa it signs the business's live MSA document named by document_id. With purpose custody_contract it signs the custody contract named by contract_type; the platform resolves the contract's document itself, so document_id must be absent. A request whose fields do not match its purpose, including an msa request without document_id, answers 400 esign_purpose_invalid with param naming the field. Requires e-sign enrollment (400 esign_not_enrolled, which is also the answer for custody_contract wherever custody contracts are not signed by e-signature), and the signer's authority attestation and title (400 esign_authority_attestation_required). An envelope another member started answers 409 esign_signer_conflict without a session; resuming the caller's own envelope with a title other than the one already placed on its document answers 409 esign_title_conflict; a document the caller cannot address answers 404 document_not_found; an agreement that changed while signing was starting, or a custody contract the business already signed, answers 409 esign_source_changed; a new envelope while this month's envelope count is at or above the platform's hard cap answers 409 esign_envelope_cap_reached (nothing is created or sent; resuming an envelope already started is not refused); a paused deployment answers 503, and an enrolled business on a deployment where e-signature is unavailable answers 503.

post/compliance/esign/envelopes

Request

  • Base URL
    https://api.stablesea.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.stablesea.com/compliance/esign/envelopes
  • Auth
    none declared

Request body

authority_attestationboolean required
contract_type'custody_sa' | 'trade_sa'

A custody contract: custody_sa (the custodial services agreement) or trade_sa (the electronic trading agreement). On an envelope it names the contract a custody_contract envelope signs, and is absent when purpose is msa. On a create it is required when purpose is custody_contract and must be absent when purpose is msa.

document_idstring
purpose'msa' | 'custody_contract' required
titlestring required

Response

OK

contract_type'custody_sa' | 'trade_sa'

A custody contract: custody_sa (the custodial services agreement) or trade_sa (the electronic trading agreement). On an envelope it names the contract a custody_contract envelope signs, and is absent when purpose is msa. On a create it is required when purpose is custody_contract and must be absent when purpose is msa.

created_tsstring date-time required
executed_tsstring date-time nullable
idstring required
providerstring required
purpose'msa' | 'custody_contract' required
status'preparing' | 'awaiting_signatures' | 'partially_signed' | 'archiving' | 'needs_repair' | 'executed' | 'declined' | 'expired' | 'voided' | 'failed' required

Lifecycle of the envelope. preparing: being sent to the provider. awaiting_signatures: out for signature. archiving: signed; the executed copy and evidence are being stored. needs_repair: signed or sent, waiting on an operator; the signature stands. executed: signed and durably stored; the agreement it signs is accepted. declined/expired/voided/failed: ended without a signature; start a new envelope.

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • warning

      added the new custody_contract enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the new custody_contract enum value to the request property

    • info

      added the optional property to the response with the status