Skip to main content
POST
/
brokerage-firms
/
{brokerageFirmId}
/
signature
Generate signature request
curl --request POST \
  --url https://api.example.com/brokerage-firms/{brokerageFirmId}/signature \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveryMode": "EMAIL"
}
'
{
  "signatures": [
    {
      "id": "<string>",
      "signers": [
        {
          "customerId": "<string>",
          "url": "<string>"
        }
      ]
    }
  ]
}

Path Parameters

​
brokerageFirmId
string
required

the brokerageFirm id

Body

application/json

Signature request payload

​
deliveryMode
enum<string>
required

The delivery mode of the signature request. An email sent to the signer or a URL for an embed signature.

Available options:
EMAIL,
URL

Response

Signature request generated successfully.

​
signatures
object[]
required

the signature requests