Description

Retrieves the document with the given ID.

HTTP method: GET
URI: https://api.signere.no/api/Document/{DocumentId}
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document using forms" or "Sign document offline" or "Sign document online" or "Sign document on the portal"
Parameters
  • DocumentId: The ID (GUID) of the requested document. Remark: if using Json, a GUID must not contain dashes (-), unlike XML. (FromUri)
Response example
{
    "Id": "ea522127d971420595efa08a00d4d3ae",
    "SignJobId": "25b884825ab44850ac39a08a00d4d3ae",
    "ExternalDocumentId": "abc",
    "Title": "Sales contract",
    "Description": "This document is a sales contract for a car",
    "Language": "EN",
    "MetaData": [
        {
            "KeyName": "CreationDate",
            "Value": "2012-12-12"
        },
        {
            "KeyName": "CreationDate",
            "Value": "2012-12-12"
        }
    ],
    "SigneeRefs": [
        {
            "Id": "91fa608690db4852bd91a08a00d4d3af",
            "SigneeRefId": "91fa608690db4852bd91a08a00d4d3af",
            "ExternalSigneeId": "1245",
            "FirstName": "Ola",
            "LastName": "Nordmann",
            "Mobile": "+4799887766",
            "Email": "ola@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SignOrder": 1,
            "SignedTime": "2012-12-12T15:00:00.0000000",
            "Signed": false,
            "SignName": "Ola Nordmann",
            "DateOfBirth": "071283",
            "BankIdPid": "9578-6000-4-48857",
            "BuypassId": "100153378",
            "SocialSecurityNumber": "24051212345",
            "CertificateIssuer": "DnB",
            "SignUrl": "https://s.signere.no/agf14da2daf"
        },
        {
            "Id": "91fa608690db4852bd91a08a00d4d3af",
            "SigneeRefId": "91fa608690db4852bd91a08a00d4d3af",
            "ExternalSigneeId": "1245",
            "FirstName": "Ola",
            "LastName": "Nordmann",
            "Mobile": "+4799887766",
            "Email": "ola@normann.no",
            "OrgNo": "987654321",
            "CompanyName": "Example Company",
            "SignOrder": 1,
            "SignedTime": "2012-12-12T15:00:00.0000000",
            "Signed": false,
            "SignName": "Ola Nordmann",
            "DateOfBirth": "071283",
            "BankIdPid": "9578-6000-4-48857",
            "BuypassId": "100153378",
            "SocialSecurityNumber": "24051212345",
            "CertificateIssuer": "DnB",
            "SignUrl": "https://s.signere.no/agf14da2daf"
        }
    ],
    "UploadTime": "2012-10-01T15:00:00.0000000",
    "SignDeadline": "2012-10-14T00:00:00.0000000",
    "CanceledDate": "2012-10-03T14:30:00.0000000",
    "CancelationExplanation": "The car's registration number was wrong. Uploading new document",
    "CancelationSignature": "James Dean",
    "CanceledBySignee": false,
    "CanceledByProvider": true,
    "Contact_Name": "John Doe",
    "Contact_Phone": "+4722334455",
    "Contact_Mobile": "+4799887766",
    "Contact_Email": "contact@thebank.com",
    "Contact_Url": "www.thebank.com/contact",
    "NotifySenderWhenCanceledSMS": true,
    "NotifySenderWhenCanceledEmail": true,
    "SenderEmail": "post@signere.no",
    "SenderMobile": "+47999716935",
    "NotifiySenderWhenSignedSMS": true,
    "NotifySenderWhenSignedEmail": true,
    "NotifySigneerefsWhenSignedSMS": true,
    "NotifySigneerefsWhenSignedEmail": true,
    "Signed": true,
    "LastSignature": "2012-10-03T14:30:00.0000000",
    "MessageEmail": "The document is now ready to be signed. Please check your profile on signere.no",
    "TopicEmail": "The contract is ready",
    "Private": true,
    "ValidPDFA_2b": true,
    "ValidPDFA_2b_Report": "Report"
}
<?xml version="1.0" encoding="utf-8"?>
<DocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <CancelationExplanation>The car's registration number was wrong. Uploading new document</CancelationExplanation>
   <CancelationSignature>James Dean</CancelationSignature>
   <CanceledByProvider>true</CanceledByProvider>
   <CanceledBySignee>false</CanceledBySignee>
   <CanceledDate>2012-10-03T14:30:00</CanceledDate>
   <Contact_Email>contact@thebank.com</Contact_Email>
   <Contact_Mobile>+4799887766</Contact_Mobile>
   <Contact_Name>John Doe</Contact_Name>
   <Contact_Phone>+4722334455</Contact_Phone>
   <Contact_Url>www.thebank.com/contact</Contact_Url>
   <Description>This document is a sales contract for a car</Description>
   <ExternalDocumentId>abc</ExternalDocumentId>
   <Id>ea522127-d971-4205-95ef-a08a00d4d3ae</Id>
   <Language>EN</Language>
   <LastSignature>2012-10-03T14:30:00</LastSignature>
   <MessageEmail>The document is now ready to be signed. Please check your profile on signere.no</MessageEmail>
   <MetaData>
      <DocumentMetaData>
         <KeyName>CreationDate</KeyName>
         <Value>2012-12-12</Value>
      </DocumentMetaData>
      <DocumentMetaData>
         <KeyName>CreationDate</KeyName>
         <Value>2012-12-12</Value>
      </DocumentMetaData>
   </MetaData>
   <NotifiySenderWhenSignedSMS>true</NotifiySenderWhenSignedSMS>
   <NotifySenderWhenCanceledEmail>true</NotifySenderWhenCanceledEmail>
   <NotifySenderWhenCanceledSMS>true</NotifySenderWhenCanceledSMS>
   <NotifySenderWhenSignedEmail>true</NotifySenderWhenSignedEmail>
   <NotifySigneerefsWhenSignedEmail>true</NotifySigneerefsWhenSignedEmail>
   <NotifySigneerefsWhenSignedSMS>true</NotifySigneerefsWhenSignedSMS>
   <Private>true</Private>
   <SenderEmail>post@signere.no</SenderEmail>
   <SenderMobile>+47999716935</SenderMobile>
   <SignDeadline>2012-10-14T00:00:00</SignDeadline>
   <SignJobId>25b88482-5ab4-4850-ac39-a08a00d4d3ae</SignJobId>
   <Signed>true</Signed>
   <SigneeRefs>
      <Signee>
         <BankIdPid>9578-6000-4-48857</BankIdPid>
         <BuypassId>100153378</BuypassId>
         <CertificateIssuer>DnB</CertificateIssuer>
         <CompanyName>Example Company</CompanyName>
         <DateOfBirth>071283</DateOfBirth>
         <Email>ola@normann.no</Email>
         <ExternalSigneeId>1245</ExternalSigneeId>
         <FirstName>Ola</FirstName>
         <Id>91fa6086-90db-4852-bd91-a08a00d4d3af</Id>
         <LastName>Nordmann</LastName>
         <Mobile>+4799887766</Mobile>
         <OrgNo>987654321</OrgNo>
         <SignName>Ola Nordmann</SignName>
         <SignOrder>1</SignOrder>
         <SignUrl>https://s.signere.no/agf14da2daf</SignUrl>
         <Signed>false</Signed>
         <SignedTime>2012-12-12T15:00:00</SignedTime>
         <SigneeRefId>91fa6086-90db-4852-bd91-a08a00d4d3af</SigneeRefId>
         <SocialSecurityNumber>24051212345</SocialSecurityNumber>
      </Signee>
      <Signee>
         <BankIdPid>9578-6000-4-48857</BankIdPid>
         <BuypassId>100153378</BuypassId>
         <CertificateIssuer>DnB</CertificateIssuer>
         <CompanyName>Example Company</CompanyName>
         <DateOfBirth>071283</DateOfBirth>
         <Email>ola@normann.no</Email>
         <ExternalSigneeId>1245</ExternalSigneeId>
         <FirstName>Ola</FirstName>
         <Id>91fa6086-90db-4852-bd91-a08a00d4d3af</Id>
         <LastName>Nordmann</LastName>
         <Mobile>+4799887766</Mobile>
         <OrgNo>987654321</OrgNo>
         <SignName>Ola Nordmann</SignName>
         <SignOrder>1</SignOrder>
         <SignUrl>https://s.signere.no/agf14da2daf</SignUrl>
         <Signed>false</Signed>
         <SignedTime>2012-12-12T15:00:00</SignedTime>
         <SigneeRefId>91fa6086-90db-4852-bd91-a08a00d4d3af</SigneeRefId>
         <SocialSecurityNumber>24051212345</SocialSecurityNumber>
      </Signee>
   </SigneeRefs>
   <Title>Sales contract</Title>
   <TopicEmail>The contract is ready</TopicEmail>
   <UploadTime>2012-10-01T15:00:00</UploadTime>
   <ValidPDFA_2b>true</ValidPDFA_2b>
   <ValidPDFA_2b_Report>Report</ValidPDFA_2b_Report>
