Skip to main content
POST
/
policies
/
{policyId}
/
signature
Generate signature request for a policy.
curl --request POST \
  --url https://api.example.com/policies/{policyId}/signature \
  --header 'Content-Type: application/json' \
  --data '
{
  "neededForPolicySigned": true,
  "isOtp": true,
  "phoneNumber": "<string>"
}
'
{
  "signatures": [
    {
      "id": "<string>",
      "signers": [
        {
          "customerId": "<string>",
          "url": "<string>"
        }
      ]
    }
  ]
}

Path Parameters

​
policyId
string
required

the policy id

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
branchId
string

Optional: the branchId

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