Description

Sends a message to an external person with a link/URL to view a document. The external person will receive an OTP code via SMS (to the given mobile number) to access the document on the issued URL.

HTTP method: POST
URI: https://api.signere.no/api/Message/SendExternalMessage
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 to an external person (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
DocumentID Guid The ID (GUID) of the document for which the message should 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})$
Email String Email address to the person that shall receive a link to view the document post@signere.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])?
EmailMessage String The message body in the e-mail Click the link in the e-mail to view the signed document. Best regards NN True 255   False False Cannot contain script tag of any type
EmailTopic String Topic field in the e-mail View signed document True 150   False False Cannot contain script tag of any type
Expires DateTime Expiration date for the URL to view the document. For security reasons, the document will after this no longer be visible on the issued URL. 2013-07-04T00:00:00.0000000 False 19 19 True False
MobileNumber String The recipient's mobile phone number. Used to send the recipent OTP code to access the document +4799716935 True 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 { } \[ \] ]*$
Name DocumentID
Type Guid
Description The ID (GUID) of the document for which the message should 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 Email
Type String
Description Email address to the person that shall receive a link to view the document
Example value post@signere.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 EmailMessage
Type String
Description The message body in the e-mail
Example value Click the link in the e-mail to view the signed document. Best regards NN
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 View signed document
Required True
Max length 150
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name Expires
Type DateTime
Description Expiration date for the URL to view the document. For security reasons, the document will after this no longer be visible on the issued URL.
Example value 2013-07-04T00:00:00.0000000
Required False
Max length 19
Min length 19
Nullable True
Enum False
Regex
Name MobileNumber
Type String
Description The recipient's mobile phone number. Used to send the recipent OTP code to access the document
Example value +4799716935
Required True
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 { } \[ \] ]*$
{
    "DocumentID": "ea522127d971420595efa08a00d4d3ae",
    "Email": "post@signere.no",
    "MobileNumber": "+4799716935",
    "Expires": "2013-07-04T00:00:00.0000000",
    "EmailTopic": "View signed document",
    "EmailMessage": "Click the link in the e-mail to view the signed document. Best regards NN",
    "SenderSignature": "Ola Nordmann"
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateExternalDocumentMessageRequest 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>
   <Email>post@signere.no</Email>
   <EmailMessage>Click the link in the e-mail to view the signed document. Best regards NN</EmailMessage>
   <EmailTopic>View signed document</EmailTopic>
   <Expires>2013-07-04T00:00:00</Expires>
   <MobileNumber>+4799716935</MobileNumber>
   <SenderSignature>Ola Nordmann</SenderSignature>
</CreateExternalDocumentMessageRequest>