Batch Signature

Last review: 2022-06-14

GET a web signature page for signing a block of documents with a single method.

Group requests

Get list of request with status WAITING_CLIENT_SIGNATURE for a {userCode} or {recipient}.

• SERVICE: {urlbase}/documents/api/v3/messages/batchLink
• METHOD: POST
• CONTENT/APPLICATION: JSON

{
  "userCode":"string",
  "groupCode":"string",
  "otpRecipient": "strint",
  "index": 0,
  "max": 0,
  "signType": "string",
  "redirectURL": "string"
}

Where:

• userCode (required): userCode or recipient for signing
• groupCode (required): groupCode
• otpRecipient (optional): email or mobile where the OTP will sent
• index (optional): signature page index
• max (optional): max documents to be signed
• signType (optional): signing method allowed (FORTRESS, OTP_SMS, CLIENT) (null for allow all of them, in this case, the end user will choose the option)
• redirectURL (optional): redirect URL after signing

Example:

{
  "userCode":"[email protected]",
  "groupCode":"group001",
  "otpRecipient": "[email protected]",
  "index": 0,
  "max": 5,
  "signType": "string"
}

Response

• RESPONSE: 200 HTTP status code 200/OK
• RRESPONSE CONTENT TYPE: application/json

{
  "code": "string",
  "link": "string"
}

• code: unique request code
• link: link for signing

Error responses

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }