Skip to main content
POST
Generate a signature request for a policy

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

policyId
string
required

the policy id

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

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

branchId
string

Optional: the branchId

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

Body

application/json
deliveryMode
enum<string>
required

the delivery mode

Available options:
EMAIL,
URL
neededForPolicySigned
boolean
default:true

Do we want to sign the documents needed for the policy to be signed? If yes, it signs all those documents at the same time.

isOtp
boolean

if the signature request is an otp one or not

phoneNumber
string

the phone number

Response

signatures
object[]
required

the signature requests