Description

Retrieves a document provider account (information such as the provider's username, billing address etc). Remark: if using Json, a GUID must not contain dashes (-), unlike XML.

HTTP method: GET
URI: https://api.signere.no/api/DocumentProvider/{ProviderId}
Autorization model: Minimum secondary apikey is needed for this operation.
Parameters
  • ProviderId: The document provider ID (GUID) (FromUri)
Response example
{
    "ProviderId": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "Name": "The Bank",
    "MvaNumber": "987654321",
    "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",
    "LastLogin": "2012-10-10T17:10:03.0000000",
    "FailedLoginCount": 0,
    "DealerId": "5515acea4896460c875fa08a00d4d3a9",
    "BillingPlan": "Large",
    "AllowedIPs": "192.168.1.1,192.168.1.2",
    "CompanyPhone": "+4755225522",
    "CompanyEmail": "post@company.com",
    "CompanyUrl": "http://www.company.com",
    "SMSSender": "UniPluss",
    "EmailSenderAddress": "post@firma.no",
    "HaveOwnBankIdCertificate": true,
    "PrePaid": true,
    "DemoProvider": true
}
<?xml version="1.0" encoding="utf-8"?>
<DocumentProviderResponse 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 i:nil="true" />
   <DemoProvider>true</DemoProvider>
   <EmailSenderAddress>post@firma.no</EmailSenderAddress>
   <FailedLoginCount>0</FailedLoginCount>
   <HaveOwnBankIdCertificate>true</HaveOwnBankIdCertificate>
   <LastLogin>2012-10-10T17:10:03</LastLogin>
   <LegalContactEmail>legal@thebank.com</LegalContactEmail>
   <LegalContactMobile>+4799887766</LegalContactMobile>
   <LegalContactName>James Dean</LegalContactName>
   <LegalContactPhone>+4722334455</LegalContactPhone>
   <MvaNumber>987654321</MvaNumber>
   <Name>The Bank</Name>
   <PrePaid>true</PrePaid>
   <ProviderId>1d4c883e-d2ce-48c8-b4a9-a08a00d4d3a4</ProviderId>
   <SMSSender>UniPluss</SMSSender>
</DocumentProviderResponse>
Name Type Description Example value Nullable Enum
AllowedIPs String If you want to limit the request to the API for your account to a certain IP-addresses then you can speficfy them as a comma seperated string. 192.168.1.1,192.168.1.2 False False
BillingAddress1 String The document provider's primary billing address Karl Johans gate 1 False False
BillingAddress2 String The document provider's secondary billing address Trondheimsveien 1 False False
BillingCity String The city in the billing address Oslo False False
BillingCountry String The country in the billing address Norway False False
BillingPlan String The document provider's chosen billing plan. For more information, see http://www.signere.no Large False False
BillingPostalCode String The postal code 0020 False False
BillingState String The state in the billing address (not necessary in Norway) False False
CompanyEmail String Company main emailadress post@company.com False False
CompanyPhone String Phone number to the company/organization +4755225522 False False
CompanyUrl String Url to the company web-site. http://www.company.com False False
DealerId Guid The ID (GUID) of the dealer that serves the document provider 5515ACEA4896460C875FA08A00D4D3A9 False False
DealerReference String The document provider's customer reference with the dealer, used when invoicing. False False
DemoProvider Boolean Is this a demo account true False False
EmailSenderAddress String Email address use as sender when sending email from this provider post@firma.no False False
FailedLoginCount Int32 The number of failed login attempts for the given document provider 0 False False
HaveOwnBankIdCertificate Boolean Does this provider have their own BankId certificate true False False
LastLogin DateTime The last time of login for the given document provider 2012-10-10T17:10:03.0000000 True False
LegalContactEmail String Email address to the legal contact person legal@thebank.com False False
LegalContactMobile String Mobile phone number to the legal contact person +4799887766 False False
LegalContactName String Name of the document provider's legal contact person James Dean False False
LegalContactPhone String Phone number to the legal contact person +4722334455 False False
MvaNumber String The MVA/organization number of the document provider 987654321 False False
Name String The name of the document provider The Bank False False
PrePaid Boolean Is this a prepaid account true False False
ProviderId Guid The unique ID (GUID) for the document provider that was created 1D4C883ED2CE48C8B4A9A08A00D4D3A4 False False
SMSSender String The text or number used as sender in the SMS UniPluss False False