Skip to main content

Send Signing Document

Send a PDF document to one or more recipients for electronic signing. Supports sequential, parallel, and individual signing modes.

Endpoint

POST /api/sendSigningDoc
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 of the signing request
sender_email_idstringNoSender's email address
sender_ninstringYesNNI of the sender
sender_namestringYesFull name of the sender
documentfileYesPDF file to be signed

Signing Configuration

FieldTypeRequiredDescription
signing_modestringYessequential, parallel, or individual
document_outcome_scopestringYesall_required, majority, or any
signdoc_validityintegerYesDays the document is available for signing
signeddoc_validityintegerYesDays the signed document is accessible after signing

Recipients

Recipients are specified within a single default group (signing_groups[0]). For multi-group workflows, see Send Signing Document — Group Mode.

FieldTypeDescription
signing_groups[0][recipients][N][signer_type]stringindividual or org_rep
signing_groups[0][recipients][N][name]stringFull name of the recipient
signing_groups[0][recipients][N][email]stringEmail address (optional)
signing_groups[0][recipients][N][phone]stringPhone number (optional)
signing_groups[0][recipients][N][order]integerSigning order (for sequential mode)
signing_groups[0][recipients][N][mcode_or_name]stringRequired if signer_type is org_rep

Replace N with 0, 1, 2... for each additional recipient.

signing_mode values

ValueDescription
sequentialRecipients sign one after another in order sequence
parallelAll recipients sign simultaneously
individualSingle recipient workflow

document_outcome_scope values

ValueDescription
all_requiredAll recipients must sign
majorityMore than half must sign
anyAt least one signature is sufficient

Example Request

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 = Contract Q2 2024
subject = Please review and sign the attached contract
sender_nin = YOUR_SENDER_NIN
sender_name = YOUR_SENDER_NAME
signing_mode = sequential
document_outcome_scope = all_required
signdoc_validity = 20
signeddoc_validity = 10

signing_groups[0][recipients][0][signer_type] = individual
signing_groups[0][recipients][0][name] = RECIPIENT 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] = RECIPIENT TWO
signing_groups[0][recipients][1][order] = 2

document = <PDF file>

Response

{
"document_id": "doc-uuid-xxxx",
"status": "sent"
}