Description

Creates a new document to sign, and returns a document response object (including the generated document ID). Remark: To create a new document, one must assign an already existing document job to it or generate a new one.

HTTP method: POST
URI: https://api.signere.no/api/Document
Autorization model: Primary apikey is needed for this operation.
Subscription needed: "Sign document offline"
Parameters
  • request: Contains all necessary parameters to create a new document. Remark: if using Json, a GUID must not contain dashes (-), unlike XML. (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
List of AddonService List of addonservices with arguments (optional). Signere will then invoke the addons services and return the result in the document metadata. False     False False
ConvertToPDFA2b Boolean This will convert the document to the PDF/A-2 level b standard (http://en.wikipedia.org/?title=PDF/A#PDF.2FA-2). In the future this will be required from Norwegian BankID The convertion is done with PDF-tools (https://www.pdf-tools.com/pdf/pdf-to-pdfa-converter-signature.aspx) true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
CreatedByApplication String Name of the application that sendt the document Uni Eiendom False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
CreatePADES Boolean Shall there be generated a PADES PDF when the document is signed. Read more about the PADES format on https://api.signere.no true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
DepartmentId String Department to tag the invoice with for all transactions regarding this document department:1 False 255   False False
Description String Description of the document This document is a sales contract for a car True Text   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
DoNotNotifySigneeRefs Boolean Do not send email or SMS to the SigneeRefs (receipients) I will handle this my self false False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
ExternalDocumentId String An external ID for the document. This could for instance be the document provider's internal document reference number abc False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
FileContent String The file content of the document. It should be encoded as a base64 string (UTF-8) JVBERi0x.....LjYNJeLjz== True 255   False False (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
FileMD5CheckSum String The MD5 checksum of the document file 379515587b501fc7b471750fd5963ae7 True 32 32 False False ^([a-zA-Z]|[0-9]){32}$
FileName String The file name of the document (with file extension). Following formats are supported: pdf, doc, docx, txt, rtf, odt and ott. Document.docx True 255   False False ([a-zA-Z0-9 _-]*)\.(((p|P)(d|D)(f|F))|((t|T)(x|X)(t|T))|((o|O)(t|T)(t|T))|((x|X)(m|M)(l|L))|((r|R)(t|T)(F|f))|((d|D)(o|O)(c|C)(x|X))|((d|D)(o|O)(c|C))|((o|O)(d|D)(t|T)))
GetSSN Boolean Returns signers SSN if your certificate allows it false False 5 4 False False
Languages Language of the document EN True 2 2 False True ^[a-zA-Z0-9_]*$
MessageEmail String The message body in the e-mail The document is now ready to be signed. Please check your profile on signere.no False Text   False False Cannot contain script tag of any type
MessageSms String The message body in the SMS message The document is now ready to be signed. Please check your profile on signere.no False 320   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
List of DocumentMetaData Metadata describing the document False     False False
NotifySenderWhenCanceledEmail Boolean Determines whether an e-mail notification should be sent to the document sender if the document is canceled true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySenderWhenCanceledSMS Boolean Determines whether an SMS notification should be sent to the document sender if the document is canceled true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySenderWhenSignedEmail Boolean Determines whether an e-mail notification should be sent to the document sender if the document is signed true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySenderWhenSignedSMS Boolean Determines whether an SMS notification should be sent to the document sender if the document is signed true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySigneerefBeforeSignDeadlineEmail Boolean Determines whether an e-mail notification should be sent to the document to the Signeerefs that have not signed the document 24 hours before the signdeadline true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySigneerefBeforeSignDeadlineSMS Boolean Determines whether an sms notification should be sent to the document to the Signeerefs that have not signed the document 24 hours before the signdeadline (se www.signere.no for prices) false False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySigneerefsWhenSignedEmail Boolean Determines whether an e-mail notification should be sent to the signee(s) if the document is signed true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
NotifySigneerefsWhenSignedSMS Boolean Determines whether an SMS notification should be sent to the signee(s) if the document is signed true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Private Boolean Set if document is considered private, and should only be visible on portal for administrators true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
PushNotificationUrl String An URL to push notification when the document is signed or canceled. The 5 parameteres ([0],[1],[2],[3],[4]) will be replaced with: documentid (guid), providerid (guid), and operation (SIGNED,PARTIALSIGNED,CANCLED,PADESCREATED), externaldocumentid (string) signeeref (guid) all parameters are optional. On cancled signeeref will be empty. https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4] False 255   False False ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
ReceiptMessageEmail String The message body in the e-mail Thank you for signing the document, you can download a copy of the document by going to https://www.signere.no False Text   False False Cannot contain script tag of any type
ReceiptTopicEmail String The topic field in the e-mail The document is signed False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
RedirectFinishUrl String An URL to redirect the user to when the signing is complete. http://www.servicesummary.no False 255   False False ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
SenderEmail String The e-mail address to the person (document sender) that should receive document notifications post@signere.no False 255   False False [a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?
SenderMobile String The mobile phone number to the person (document sender) that should receive document notifications +4799716935 False 255   False False
ShowOnSigneesPersonalSite Boolean Determines whether or not the document should appear on the personal site of the signee(s) in the signere.no portal true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
SignDeadline DateTime The deadline for signature. After this, the document will no longer be possible to sign 2013-01-01T00:00:00.0000000 False 19 19 True False
List of SigneeRef A list of the persons that are supposed to sign the document True     False False
SignJobId Guid The ID (GUID) of the sign job with which the document should be associated 25B884825AB44850AC39A08A00D4D3AE True 36 36 False False ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
Title String Title of the document Sales contract True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
TopicEmail String The topic field in the e-mail The contract is ready False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
XsltFileContent String The file content of xslt to the xml document. It should be encoded as a base64 string (UTF-8). Only need when using xml signing with BankID JVBERi0x.....LjYNJeLjz== False 255   False False (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
Name AddonServices
Type List of AddonService
Description List of addonservices with arguments (optional). Signere will then invoke the addons services and return the result in the document metadata.
Example value
Required False
Max length  
Min length  
Nullable False
Enum False
Regex
Name ConvertToPDFA2b
Type Boolean
Description This will convert the document to the PDF/A-2 level b standard (http://en.wikipedia.org/?title=PDF/A#PDF.2FA-2). In the future this will be required from Norwegian BankID The convertion is done with PDF-tools (https://www.pdf-tools.com/pdf/pdf-to-pdfa-converter-signature.aspx)
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name CreatedByApplication
Type String
Description Name of the application that sendt the document
Example value Uni Eiendom
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name CreatePADES
Type Boolean
Description Shall there be generated a PADES PDF when the document is signed. Read more about the PADES format on https://api.signere.no
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name DepartmentId
Type String
Description Department to tag the invoice with for all transactions regarding this document
Example value department:1
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name Description
Type String
Description Description of the document
Example value This document is a sales contract for a car
Required True
Max length Text
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name DoNotNotifySigneeRefs
Type Boolean
Description Do not send email or SMS to the SigneeRefs (receipients) I will handle this my self
Example value false
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name ExternalDocumentId
Type String
Description An external ID for the document. This could for instance be the document provider's internal document reference number
Example value abc
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name FileContent
Type String
Description The file content of the document. It should be encoded as a base64 string (UTF-8)
Example value JVBERi0x.....LjYNJeLjz==
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
Name FileMD5CheckSum
Type String
Description The MD5 checksum of the document file
Example value 379515587b501fc7b471750fd5963ae7
Required True
Max length 32
Min length 32
Nullable False
Enum False
Regex ^([a-zA-Z]|[0-9]){32}$
Name FileName
Type String
Description The file name of the document (with file extension). Following formats are supported: pdf, doc, docx, txt, rtf, odt and ott.
Example value Document.docx
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9 _-]*)\.(((p|P)(d|D)(f|F))|((t|T)(x|X)(t|T))|((o|O)(t|T)(t|T))|((x|X)(m|M)(l|L))|((r|R)(t|T)(F|f))|((d|D)(o|O)(c|C)(x|X))|((d|D)(o|O)(c|C))|((o|O)(d|D)(t|T)))
Name GetSSN
Type Boolean
Description Returns signers SSN if your certificate allows it
Example value false
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex
Name Language
Type Languages
Description Language of the document
Example value EN
Required True
Max length 2
Min length 2
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
Name MessageEmail
Type String
Description The message body in the e-mail
Example value The document is now ready to be signed. Please check your profile on signere.no
Required False
Max length Text
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name MessageSms
Type String
Description The message body in the SMS message
Example value The document is now ready to be signed. Please check your profile on signere.no
Required False
Max length 320
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name MetaData
Type List of DocumentMetaData
Description Metadata describing the document
Example value
Required False
Max length  
Min length  
Nullable False
Enum False
Regex
Name NotifySenderWhenCanceledEmail
Type Boolean
Description Determines whether an e-mail notification should be sent to the document sender if the document is canceled
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySenderWhenCanceledSMS
Type Boolean
Description Determines whether an SMS notification should be sent to the document sender if the document is canceled
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySenderWhenSignedEmail
Type Boolean
Description Determines whether an e-mail notification should be sent to the document sender if the document is signed
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySenderWhenSignedSMS
Type Boolean
Description Determines whether an SMS notification should be sent to the document sender if the document is signed
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySigneerefBeforeSignDeadlineEmail
Type Boolean
Description Determines whether an e-mail notification should be sent to the document to the Signeerefs that have not signed the document 24 hours before the signdeadline
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySigneerefBeforeSignDeadlineSMS
Type Boolean
Description Determines whether an sms notification should be sent to the document to the Signeerefs that have not signed the document 24 hours before the signdeadline (se www.signere.no for prices)
Example value false
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySigneerefsWhenSignedEmail
Type Boolean
Description Determines whether an e-mail notification should be sent to the signee(s) if the document is signed
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name NotifySigneerefsWhenSignedSMS
Type Boolean
Description Determines whether an SMS notification should be sent to the signee(s) if the document is signed
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name Private
Type Boolean
Description Set if document is considered private, and should only be visible on portal for administrators
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name PushNotificationUrl
Type String
Description An URL to push notification when the document is signed or canceled. The 5 parameteres ([0],[1],[2],[3],[4]) will be replaced with: documentid (guid), providerid (guid), and operation (SIGNED,PARTIALSIGNED,CANCLED,PADESCREATED), externaldocumentid (string) signeeref (guid) all parameters are optional. On cancled signeeref will be empty.
Example value https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
Name ReceiptMessageEmail
Type String
Description The message body in the e-mail
Example value Thank you for signing the document, you can download a copy of the document by going to https://www.signere.no
Required False
Max length Text
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name ReceiptTopicEmail
Type String
Description The topic field in the e-mail
Example value The document is signed
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name RedirectFinishUrl
Type String
Description An URL to redirect the user to when the signing is complete.
Example value http://www.servicesummary.no
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
Name SenderEmail
Type String
Description The e-mail address to the person (document sender) that should receive document notifications
Example value post@signere.no
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex [a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?
Name SenderMobile
Type String
Description The mobile phone number to the person (document sender) that should receive document notifications
Example value +4799716935
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name ShowOnSigneesPersonalSite
Type Boolean
Description Determines whether or not the document should appear on the personal site of the signee(s) in the signere.no portal
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name SignDeadline
Type DateTime
Description The deadline for signature. After this, the document will no longer be possible to sign
Example value 2013-01-01T00:00:00.0000000
Required False
Max length 19
Min length 19
Nullable True
Enum False
Regex
Name SigneeRefs
Type List of SigneeRef
Description A list of the persons that are supposed to sign the document
Example value
Required True
Max length  
Min length  
Nullable False
Enum False
Regex
Name SignJobId
Type Guid
Description The ID (GUID) of the sign job with which the document should be associated
Example value 25B884825AB44850AC39A08A00D4D3AE
Required True
Max length 36
Min length 36
Nullable False
Enum False
Regex ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
Name Title
Type String
Description Title of the document
Example value Sales contract
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name TopicEmail
Type String
Description The topic field in the e-mail
Example value The contract is ready
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name XsltFileContent
Type String
Description The file content of xslt to the xml document. It should be encoded as a base64 string (UTF-8). Only need when using xml signing with BankID
Example value JVBERi0x.....LjYNJeLjz==
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
{
    "SignJobId": "25b884825ab44850ac39a08a00d4d3ae",
    "ExternalDocumentId": "abc",
    "Title": "Sales contract",
    "Description": "This document is a sales contract for a car",
    "Language": "EN",
    "SigneeRefs": [
        {
            "ExternalSigneeId": "1234",
            "FirstName": "Kari",
            "LastName": "Normann",
            "Mobile": "+4799775533",
            "Email": "kari@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SocialSecurityNumber": "24051212345",
            "SignOrder": 1
        },
        {
            "ExternalSigneeId": "1234",
            "FirstName": "Kari",
            "LastName": "Normann",
            "Mobile": "+4799775533",
            "Email": "kari@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SocialSecurityNumber": "24051212345",
            "SignOrder": 1
        }
    ],
    "SignDeadline": "2013-01-01T00:00:00.0000000",
    "MessageSms": "The document is now ready to be signed. Please check your profile on signere.no",
    "MessageEmail": "The document is now ready to be signed. Please check your profile on signere.no",
    "TopicEmail": "The contract is ready",
    "ReceiptMessageEmail": "Thank you for signing the document, you can download a copy of the document by going to https://www.signere.no",
    "ReceiptTopicEmail": "The document is signed",
    "FileContent": "JVBERi0x.....LjYNJeLjz==",
    "FileName": "Document.docx",
    "FileMD5CheckSum": "379515587b501fc7b471750fd5963ae7",
    "XsltFileContent": "JVBERi0x.....LjYNJeLjz==",
    "ShowOnSigneesPersonalSite": true,
    "NotifySenderWhenCanceledSMS": true,
    "NotifySenderWhenCanceledEmail": true,
    "NotifySigneerefBeforeSignDeadlineSMS": false,
    "NotifySigneerefBeforeSignDeadlineEmail": true,
    "SenderEmail": "post@signere.no",
    "SenderMobile": "+4799716935",
    "NotifySenderWhenSignedSMS": true,
    "NotifySenderWhenSignedEmail": true,
    "NotifySigneerefsWhenSignedSMS": true,
    "NotifySigneerefsWhenSignedEmail": true,
    "Private": true,
    "CreatedByApplication": "Uni Eiendom",
    "RedirectFinishUrl": "http://www.servicesummary.no",
    "PushNotificationUrl": "https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]",
    "CreatePADES": true,
    "ConvertToPDFA2b": true,
    "DoNotNotifySigneeRefs": false,
    "AddonServices": [
        {
            "Name": "no.national.registry",
            "Arguments": "{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}"
        },
        {
            "Name": "no.national.registry",
            "Arguments": "{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}"
        }
    ],
    "GetSSN": false,
    "DepartmentId": "department:1"
}

XML elements must be in same order as in this example xml

<?xml version="1.0" encoding="utf-8"?>
<CreateDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <AddonServices>
      <AddonService>
         <Arguments>{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}</Arguments>
         <Name>no.national.registry</Name>
      </AddonService>
      <AddonService>
         <Arguments>{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}</Arguments>
         <Name>no.national.registry</Name>
      </AddonService>
   </AddonServices>
   <ConvertToPDFA2b>true</ConvertToPDFA2b>
   <CreatePADES>true</CreatePADES>
   <CreatedByApplication>Uni Eiendom</CreatedByApplication>
   <DepartmentId>department:1</DepartmentId>
   <Description>This document is a sales contract for a car</Description>
   <DoNotNotifySigneeRefs>false</DoNotNotifySigneeRefs>
   <ExternalDocumentId>abc</ExternalDocumentId>
   <FileContent>JVBERi0x.....LjYNJeLjz==</FileContent>
   <FileMD5CheckSum>379515587b501fc7b471750fd5963ae7</FileMD5CheckSum>
   <FileName>Document.docx</FileName>
   <GetSSN>false</GetSSN>
   <Language>EN</Language>
   <MessageEmail>The document is now ready to be signed. Please check your profile on signere.no</MessageEmail>
   <MessageSms>The document is now ready to be signed. Please check your profile on signere.no</MessageSms>
   <MetaData i:nil="true" />
   <NotifySenderWhenCanceledEmail>true</NotifySenderWhenCanceledEmail>
   <NotifySenderWhenCanceledSMS>true</NotifySenderWhenCanceledSMS>
   <NotifySenderWhenSignedEmail>true</NotifySenderWhenSignedEmail>
   <NotifySenderWhenSignedSMS>true</NotifySenderWhenSignedSMS>
   <NotifySigneerefBeforeSignDeadlineEmail>true</NotifySigneerefBeforeSignDeadlineEmail>
   <NotifySigneerefBeforeSignDeadlineSMS>false</NotifySigneerefBeforeSignDeadlineSMS>
   <NotifySigneerefsWhenSignedEmail>true</NotifySigneerefsWhenSignedEmail>
   <NotifySigneerefsWhenSignedSMS>true</NotifySigneerefsWhenSignedSMS>
   <Private>true</Private>
   <PushNotificationUrl>https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]</PushNotificationUrl>
   <ReceiptMessageEmail>Thank you for signing the document, you can download a copy of the document by going to https://www.signere.no</ReceiptMessageEmail>
   <ReceiptTopicEmail>The document is signed</ReceiptTopicEmail>
   <RedirectFinishUrl>http://www.servicesummary.no</RedirectFinishUrl>
   <SenderEmail>post@signere.no</SenderEmail>
   <SenderMobile>+4799716935</SenderMobile>
   <ShowOnSigneesPersonalSite>true</ShowOnSigneesPersonalSite>
   <SignDeadline>2013-01-01T00:00:00</SignDeadline>
   <SignJobId>25b88482-5ab4-4850-ac39-a08a00d4d3ae</SignJobId>
   <SigneeRefs>
      <SigneeRef>
         <ExternalSigneeId>1234</ExternalSigneeId>
         <FirstName>Kari</FirstName>
         <LastName>Normann</LastName>
         <Mobile>+4799775533</Mobile>
         <Email>kari@normann.no</Email>
         <OrgNo>987654321</OrgNo>
         <CompanyName>Example Company</CompanyName>
         <SocialSecurityNumber>24051212345</SocialSecurityNumber>
         <SignOrder>1</SignOrder>
      </SigneeRef>
      <SigneeRef>
         <ExternalSigneeId>1234</ExternalSigneeId>
         <FirstName>Kari</FirstName>
         <LastName>Normann</LastName>
         <Mobile>+4799775533</Mobile>
         <Email>kari@normann.no</Email>
         <OrgNo>987654321</OrgNo>
         <CompanyName>Example Company</CompanyName>
         <SocialSecurityNumber>24051212345</SocialSecurityNumber>
         <SignOrder>1</SignOrder>
      </SigneeRef>
   </SigneeRefs>
   <Title>Sales contract</Title>
   <TopicEmail>The contract is ready</TopicEmail>
   <XsltFileContent>JVBERi0x.....LjYNJeLjz==</XsltFileContent>
</CreateDocumentRequest>
Response example
{
    "Id": "ea522127d971420595efa08a00d4d3ae",
    "SignJobId": "25b884825ab44850ac39a08a00d4d3ae",
    "ExternalDocumentId": "abc",
    "Title": "Sales contract",
    "Description": "This document is a sales contract for a car",
    "Language": "EN",
    "MetaData": [
        {
            "KeyName": "CreationDate",
            "Value": "2012-12-12"
        },
        {
            "KeyName": "CreationDate",
            "Value": "2012-12-12"
        }
    ],
    "SigneeRefs": [
        {
            "Id": "91fa608690db4852bd91a08a00d4d3af",
            "SigneeRefId": "91fa608690db4852bd91a08a00d4d3af",
            "ExternalSigneeId": "1245",
            "FirstName": "Ola",
            "LastName": "Nordmann",
            "Mobile": "+4799887766",
            "Email": "ola@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SignOrder": 1,
            "SignedTime": "2012-12-12T15:00:00.0000000",
            "Signed": false,
            "SignName": "Ola Nordmann",
            "DateOfBirth": "071283",
            "BankIdPid": "9578-6000-4-48857",
            "BuypassId": "100153378",
            "SocialSecurityNumber": "24051212345",
            "CertificateIssuer": "DnB",
            "SignUrl": "https://s.signere.no/agf14da2daf"
        },
        {
            "Id": "91fa608690db4852bd91a08a00d4d3af",
            "SigneeRefId": "91fa608690db4852bd91a08a00d4d3af",
            "ExternalSigneeId": "1245",
            "FirstName": "Ola",
            "LastName": "Nordmann",
            "Mobile": "+4799887766",
            "Email": "ola@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SignOrder": 1,
            "SignedTime": "2012-12-12T15:00:00.0000000",
            "Signed": false,
            "SignName": "Ola Nordmann",
            "DateOfBirth": "071283",
            "BankIdPid": "9578-6000-4-48857",
            "BuypassId": "100153378",
            "SocialSecurityNumber": "24051212345",
            "CertificateIssuer": "DnB",
            "SignUrl": "https://s.signere.no/agf14da2daf"
        }
    ],
    "UploadTime": "2012-10-01T15:00:00.0000000",
    "SignDeadline": "2012-10-14T00:00:00.0000000",
    "CanceledDate": "2012-10-03T14:30:00.0000000",
    "CancelationExplanation": "The car's registration number was wrong. Uploading new document",
    "CancelationSignature": "James Dean",
    "CanceledBySignee": false,
    "CanceledByProvider": true,
    "Contact_Name": "John Doe",
    "Contact_Phone": "+4722334455",
    "Contact_Mobile": "+4799887766",
    "Contact_Email": "contact@thebank.com",
    "Contact_Url": "www.thebank.com/contact",
    "NotifySenderWhenCanceledSMS": true,
    "NotifySenderWhenCanceledEmail": true,
    "SenderEmail": "post@signere.no",
    "SenderMobile": "+47999716935",
    "NotifiySenderWhenSignedSMS": true,
    "NotifySenderWhenSignedEmail": true,
    "NotifySigneerefsWhenSignedSMS": true,
    "NotifySigneerefsWhenSignedEmail": true,
    "Signed": true,
    "LastSignature": "2012-10-03T14:30:00.0000000",
    "MessageEmail": "The document is now ready to be signed. Please check your profile on signere.no",
    "TopicEmail": "The contract is ready",
    "Private": true,
    "ValidPDFA_2b": true,
    "ValidPDFA_2b_Report": "Report"
}
<?xml version="1.0" encoding="utf-8"?>
<DocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <CancelationExplanation>The car's registration number was wrong. Uploading new document</CancelationExplanation>
   <CancelationSignature>James Dean</CancelationSignature>
   <CanceledByProvider>true</CanceledByProvider>
   <CanceledBySignee>false</CanceledBySignee>
   <CanceledDate>2012-10-03T14:30:00</CanceledDate>
   <Contact_Email>contact@thebank.com</Contact_Email>
   <Contact_Mobile>+4799887766</Contact_Mobile>
   <Contact_Name>John Doe</Contact_Name>
   <Contact_Phone>+4722334455</Contact_Phone>
   <Contact_Url>www.thebank.com/contact</Contact_Url>
   <Description>This document is a sales contract for a car</Description>
   <ExternalDocumentId>abc</ExternalDocumentId>
   <Id>ea522127-d971-4205-95ef-a08a00d4d3ae</Id>
   <Language>EN</Language>
   <LastSignature>2012-10-03T14:30:00</LastSignature>
   <MessageEmail>The document is now ready to be signed. Please check your profile on signere.no</MessageEmail>
   <MetaData>
      <DocumentMetaData>
         <KeyName>CreationDate</KeyName>
         <Value>2012-12-12</Value>
      </DocumentMetaData>
      <DocumentMetaData>
         <KeyName>CreationDate</KeyName>
         <Value>2012-12-12</Value>
      </DocumentMetaData>
   </MetaData>
   <NotifiySenderWhenSignedSMS>true</NotifiySenderWhenSignedSMS>
   <NotifySenderWhenCanceledEmail>true</NotifySenderWhenCanceledEmail>
   <NotifySenderWhenCanceledSMS>true</NotifySenderWhenCanceledSMS>
   <NotifySenderWhenSignedEmail>true</NotifySenderWhenSignedEmail>
   <NotifySigneerefsWhenSignedEmail>true</NotifySigneerefsWhenSignedEmail>
   <NotifySigneerefsWhenSignedSMS>true</NotifySigneerefsWhenSignedSMS>
   <Private>true</Private>
   <SenderEmail>post@signere.no</SenderEmail>
   <SenderMobile>+47999716935</SenderMobile>
   <SignDeadline>2012-10-14T00:00:00</SignDeadline>
   <SignJobId>25b88482-5ab4-4850-ac39-a08a00d4d3ae</SignJobId>
   <Signed>true</Signed>
   <SigneeRefs>
      <Signee>
         <BankIdPid>9578-6000-4-48857</BankIdPid>
         <BuypassId>100153378</BuypassId>
         <CertificateIssuer>DnB</CertificateIssuer>
         <CompanyName>Example Company</CompanyName>
         <DateOfBirth>071283</DateOfBirth>
         <Email>ola@normann.no</Email>
         <ExternalSigneeId>1245</ExternalSigneeId>
         <FirstName>Ola</FirstName>
         <Id>91fa6086-90db-4852-bd91-a08a00d4d3af</Id>
         <LastName>Nordmann</LastName>
         <Mobile>+4799887766</Mobile>
         <OrgNo>987654321</OrgNo>
         <SignName>Ola Nordmann</SignName>
         <SignOrder>1</SignOrder>
         <SignUrl>https://s.signere.no/agf14da2daf</SignUrl>
         <Signed>false</Signed>
         <SignedTime>2012-12-12T15:00:00</SignedTime>
         <SigneeRefId>91fa6086-90db-4852-bd91-a08a00d4d3af</SigneeRefId>
         <SocialSecurityNumber>24051212345</SocialSecurityNumber>
      </Signee>
      <Signee>
         <BankIdPid>9578-6000-4-48857</BankIdPid>
         <BuypassId>100153378</BuypassId>
         <CertificateIssuer>DnB</CertificateIssuer>
         <CompanyName>Example Company</CompanyName>
         <DateOfBirth>071283</DateOfBirth>
         <Email>ola@normann.no</Email>
         <ExternalSigneeId>1245</ExternalSigneeId>
         <FirstName>Ola</FirstName>
         <Id>91fa6086-90db-4852-bd91-a08a00d4d3af</Id>
         <LastName>Nordmann</LastName>
         <Mobile>+4799887766</Mobile>
         <OrgNo>987654321</OrgNo>
         <SignName>Ola Nordmann</SignName>
         <SignOrder>1</SignOrder>
         <SignUrl>https://s.signere.no/agf14da2daf</SignUrl>
         <Signed>false</Signed>
         <SignedTime>2012-12-12T15:00:00</SignedTime>
         <SigneeRefId>91fa6086-90db-4852-bd91-a08a00d4d3af</SigneeRefId>
         <SocialSecurityNumber>24051212345</SocialSecurityNumber>
      </Signee>
   </SigneeRefs>
   <Title>Sales contract</Title>
   <TopicEmail>The contract is ready</TopicEmail>
   <UploadTime>2012-10-01T15:00:00</UploadTime>
   <ValidPDFA_2b>true</ValidPDFA_2b>
   <ValidPDFA_2b_Report>Report</ValidPDFA_2b_Report>
</DocumentResponse>
Name Type Description Example value Nullable Enum
CancelationExplanation String An explanation for why the document was canceled The car's registration number was wrong. Uploading new document False False
CancelationSignature String The signature of the person that canceled the document James Dean False False
CanceledByProvider Boolean Indicates whether the document was canceled by the document provider true False False
CanceledBySignee Boolean Indicates whether the document was canceled by the signee false False False
CanceledDate DateTime The date when (possibly) the document was canceled 2012-10-03T14:30:00.0000000 True False
Contact_Email String The e-mail address to the contact person contact@thebank.com False False
Contact_Mobile String The mobile phone number to the contact person +4799887766 False False
Contact_Name String The name of the document provider's contact person John Doe False False
Contact_Phone String The phone number to the contact person +4722334455 False False
Contact_Url String An URL for contact details. For instance the contact person's profile/home page on the public sites of the document provider www.thebank.com/contact False False
Description String Description of the document This document is a sales contract for a car False False
ExternalDocumentId String An external ID for the document. This could for instance be the document provider's internal document reference number abc False False
Id Guid The ID (GUID) of the document EA522127D971420595EFA08A00D4D3AE False False
Language String Language of the document EN False False
LastSignature DateTime Timestamp for the last signature on the document. 2012-10-03T14:30:00.0000000 True False
MessageEmail String The message body in the e-mail The document is now ready to be signed. Please check your profile on signere.no False False
List of DocumentMetaData Document metadata False False
NotifiySenderWhenSignedSMS Boolean true False False
NotifySenderWhenCanceledEmail Boolean true False False
NotifySenderWhenCanceledSMS Boolean true False False
NotifySenderWhenSignedEmail Boolean true False False
NotifySigneerefsWhenSignedEmail Boolean true False False
NotifySigneerefsWhenSignedSMS Boolean true False False
Private Boolean Set if document is considered private, and should only be visible on portal for administrators true False False
SenderEmail String post@signere.no False False
SenderMobile String +47999716935 False False
SignDeadline DateTime The deadline for signature. After this, the document will no longer be possible to sign 2012-10-14T00:00:00.0000000 True False
Signed Boolean Indicates whether the document is signed (all signeerefs have to have signed, in order to consider a document signed true False False
List of Signee List of Signeeref on the document False False
SignJobId Guid The ID (GUID) of the sign job with which the document is associated 25B884825AB44850AC39A08A00D4D3AE False False
Title String Title of the document Sales contract False False
TopicEmail String The topic field in the e-mail The contract is ready False False
UploadTime DateTime The date when the document was uploaded 2012-10-01T15:00:00.0000000 False False
ValidPDFA_2b Boolean Indicates if the document conforms to the PDF/A-2 level b standard (http://en.wikipedia.org/?title=PDF/A#PDF.2FA-2). In the future this will be required from Norwegian BankID true False False
ValidPDFA_2b_Report String If not valid it returns a report of elements in the PDF that is not compliant with the PDF/A-2 level b standard. In the future this will be required from Norwegian BankID Report False False