Description

Creates a document job (every document must be assigned to a document job). Returns the ID (GUID) for the created document job.

HTTP method: POST
URI: https://api.signere.no/api/DocumentJob
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document offline"
Parameters
  • request: Contains all necessary parameters to create a new document job (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
Contact_Email String The e-mail address to the contact person ola@nordmann.no True 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])?
Contact_Mobile String The mobile phone number to the contact person +4799775533 False 255   False False ^(\(?\+47\)?)?[- ]?([4|9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})$
Contact_Name String The name of the document provider's contact person Ola Nordmann False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Contact_Phone String The phone number to the contact person +4722334455 True 255   False False ^(\(?\+47\)?)?[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})$
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 http://www.olanordmann.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\[\]\;\@\=_.-]+)
Name Contact_Email
Type String
Description The e-mail address to the contact person
Example value ola@nordmann.no
Required True
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 Contact_Mobile
Type String
Description The mobile phone number to the contact person
Example value +4799775533
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^(\(?\+47\)?)?[- ]?([4|9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})$
Name Contact_Name
Type String
Description The name of the document provider's contact person
Example value Ola Nordmann
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 Contact_Phone
Type String
Description The phone number to the contact person
Example value +4722334455
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ^(\(?\+47\)?)?[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})$
Name Contact_Url
Type String
Description An URL for contact details. For instance the contact person's profile/home page on the public sites of the document provider
Example value http://www.olanordmann.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\[\]\;\@\=_.-]+)
{
    "Contact_Name": "Ola Nordmann",
    "Contact_Phone": "+4722334455",
    "Contact_Mobile": "+4799775533",
    "Contact_Email": "ola@nordmann.no",
    "Contact_Url": "http://www.olanordmann.no"
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateDocumentJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <Contact_Email>ola@nordmann.no</Contact_Email>
   <Contact_Mobile>+4799775533</Contact_Mobile>
   <Contact_Name>Ola Nordmann</Contact_Name>
   <Contact_Phone>+4722334455</Contact_Phone>
   <Contact_Url>http://www.olanordmann.no</Contact_Url>
</CreateDocumentJobRequest>
Response example
{
    "Id": "25b884825ab44850ac39a08a00d4d3ae"
}
<?xml version="1.0" encoding="utf-8"?>
<CreateDocumentJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <Id>25b88482-5ab4-4850-ac39-a08a00d4d3ae</Id>
</CreateDocumentJobResponse>
Name Type Description Example value Nullable Enum
Id Guid The ID (GUID) of the document job 25B884825AB44850AC39A08A00D4D3AE False False