compliance
esign
business
customer-session

Read the business's e-signature enrollment (business)

Changed on

Reports whether the caller accepts their business's MSA by e-signature — the business is enrolled and its allow-list, when it has one, names the caller — the provider this deployment uses, and how the embedded signing page reports progress (protocol and the only allowed message origin). A caller who is not enrolled reads enrolled:false and accepts by click-through. While e-signature is paused on this deployment, an enrolled caller also reads enrolled:false and accepts by click-through, unless a signature request holds the current MSA document named by document_id (or, without document_id, any current MSA document of their business): they keep signing that document by e-signature until the request ends. A document_id that is not one of the business's MSA documents is then 404 document_not_found, as accepting it is. A caller who signs by e-signature while it is not running on this deployment gets 503 — never enrolled:false, because click-through acceptance is refused for them. custody_contracts_enrolled says whether the caller signs their business's custody contracts by e-signature, in which case signing one by click-through is refused (409 esign_required).

get/compliance/esign/enrollment

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/enrollment
  • Auth
    none declared

Query parameters

document_idstring nullable

The MSA document the business page shows (doc_...). It matters only while e-signature is paused, for a caller who would otherwise sign by e-signature. That caller then reads enrolled:true only while this document is current and unaccepted and a signature request holds it, which is when click-through acceptance of it is refused for e-signature. A document that is not one of the business's MSA documents is then 404 document_not_found, as accepting it is. Without document_id, a request holding any current MSA document of the business counts.

Response

OK

custody_contracts_enrolledboolean required
enrolledboolean required
providerstring required

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 required property to the response with the status