Description

Creates a externalsign request, to integrate signing of documents in to a website. BankID error codes: CLIENT_IP_MISMATCH = 999, NOT_VALID_AUTHCOOKIE = 998 MISSING_AUTHCOOKIE = 994 MISSING_PID = 997 BANKID_INIT_TOUCHED_TWICE = 995; BANKID_VERIFY_TOUCHED_TWICE = 995 SIGNUSER_AUTHUSER_MISMATCH = 996 OLD_JAVA = 993; DISABLED_JAVA = 992; DISABLED_COOKIES = 993; SOCIALSECURITY_MISMATCH = 991 BANKIDPID_MISMATCH = 990 ITEM_NOT_FOUND = 2022

HTTP method: POST
URI: https://api.signere.no/api/externalsign
Autorization model: Primary apikey is needed for this operation.
Subscription needed: "Sign document online"
Parameters
  • request: Contains all necessary parameters to create a document to sign (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))$
Description String Description of the document This document is a sales contract for car BS99999 True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
DocumentType The file type of document to be signed. Valid values are: PDF (default), TEXT and XML. For XML you have to include the FileXSLTContent. PDF False 4 3 False True ^[a-zA-Z0-9_]*$
Domain String The domain the site is running on, used in combination with iFrame and content security policy www.domain.com 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])|(localhost:\d{0,5}))$
ExternalDocumentId String The external reference of the signee. This could for instance be a customer number. 1234 True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
FileContent String The file content of the signed document. It should be encoded as a base64 string (UTF-8). If xml or text then base64 encode the string content not the filecontent. JVBERi0x....LjYNJeLjz9M True Text   False False (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
Filename String The file name of the document (with file extension). Following formats are supported: pdf, xml and txt. contract.pdf True 255   False False ([a-zA-Z0-9 _-]*)\.(((p|P)(d|D)(f|F))|((x|X)(m|M)(l|L))|((t|T)(x|X)(t|T)))
FileXSLTContent String The file content of the xslt file (only used for. It should be encoded as a base64 string (UTF-8) JVBERi0x....LjYNJeLjz9M False Text   False False (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
GetSocialSecurityNumber Boolean Should the signers socialsecuritynumber be collected during signing. This requires that the BankID certificate associated with the account have permission for getting socialsecuritynumber true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
HideDetailsPage Boolean Hide the detailspage when signing on small devices and go directly to BankID sign process. This will hide information about: the document title and description, logo, if multi sign other that shall or have 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))$
IdentityProviderType Set this to the type of Identityprovider that you want to use. (You have to have an subscription to the providers that you use, if not contact sales@signere.no NO_BANKID_WEB False 17 7 False True ^[a-zA-Z0-9_]*$
Languages Language of the document NO is default is not supplied EN False 2 2 False True ^[a-zA-Z0-9_]*$
List of DocumentMetaData Metadata describing the document False     False False
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],[5]) will be replaced with: documentid (guid), providerid (guid), and operation (SIGNED,PARTIALSIGNED,CANCLED,PADESCREATED), externaldocumentid (string) signeeref (guid) and externaluniqueid (string) all parameters are optional. On cancled signeeref and externaluniqueid will be empty. https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]&externaluniqueid=[5] 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\[\]\;\@\=_.-]+)
ReturnUrlError String URL that the user will be redirected to if the signing process is unsuccessful. [0] is a placeholder for the response ID. Errorcodes: InternalError=0,DocumentSigned=1,ErrorGettingDocumentFile=2,DocumentLockedSigningInProgress=3,LoginError=4 also see the BankID errorcodes at the top. Http://www.yourdomain.no/error.aspx?signeeref=[0]&youruniqueref=[1]&errorcode=[2] True 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\[\]\;\@\=_.-]+)
ReturnUrlSuccess String URL that the user will be redirected to if the signing process is successful. [0] is a placeholder for the response ID, {1} is your reference code (ExternalRef). Http://www.yourdomain.no/signsuccess.aspx?signeeref=[0]&youruniqueref=[1] True 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\[\]\;\@\=_.-]+)
ReturnUrlUserAbort String URL that the user will be redirected to if he/she aborts the signing process. [0] is a placeholder for the response ID. Http://www.yourdomain.no/useraborted.aspx?signeeref=[0]&youruniqueref=[1] True 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\[\]\;\@\=_.-]+)
List of ExternalSigneeRef A list of the persons that are supposed to sign the document True     False False
Title String The name of the document Sales contract True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
UrlExpiresMinutes Int32 Use this to make the sign url expire, the lower number is more secure, the signing session will not be affected by this. Setting 0 or nothing will mean no expire 5 False     False False ^\d+$
UseIframe Boolean Should the login page be used in an iframe, the content will then be only the client and, the redirect is done in javascript. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
UseWebMessaging Boolean Use HTML5 Web messaging to redirect iFrame, use this on newer device that have problem redirect because of not same origin policy in the browser. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
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 Description
Type String
Description Description of the document
Example value This document is a sales contract for car BS99999
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 DocumentType
Type DocumentType
Description The file type of document to be signed. Valid values are: PDF (default), TEXT and XML. For XML you have to include the FileXSLTContent.
Example value PDF
Required False
Max length 4
Min length 3
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
Name Domain
Type String
Description The domain the site is running on, used in combination with iFrame and content security policy
Example value www.domain.com
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])|(localhost:\d{0,5}))$
Name ExternalDocumentId
Type String
Description The external reference of the signee. This could for instance be a customer number.
Example value 1234
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 FileContent
Type String
Description The file content of the signed document. It should be encoded as a base64 string (UTF-8). If xml or text then base64 encode the string content not the filecontent.
Example value JVBERi0x....LjYNJeLjz9M
Required True
Max length Text
Min length  
Nullable False
Enum False
Regex (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
Name Filename
Type String
Description The file name of the document (with file extension). Following formats are supported: pdf, xml and txt.
Example value contract.pdf
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9 _-]*)\.(((p|P)(d|D)(f|F))|((x|X)(m|M)(l|L))|((t|T)(x|X)(t|T)))
Name FileXSLTContent
Type String
Description The file content of the xslt file (only used for. It should be encoded as a base64 string (UTF-8)
Example value JVBERi0x....LjYNJeLjz9M
Required False
Max length Text
Min length  
Nullable False
Enum False
Regex (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
Name GetSocialSecurityNumber
Type Boolean
Description Should the signers socialsecuritynumber be collected during signing. This requires that the BankID certificate associated with the account have permission for getting socialsecuritynumber
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 HideDetailsPage
Type Boolean
Description Hide the detailspage when signing on small devices and go directly to BankID sign process. This will hide information about: the document title and description, logo, if multi sign other that shall or have 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 IdentityProvider
Type IdentityProviderType
Description Set this to the type of Identityprovider that you want to use. (You have to have an subscription to the providers that you use, if not contact sales@signere.no
Example value NO_BANKID_WEB
Required False
Max length 17
Min length 7
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
Name Language
Type Languages
Description Language of the document NO is default is not supplied
Example value EN
Required False
Max length 2
Min length 2
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
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 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],[5]) will be replaced with: documentid (guid), providerid (guid), and operation (SIGNED,PARTIALSIGNED,CANCLED,PADESCREATED), externaldocumentid (string) signeeref (guid) and externaluniqueid (string) all parameters are optional. On cancled signeeref and externaluniqueid will be empty.
Example value https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]&externaluniqueid=[5]
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 ReturnUrlError
Type String
Description URL that the user will be redirected to if the signing process is unsuccessful. [0] is a placeholder for the response ID. Errorcodes: InternalError=0,DocumentSigned=1,ErrorGettingDocumentFile=2,DocumentLockedSigningInProgress=3,LoginError=4 also see the BankID errorcodes at the top.
Example value Http://www.yourdomain.no/error.aspx?signeeref=[0]&youruniqueref=[1]&errorcode=[2]
Required True
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 ReturnUrlSuccess
Type String
Description URL that the user will be redirected to if the signing process is successful. [0] is a placeholder for the response ID, {1} is your reference code (ExternalRef).
Example value Http://www.yourdomain.no/signsuccess.aspx?signeeref=[0]&youruniqueref=[1]
Required True
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 ReturnUrlUserAbort
Type String
Description URL that the user will be redirected to if he/she aborts the signing process. [0] is a placeholder for the response ID.
Example value Http://www.yourdomain.no/useraborted.aspx?signeeref=[0]&youruniqueref=[1]
Required True
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 SigneeRefs
Type List of ExternalSigneeRef
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 Title
Type String
Description The name 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 UrlExpiresMinutes
Type Int32
Description Use this to make the sign url expire, the lower number is more secure, the signing session will not be affected by this. Setting 0 or nothing will mean no expire
Example value 5
Required False
Max length  
Min length  
Nullable False
Enum False
Regex ^\d+$
Name UseIframe
Type Boolean
Description Should the login page be used in an iframe, the content will then be only the client and, the redirect is done in javascript.
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 UseWebMessaging
Type Boolean
Description Use HTML5 Web messaging to redirect iFrame, use this on newer device that have problem redirect because of not same origin policy in the browser.
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))$
{
    "ReturnUrlSuccess": "Http://www.yourdomain.no/signsuccess.aspx?signeeref=[0]&youruniqueref=[1]",
    "ReturnUrlError": "Http://www.yourdomain.no/error.aspx?signeeref=[0]&youruniqueref=[1]&errorcode=[2]",
    "ReturnUrlUserAbort": "Http://www.yourdomain.no/useraborted.aspx?signeeref=[0]&youruniqueref=[1]",
    "DocumentType": "PDF",
    "Filename": "contract.pdf",
    "Title": "Sales contract",
    "Description": "This document is a sales contract for car BS99999",
    "ExternalDocumentId": "1234",
    "SigneeRefs": [
        {
            "ExternalSigneeId": "1234",
            "FirstName": "Kari",
            "LastName": "Normann",
            "Mobile": "+4799775533",
            "Email": "kari@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SocialSecurityNumber": "24051212345",
            "SignOrder": 1,
            "UniqueRef": "8210132929654b8eb02bd7e33250c069",
            "BankIdPid": "9578-6000-4-48857",
            "SocSec": "82101329-2965-4b8e-b02b-d7e33250c069",
            "BuypassId": "100153378"
        },
        {
            "ExternalSigneeId": "1234",
            "FirstName": "Kari",
            "LastName": "Normann",
            "Mobile": "+4799775533",
            "Email": "kari@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SocialSecurityNumber": "24051212345",
            "SignOrder": 1,
            "UniqueRef": "8210132929654b8eb02bd7e33250c069",
            "BankIdPid": "9578-6000-4-48857",
            "SocSec": "82101329-2965-4b8e-b02b-d7e33250c069",
            "BuypassId": "100153378"
        }
    ],
    "CreatedByApplication": "Uni Eiendom",
    "Private": true,
    "Language": "EN",
    "PushNotificationUrl": "https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]&externaluniqueid=[5]",
    "GetSocialSecurityNumber": true,
    "CreatePADES": true,
    "HideDetailsPage": true,
    "ConvertToPDFA2b": true,
    "Domain": "www.domain.com",
    "IdentityProvider": "NO_BANKID_WEB",
    "UseIframe": true,
    "UseWebMessaging": true,
    "UrlExpiresMinutes": 5,
    "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'}"
        }
    ],
    "FileContent": "JVBERi0x....LjYNJeLjz9M",
    "FileXSLTContent": "JVBERi0x....LjYNJeLjz9M"
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateExternalSignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <ReturnUrlSuccess>Http://www.yourdomain.no/signsuccess.aspx?signeeref=[0]&youruniqueref=[1]</ReturnUrlSuccess>
   <ReturnUrlError>Http://www.yourdomain.no/error.aspx?signeeref=[0]&youruniqueref=[1]&errorcode=[2]</ReturnUrlError>
   <ReturnUrlUserAbort>Http://www.yourdomain.no/useraborted.aspx?signeeref=[0]&youruniqueref=[1]</ReturnUrlUserAbort>
   <DocumentType>PDF</DocumentType>
   <Filename>contract.pdf</Filename>
   <Title>Sales contract</Title>
   <Description>This document is a sales contract for car BS99999</Description>
   <ExternalDocumentId>1234</ExternalDocumentId>
   <SigneeRefs>
      <ExternalSigneeRef>
         <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>
         <UniqueRef>82101329-2965-4b8e-b02b-d7e33250c069</UniqueRef>
         <BankIdPid>9578-6000-4-48857</BankIdPid>
         <SocSec>82101329-2965-4b8e-b02b-d7e33250c069</SocSec>
         <BuypassId>100153378</BuypassId>
      </ExternalSigneeRef>
      <ExternalSigneeRef>
         <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>
         <UniqueRef>82101329-2965-4b8e-b02b-d7e33250c069</UniqueRef>
         <BankIdPid>9578-6000-4-48857</BankIdPid>
         <SocSec>82101329-2965-4b8e-b02b-d7e33250c069</SocSec>
         <BuypassId>100153378</BuypassId>
      </ExternalSigneeRef>
   </SigneeRefs>
   <CreatedByApplication>Uni Eiendom</CreatedByApplication>
   <Private>true</Private>
   <Language>EN</Language>
   <MetaData i:nil="true" />
   <PushNotificationUrl>https://www.company.no/externalnotfications?documentid=[0]&providerid=[1]&operation=[2]&externaldocumentid=[3]&signeeref=[4]&externaluniqueid=[5]</PushNotificationUrl>
   <GetSocialSecurityNumber>true</GetSocialSecurityNumber>
   <CreatePADES>true</CreatePADES>
   <HideDetailsPage>true</HideDetailsPage>
   <ConvertToPDFA2b>true</ConvertToPDFA2b>
   <Domain>www.domain.com</Domain>
   <IdentityProvider>NO_BANKID_WEB</IdentityProvider>
   <UseIframe>true</UseIframe>
   <UseWebMessaging>true</UseWebMessaging>
   <UrlExpiresMinutes>5</UrlExpiresMinutes>
   <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>
   <FileContent>JVBERi0x....LjYNJeLjz9M</FileContent>
   <FileXSLTContent>JVBERi0x....LjYNJeLjz9M</FileXSLTContent>
</CreateExternalSignRequest>
Response example
{
    "DocumentId": "8210132929654b8eb02bd7e33250c069"
}
<?xml version="1.0" encoding="utf-8"?>
<CreateExternalSignResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <CreatedSigneeRefs i:nil="true" />
   <DocumentId>82101329-2965-4b8e-b02b-d7e33250c069</DocumentId>
</CreateExternalSignResponse>
Name Type Description Example value Nullable Enum
List of CreateSigneeRefResponse False False
DocumentId Guid Signere.no identifier for the created document 82101329-2965-4b8e-b02b-d7e33250c069 False False