Skip to main content
POST
Generate signature request

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

brokerageFirmId
string
required

the brokerageFirm id

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

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