Skip to main content

Send Signing Document — Group Mode

Send a PDF document to multiple signing groups. Each group has its own signing mode, outcome scope, and recipients. Groups are processed in order.

Endpoint

POST /api/sendSigningDoc

Same endpoint as Send Signing Document — group mode is activated by setting signing_mode = group.

https://sandbox-services-sign.mobileid.dj/api/sendSigningDoc

Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_SIGN_AUTH_TOKEN (from Get Auth Token)
OReferenceYesUUID identifying your organization
WebMobileIDAuthorizationYesStatic API key assigned to your organization

Body (multipart/form-data)

Document Information

FieldTypeRequiredDescription
document_titlestringYesTitle of the document
subjectstringYesSubject or objective
sender_email_idstringNoSender's email
sender_ninstringYesNNI of the sender
sender_namestringYesFull name of the sender
documentfileYesPDF file to be signed

Group Mode Configuration

FieldValue
signing_modeMust be group
document_outcome_scopeMust be group_required
signdoc_validityDays available for signing
signeddoc_validityDays signed doc is accessible

Group Fields

For each group G (starting at 0):

FieldTypeDescription
signing_groups[G][name]stringDisplay name of the group
signing_groups[G][mode]stringsequential or parallel
signing_groups[G][outcome_scope]stringall_required, majority, or any
signing_groups[G][order]integerProcessing order (groups run sequentially)

Recipient Fields

For each recipient N in group G:

FieldTypeDescription
signing_groups[G][recipients][N][signer_type]stringindividual or org_rep
signing_groups[G][recipients][N][name]stringFull name
signing_groups[G][recipients][N][email]stringEmail (optional)
signing_groups[G][recipients][N][phone]stringPhone (optional)
signing_groups[G][recipients][N][order]integerOrder within the group
signing_groups[G][recipients][N][mcode_or_name]stringRequired if signer_type is org_rep

Example: Two Groups

POST /api/sendSigningDoc HTTP/1.1
Host: sandbox-services-sign.mobileid.dj
Authorization: Bearer YOUR_SIGN_AUTH_TOKEN
OReference: YOUR_ORGANIZATION_REFERENCE_UUID
WebMobileIDAuthorization: YOUR_WEB_MOBILEID_AUTHORIZATION_KEY
Content-Type: multipart/form-data

document_title = Annual Report Sign-Off
subject = Please sign the annual report
sender_nin = YOUR_SENDER_NIN
sender_name = YOUR_SENDER_NAME
signing_mode = group
document_outcome_scope = group_required
signdoc_validity = 20
signeddoc_validity = 10

signing_groups[0][name] = HR Team
signing_groups[0][mode] = parallel
signing_groups[0][outcome_scope] = all_required
signing_groups[0][order] = 1
signing_groups[0][recipients][0][signer_type] = individual
signing_groups[0][recipients][0][name] = HR MEMBER ONE
signing_groups[0][recipients][0][order] = 1
signing_groups[0][recipients][1][signer_type] = org_rep
signing_groups[0][recipients][1][mcode_or_name] = YOUR_ORG_MEMBER_CODE
signing_groups[0][recipients][1][name] = HR MEMBER TWO
signing_groups[0][recipients][1][order] = 1

signing_groups[1][name] = Legal Team
signing_groups[1][mode] = sequential
signing_groups[1][outcome_scope] = any
signing_groups[1][order] = 2
signing_groups[1][recipients][0][signer_type] = individual
signing_groups[1][recipients][0][name] = LEGAL MEMBER ONE
signing_groups[1][recipients][0][order] = 1
signing_groups[1][recipients][1][signer_type] = org_rep
signing_groups[1][recipients][1][mcode_or_name] = YOUR_ORG_MEMBER_CODE
signing_groups[1][recipients][1][name] = LEGAL MEMBER TWO
signing_groups[1][recipients][1][order] = 2

document = <PDF file>

Notes

  • Groups are processed in order sequence — Group 1 completes before Group 2 begins.
  • document_outcome_scope = group_required means all groups must satisfy their outcome_scope.