Description

Creates a new document provider (account for submitting documents). Returns the account ID and the primary and secondary API keys.

HTTP method: POST
URI: https://api.signere.no/api/DocumentProvider
Autorization model: No apikey is neeeded for this operation.
Parameters
  • request: Contains all necessary parameters for creating a new document provider account. ProviderLogo_filecontent should be a base64-encoded string. (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
AllowedIPs String Limits the requests to the API for the given account to certain IP addresses. To make a list, specify the addresses as a comma separated string. 192.168.1.1,192.168.1.2 False 255   False False ^(\b(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]?)\.(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]?)\b,?)+$
BillingAddress1 String The document provider's primary billing address Karl Johans gate 1 True 255   False False
BillingAddress2 String The document provider's secondary billing address Trondheimsveien 1 False 255   False False
BillingCity String The city in the billing address Oslo True 255   False False
BillingCountry String The country in the billing address Norway False 255   False False
BillingPlans The document provider's chosen billing plan. For more information, see http://www.signere.no Large False 6 5 False True
BillingPostalCode String The postal code 0020 True 255   False False ^[0-9]{4}$
BillingState String The state in the billing address (not applicable in Norway) False 255   False False
CompanyEmail String Company main emailadress post@company.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])?
CompanyPhone String Phone number to the company/organization +4755225522 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})$
CompanyUrl String Url to the company web-site. http://www.company.com 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\[\]\;\@\=_.-]+)
DealerId Guid The ID (GUID) of the dealer that serves the document provider 5515ACEA4896460C875FA08A00D4D3A9 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})$
DealerReference String The document provider's customer reference with the dealer, used for invoicing. 114104 False 255   False False
EmailSenderAddress String Email address use as sender when sending email from this provider post@firma.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])?
LegalContactEmail String Email address to the legal contact person legal@thebank.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])?
LegalContactMobile String Mobile phone number to the legal contact person +4799887766 False 11 11 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})$
LegalContactName String Name of the document provider's legal contact person James Dean True 255   False False
LegalContactPhone String Phone number to the legal 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})$
MvaNumber String The MVA/organization number of the document provider 987654321 True 9 9 False False ^([8|9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])$
Name String The name of the document provider The Bank True 255   False False
OrderBankIDCertificateToMe Boolean To order a BankID certificate through signere.no, set this variable to true. See http://www.signere.no for more information. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
ProviderLogo_filecontent String The file content of the document provider's logo, used in the header when signing and viewing documents. It should be encoded as a base64 string (UTF-8) JVBERi0x.....LjYNJeLjz False 255   False False (([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?){1}
ProviderLogo_filename String The filename for the logo file, used to determine the filetype. Supported formats are: (png, gif, jpg, jpeg, bmp). bankid_logo.jpg False 255   False False ([a-z]|[A-Z]|[1-9]| ]*)\.(((p|P)(n|N)(g|G))|((g|G)(i|I)(f|F))|((j|J)(p|P)(g|G))|((j|J)(p|P)(e|E)(g|G))|((b|B)(m|M)(p|P)))
SMSSender String The text or number used as sender in the SMS UniPluss False 11   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name AllowedIPs
Type String
Description Limits the requests to the API for the given account to certain IP addresses. To make a list, specify the addresses as a comma separated string.
Example value 192.168.1.1,192.168.1.2
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^(\b(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]?)\.(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]?)\b,?)+$
Name BillingAddress1
Type String
Description The document provider's primary billing address
Example value Karl Johans gate 1
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex
Name BillingAddress2
Type String
Description The document provider's secondary billing address
Example value Trondheimsveien 1
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name BillingCity
Type String
Description The city in the billing address
Example value Oslo
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex
Name BillingCountry
Type String
Description The country in the billing address
Example value Norway
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name BillingPlan
Type BillingPlans
Description The document provider's chosen billing plan. For more information, see http://www.signere.no
Example value Large
Required False
Max length 6
Min length 5
Nullable False
Enum True
Regex
Name BillingPostalCode
Type String
Description The postal code
Example value 0020
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ^[0-9]{4}$
Name BillingState
Type String
Description The state in the billing address (not applicable in Norway)
Example value
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name CompanyEmail
Type String
Description Company main emailadress
Example value post@company.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 CompanyPhone
Type String
Description Phone number to the company/organization
Example value +4755225522
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 CompanyUrl
Type String
Description Url to the company web-site.
Example value http://www.company.com
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 DealerId
Type Guid
Description The ID (GUID) of the dealer that serves the document provider
Example value 5515ACEA4896460C875FA08A00D4D3A9
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 DealerReference
Type String
Description The document provider's customer reference with the dealer, used for invoicing.
Example value 114104
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name EmailSenderAddress
Type String
Description Email address use as sender when sending email from this provider
Example value post@firma.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 LegalContactEmail
Type String
Description Email address to the legal contact person
Example value legal@thebank.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 LegalContactMobile
Type String
Description Mobile phone number to the legal contact person
Example value +4799887766
Required False
Max length 11
Min length 11
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 LegalContactName
Type String
Description Name of the document provider's legal contact person
Example value James Dean
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex
Name LegalContactPhone
Type String
Description Phone number to the legal 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 MvaNumber
Type String
Description The MVA/organization number of the document provider
Example value 987654321
Required True
Max length 9
Min length 9
Nullable False
Enum False
Regex ^([8|9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])$
Name Name
Type String
Description The name of the document provider
Example value The Bank
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex
Name OrderBankIDCertificateToMe
Type Boolean
Description To order a BankID certificate through signere.no, set this variable to true. See http://www.signere.no for more information.
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 ProviderLogo_filecontent
Type String
Description The file content of the document provider's logo, used in the header when signing and viewing documents. It should be encoded as a base64 string (UTF-8)
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}
Name ProviderLogo_filename
Type String
Description The filename for the logo file, used to determine the filetype. Supported formats are: (png, gif, jpg, jpeg, bmp).
Example value bankid_logo.jpg
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ([a-z]|[A-Z]|[1-9]| ]*)\.(((p|P)(n|N)(g|G))|((g|G)(i|I)(f|F))|((j|J)(p|P)(g|G))|((j|J)(p|P)(e|E)(g|G))|((b|B)(m|M)(p|P)))
Name SMSSender
Type String
Description The text or number used as sender in the SMS
Example value UniPluss
Required False
Max length 11
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
{
    "Name": "The Bank",
    "MvaNumber": "987654321",
    "CompanyPhone": "+4755225522",
    "CompanyEmail": "post@company.com",
    "CompanyUrl": "http://www.company.com",
    "LegalContactName": "James Dean",
    "LegalContactPhone": "+4722334455",
    "LegalContactMobile": "+4799887766",
    "LegalContactEmail": "legal@thebank.com",
    "BillingAddress1": "Karl Johans gate 1",
    "BillingAddress2": "Trondheimsveien 1",
    "BillingPostalCode": "0020",
    "BillingCity": "Oslo",
    "BillingCountry": "Norway",
    "DealerId": "5515acea4896460c875fa08a00d4d3a9",
    "DealerReference": "114104",
    "BillingPlan": "Large",
    "ProviderLogo_filecontent": "JVBERi0x.....LjYNJeLjz",
    "ProviderLogo_filename": "bankid_logo.jpg",
    "AllowedIPs": "192.168.1.1,192.168.1.2",
    "OrderBankIDCertificateToMe": true,
    "SMSSender": "UniPluss",
    "EmailSenderAddress": "post@firma.no"
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateDocumentProviderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <AllowedIPs>192.168.1.1,192.168.1.2</AllowedIPs>
   <BillingAddress1>Karl Johans gate 1</BillingAddress1>
   <BillingAddress2>Trondheimsveien 1</BillingAddress2>
   <BillingCity>Oslo</BillingCity>
   <BillingCountry>Norway</BillingCountry>
   <BillingPlan>Large</BillingPlan>
   <BillingPostalCode>0020</BillingPostalCode>
   <BillingState i:nil="true" />
   <CompanyEmail>post@company.com</CompanyEmail>
   <CompanyPhone>+4755225522</CompanyPhone>
   <CompanyUrl>http://www.company.com</CompanyUrl>
   <DealerId>5515acea-4896-460c-875f-a08a00d4d3a9</DealerId>
   <DealerReference>114104</DealerReference>
   <EmailSenderAddress>post@firma.no</EmailSenderAddress>
   <LegalContactEmail>legal@thebank.com</LegalContactEmail>
   <LegalContactMobile>+4799887766</LegalContactMobile>
   <LegalContactName>James Dean</LegalContactName>
   <LegalContactPhone>+4722334455</LegalContactPhone>
   <MvaNumber>987654321</MvaNumber>
   <Name>The Bank</Name>
   <OrderBankIDCertificateToMe>true</OrderBankIDCertificateToMe>
   <ProviderLogo_filecontent>JVBERi0x.....LjYNJeLjz</ProviderLogo_filecontent>
   <ProviderLogo_filename>bankid_logo.jpg</ProviderLogo_filename>
   <SMSSender>UniPluss</SMSSender>
</CreateDocumentProviderRequest>
Response example
{
    "ProviderId": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "PrimaryApiKey": "REg5Um12TlpBY3FzM3Y0QURDWExrZz09LHhRbnpuK1RXZzUxV1Y1R0lvWlpEdUJ2UXRFUmQ2VGpXZTEzTmhTeWVkQ0U9",
    "SecondaryApiKey": "bFFVUGF6RkFWaG9uTE83TDJtWVU3Zz09LGQ3UjZGRkt6SkpydUNmb2pTZ0krRlc3Um9ib2k2UG9ZSWFudlNmcTIrQTg9"
}
<?xml version="1.0" encoding="utf-8"?>
<CreateProviderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <PrimaryApiKey>REg5Um12TlpBY3FzM3Y0QURDWExrZz09LHhRbnpuK1RXZzUxV1Y1R0lvWlpEdUJ2UXRFUmQ2VGpXZTEzTmhTeWVkQ0U9</PrimaryApiKey>
   <ProviderId>1d4c883e-d2ce-48c8-b4a9-a08a00d4d3a4</ProviderId>
   <SecondaryApiKey>bFFVUGF6RkFWaG9uTE83TDJtWVU3Zz09LGQ3UjZGRkt6SkpydUNmb2pTZ0krRlc3Um9ib2k2UG9ZSWFudlNmcTIrQTg9</SecondaryApiKey>
</CreateProviderResponse>
Name Type Description Example value Nullable Enum
PrimaryApiKey String The primary key for the document provider (issued by signere.no) REg5Um12TlpBY3FzM3Y0QURDWExrZz09LHhRbnpuK1RXZzUxV1Y1R0lvWlpEdUJ2UXRFUmQ2VGpXZTEzTmhTeWVkQ0U9 False False
ProviderId Guid The ID (GUID) for the document provider (issued by signere.no) 1D4C883ED2CE48C8B4A9A08A00D4D3A4 False False
SecondaryApiKey String The secondary key for the document provider (issued by signere.no) bFFVUGF6RkFWaG9uTE83TDJtWVU3Zz09LGQ3UjZGRkt6SkpydUNmb2pTZ0krRlc3Um9ib2k2UG9ZSWFudlNmcTIrQTg9 False False