POST /api/v2/invitations — Send Invitation V2
Version 2 of the Send Invitation API. Unlike previous versions, this endpoint does not send notifications via email or SMS. Instead, it returns the signing link directly in the API response, allowing clients to handle notification delivery and user communication through their own channels.
Authentication
SadqAuthorize
Request Headers
- Authorization (required)
- Bearer {token}
- Content-Type (required)
- application/json
Request Body
Content-Type: application/json
- documentId (GUID, required)
- The unique identifier of the document to be signed.
- destinations (array, required)
- Array of destination objects (same as Send Invitation V1 ).
- invitationMessage (string, optional)
- Custom message included in the invitation email.
- invitationSubject (string, optional)
- Subject line for the invitation email.
{
"documentId": "",
"destinations": [
{
"destinationName": "",
"destinationEmail": "",
"destinationPhoneNumber": "",
"signeOrder": 0,
"ConsentOnly": true,
"destinationType": 1,
"signatories": [],
"availableTo": "",
"allowUserToSignAnyWhere": false,
"authenticationType": 7,
"invitationLanguage": 1,
"redirectUrl": "",
"allowUserToAddDestination": false
}
],
"invitationMessage": "Dear User, please sign the document attached below.",
"invitationSubject": "Document Signature Request"
}Responses
HTTP 200 — Invitation sent
{
"data": [
{
"id": "",
"subject": "",
"message": "",
"name": "",
"nationalId": null,
"signeOrder": 0,
"destinationType": 1,
"authenticationType": 7,
"destinationPhone": "",
"destination": "",
"fileId": "a",
"status": 1,
"userHost": "",
"invitationLink": "",
"invitationLanguage": 0
}
],
"errorCode": 0,
"message": null,
"returnUrl": "",
"stateValidationErrors": null,
"signature": ""
}