Description

Sends a message to the signees of a given document. Returns HTTP status code "created" if the message was successfully created and distributed. Remark: if using Json, a GUID must not contain dashes (-), unlike XML.

HTTP method: POST
URI: https://api.signere.no/api/Message
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document offline" or "Sign document online" or "Sign document on the portal"
Parameters
  • request: Contains all necessary parameters to send a message related to a given document (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
DocumentID Guid The ID (GUID) of the document for which a message is to be distributed EA522127D971420595EFA08A00D4D3AE 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})$
EmailMessage String The message body in the e-mail You have received an update on the transaction status. Please check your profile on signere.no True 255   False False Cannot contain script tag of any type
EmailTopic String Topic field in the e-mail Updated information False 255   False False Cannot contain script tag of any type
Languages The language in the message EN False 2 2 False True ^[a-zA-Z0-9_]*$
RecipientEmailAddress String The recipient's e-mail address customer1@hotmail.com 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])?
RecipientMobileNumber String The recipient's mobile phone number. If supplied, the message will be distributed as both an e-mail and an SMS. If the field is blank, only an e-mail will be sent. +4799887766 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})$
SenderSignature String Fullname or username for the user that sendt the message Ola Nordmann True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
SigneeRef Guid The Guid of the signee that shall receive the message 459E946A2C154B3490A1A0B300FD3753 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})$
Name DocumentID
Type Guid
Description The ID (GUID) of the document for which a message is to be distributed
Example value EA522127D971420595EFA08A00D4D3AE
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 EmailMessage
Type String
Description The message body in the e-mail
Example value You have received an update on the transaction status. Please check your profile on signere.no
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name EmailTopic
Type String
Description Topic field in the e-mail
Example value Updated information
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name Language
Type Languages
Description The language in the message
Example value EN
Required False
Max length 2
Min length 2
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
Name RecipientEmailAddress
Type String
Description The recipient's e-mail address
Example value customer1@hotmail.com
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 RecipientMobileNumber
Type String
Description The recipient's mobile phone number. If supplied, the message will be distributed as both an e-mail and an SMS. If the field is blank, only an e-mail will be sent.
Example value +4799887766
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 SenderSignature
Type String
Description Fullname or username for the user that sendt the message
Example value Ola Nordmann
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 SigneeRef
Type Guid
Description The Guid of the signee that shall receive the message
Example value 459E946A2C154B3490A1A0B300FD3753
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})$
{
    "DocumentID": "ea522127d971420595efa08a00d4d3ae",
    "EmailTopic": "Updated information",
    "EmailMessage": "You have received an update on the transaction status. Please check your profile on signere.no",
    "RecipientEmailAddress": "customer1@hotmail.com",
    "RecipientMobileNumber": "+4799887766",
    "SigneeRef": "459e946a2c154b3490a1a0b300fd3753",
    "Language": "EN",
    "SenderSignature": "Ola Nordmann"
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateDocumentMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <DocumentID>ea522127-d971-4205-95ef-a08a00d4d3ae</DocumentID>
   <EmailMessage>You have received an update on the transaction status. Please check your profile on signere.no</EmailMessage>
   <EmailTopic>Updated information</EmailTopic>
   <Language>EN</Language>
   <RecipientEmailAddress>customer1@hotmail.com</RecipientEmailAddress>
   <RecipientMobileNumber>+4799887766</RecipientMobileNumber>
   <SenderSignature>Ola Nordmann</SenderSignature>
   <SigneeRef>459e946a-2c15-4b34-90a1-a0b300fd3753</SigneeRef>
</CreateDocumentMessageRequest>