</DocumentResponse>
Name Type Description Example value Nullable Enum
CancelationExplanation String An explanation for why the document was canceled The car's registration number was wrong. Uploading new document False False
CancelationSignature String The signature of the person that canceled the document James Dean False False
CanceledByProvider Boolean Indicates whether the document was canceled by the document provider true False False
CanceledBySignee Boolean Indicates whether the document was canceled by the signee false False False
CanceledDate DateTime The date when (possibly) the document was canceled 2012-10-03T14:30:00.0000000 True False
Contact_Email String The e-mail address to the contact person contact@thebank.com False False
Contact_Mobile String The mobile phone number to the contact person +4799887766 False False
Contact_Name String The name of the document provider's contact person John Doe False False
Contact_Phone String The phone number to the contact person +4722334455 False False
Contact_Url String An URL for contact details. For instance the contact person's profile/home page on the public sites of the document provider www.thebank.com/contact False False
Description String Description of the document This document is a sales contract for a car False False
ExternalDocumentId String An external ID for the document. This could for instance be the document provider's internal document reference number abc False False
Id Guid The ID (GUID) of the document EA522127D971420595EFA08A00D4D3AE False False
Language String Language of the document EN False False
LastSignature DateTime Timestamp for the last signature on the document. 2012-10-03T14:30:00.0000000 True False
MessageEmail String The message body in the e-mail The document is now ready to be signed. Please check your profile on signere.no False False
List of DocumentMetaData Document metadata False False
NotifiySenderWhenSignedSMS Boolean true False False
NotifySenderWhenCanceledEmail Boolean true False False
NotifySenderWhenCanceledSMS Boolean true False False
NotifySenderWhenSignedEmail Boolean true False False
NotifySigneerefsWhenSignedEmail Boolean true False False
NotifySigneerefsWhenSignedSMS Boolean true False False
Private Boolean Set if document is considered private, and should only be visible on portal for administrators true False False
SenderEmail String post@signere.no False False
SenderMobile String +47999716935 False False
SignDeadline DateTime The deadline for signature. After this, the document will no longer be possible to sign 2012-10-14T00:00:00.0000000 True False
Signed Boolean Indicates whether the document is signed (all signeerefs have to have signed, in order to consider a document signed true False False
List of Signee List of Signeeref on the document False False
SignJobId Guid The ID (GUID) of the sign job with which the document is associated 25B884825AB44850AC39A08A00D4D3AE False False
Title String Title of the document Sales contract False False
TopicEmail String The topic field in the e-mail The contract is ready False False
UploadTime DateTime The date when the document was uploaded 2012-10-01T15:00:00.0000000 False False
ValidPDFA_2b Boolean Indicates if the document conforms 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 true False False
ValidPDFA_2b_Report String If not valid it returns a report of elements in the PDF that is not compliant with the PDF/A-2 level b standard. In the future this will be required from Norwegian BankID Report False False