STstablesea
compliance
esign
business
customer-session

Read one e-signature envelope (business)

Changed on

Returns one of the caller's business's envelopes, reconciling it with the provider first when it is due. Verification digests are present once executed. Another business's envelope and a nonexistent id answer the same 404 (document_not_found).

get/compliance/esign/envelopes/{id}

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/{id}
  • Auth
    none declared

Path parameters

idstring 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

  • e003c8a67b62Revision 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

  • 9c05d53541bbRevision changes
    • warning

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

    • info

      added the optional property to the response with the status