POST api/v2/documentservice/create

Request Information

URI Parameters

None.

Body Parameters

CreateDocumentRequest
NameDescriptionTypeAdditional information
DocumentName

Naam van het document

 string

None.
Document

Base64 Document

 string

None.
Label1

Eerste parameter om de flowtemplate te bepalen. Deze bevat normaal de naam van de dienst of applicatie.

 string

None.
Label2

Tweede parameter om de flowtemplate te bepalen.

 string

None.
Label3

Derde parameter om de flowtemplate te bepalen.

 string

None.
Label4

Vierde parameter om de flowtemplate te bepalen.

 string

None.
Label5

Vijfde parameter om de flowtemplate te bepalen.

 string

None.
PackageId

Id van de package waaraan het document moet worden toegevoegd. Een document moet in een package zitten, ook al bestaat die package uit slechts een document.

 globally unique identifier

None.
CallBackUrl

Web URL welke wordt gebruikt om de status van het te tekenen document bij te houden, als geen URL is meegegeven word geen call back voorzien. (vb.http:\\[server]\callback).

 string

None.
ExternalReference

Referentie die enkel wordt gebruikt door de aanroepende applicatie, deze parameter wordt niet gebruikt in het Signer portaal.

 string

None.
ExpiryTimestamp

Datum wanneer document komt te vervallen

 date

None.
Initiator

Email adres, gekende gebruiker van het Signer web portaal. (Systeem-gebruiker per applicatie)

 string

None.
ExtraData

AD Login. Gebruikerslogin van de eindgebruiker.

 string

None.
AddMarkers

Optionele parameter die bepaalt of er al dan niet een extra pagina moet worden toegevoegd aan het document met markers voor ondertekening. Als deze parameter niet is meegegeven dan zal de service proberen te bepalen of er markers aanwezig zijn, en indien nodig een pagina met markers toevoegen. Als deze parameter op false staat moet het document zelf de correcte markers bevatten. Het is aangeraden om deze parameter op true te zetten indien het document geen markers bevat.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "documentName": "sample string 1",
  "document": "sample string 2",
  "label1": "sample string 3",
  "label2": "sample string 4",
  "label3": "sample string 5",
  "label4": "sample string 6",
  "label5": "sample string 7",
  "packageId": "b687cd4d-73ac-4493-8e49-808b57ade089",
  "callBackUrl": "sample string 9",
  "externalReference": "sample string 10",
  "expiryTimestamp": "2026-04-30T09:36:01.7655914+02:00",
  "initiator": "sample string 11",
  "extraData": "sample string 12",
  "addMarkers": true
}

text/plain

Sample: 
{"documentName":"sample string 1","document":"sample string 2","label1":"sample string 3","label2":"sample string 4","label3":"sample string 5","label4":"sample string 6","label5":"sample string 7","packageId":"b687cd4d-73ac-4493-8e49-808b57ade089","callBackUrl":"sample string 9","externalReference":"sample string 10","expiryTimestamp":"2026-04-30T09:36:01.7655914+02:00","initiator":"sample string 11","extraData":"sample string 12","addMarkers":true}

Response Information

Resource Description

CreateDocumentResponse
NameDescriptionTypeAdditional information
FlowId

Uniek ID voor de onderteken flow, gebruikt in alle volgende calls, om de onderteken flow te identificeren.

 globally unique identifier

None.
ExternalReference

Referentie meegegeven door de aanroepende applicatie, deze parameter wordt niet gebruikt door het webSigner portaal.

 string

None.
DownloadURL

Link om het document te downloaden.

 string

None.
F2FSigningURL

Link naar het “te ondertekenen” document.

 string

None.
EmailAddress

Email adres van de initiator, als interne referentie.

 string

None.
CreationTime

Datum en tijd dat de flow is aangemaakt.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "flowId": "c9516086-72bb-4138-887f-bd56ce3c4c56",
  "externalReference": "sample string 2",
  "downloadURL": "sample string 3",
  "f2FSigningURL": "sample string 4",
  "emailAddress": "sample string 5",
  "creationTime": "2026-04-30T09:36:01.7968381+02:00"
}

text/plain

Sample: 
{"flowId":"c9516086-72bb-4138-887f-bd56ce3c4c56","externalReference":"sample string 2","downloadURL":"sample string 3","f2FSigningURL":"sample string 4","emailAddress":"sample string 5","creationTime":"2026-04-30T09:36:01.7968381+02:00"}