POST VerifiedAPI/SendKonvolutt

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
dataSource	DataSourceEnum	None.
heimEnvelopeType	HeimEnvelopeType	None.
heimEnvelopeId	string	None.
name	string	None.
heimEnvelopeRevision	integer	None.
username	string	None.
countDocToBeSigned	integer	None.
countAttachments	integer	None.
heimRecipientList	Collection of HeimRecipient	None.
heimDocumentList	Collection of HeimDocument	None.
sequentialSigning	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "dataSource": 0,
  "heimEnvelopeType": 0,
  "heimEnvelopeId": "sample string 1",
  "name": "sample string 2",
  "heimEnvelopeRevision": 3,
  "username": "sample string 4",
  "countDocToBeSigned": 5,
  "countAttachments": 6,
  "heimRecipientList": [
    {
      "dataSource": 0,
      "heimRecipientId": "sample string 1",
      "heimSigningMethod": 0,
      "recipient": {
        "uid": "sample string 1",
        "company": "sample string 2",
        "email": "sample string 3",
        "familyName": "sample string 4",
        "givenName": "sample string 5",
        "language": "sample string 6",
        "order": 7,
        "organizationNumber": "sample string 8",
        "role": {
          "action": "sample string 1",
          "name": "sample string 2"
        },
        "signingMethod": "sample string 9",
        "telephone": "sample string 10"
      }
    },
    {
      "dataSource": 0,
      "heimRecipientId": "sample string 1",
      "heimSigningMethod": 0,
      "recipient": {
        "uid": "sample string 1",
        "company": "sample string 2",
        "email": "sample string 3",
        "familyName": "sample string 4",
        "givenName": "sample string 5",
        "language": "sample string 6",
        "order": 7,
        "organizationNumber": "sample string 8",
        "role": {
          "action": "sample string 1",
          "name": "sample string 2"
        },
        "signingMethod": "sample string 9",
        "telephone": "sample string 10"
      }
    }
  ],
  "heimDocumentList": [
    {
      "dataSource": 0,
      "heimDocId": "sample string 1",
      "heimDokSignType": 10,
      "fileDetails": {
        "Name": "sample string 1",
        "Path": "sample string 2",
        "Type": "sample string 3"
      }
    },
    {
      "dataSource": 0,
      "heimDocId": "sample string 1",
      "heimDokSignType": 10,
      "fileDetails": {
        "Name": "sample string 1",
        "Path": "sample string 2",
        "Type": "sample string 3"
      }
    }
  ],
  "sequentialSigning": true
}

application/xml, text/xml

Sample:

<HeimEnvelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModel.ModelsSignering">
  <countAttachments>6</countAttachments>
  <countDocToBeSigned>5</countDocToBeSigned>
  <dataSource>Unknown</dataSource>
  <heimDocumentList>
    <HeimDocument>
      <dataSource>Unknown</dataSource>
      <fileDetails>
        <Name>sample string 1</Name>
        <Path>sample string 2</Path>
        <Type>sample string 3</Type>
      </fileDetails>
      <heimDocId>sample string 1</heimDocId>
      <heimDokSignType>SignThisDoc</heimDokSignType>
    </HeimDocument>
    <HeimDocument>
      <dataSource>Unknown</dataSource>
      <fileDetails>
        <Name>sample string 1</Name>
        <Path>sample string 2</Path>
        <Type>sample string 3</Type>
      </fileDetails>
      <heimDocId>sample string 1</heimDocId>
      <heimDokSignType>SignThisDoc</heimDokSignType>
    </HeimDocument>
  </heimDocumentList>
  <heimEnvelopeId>sample string 1</heimEnvelopeId>
  <heimEnvelopeRevision>3</heimEnvelopeRevision>
  <heimEnvelopeType>Unknown</heimEnvelopeType>
  <heimRecipientList>
    <HeimRecipient>
      <dataSource>Unknown</dataSource>
      <heimRecipientId>sample string 1</heimRecipientId>
      <heimSigningMethod>Unknown</heimSigningMethod>
      <recipient>
        <Company>sample string 2</Company>
        <Email>sample string 3</Email>
        <FamilyName>sample string 4</FamilyName>
        <GivenName>sample string 5</GivenName>
        <Language>sample string 6</Language>
        <Order>7</Order>
        <OrganizationNumber>sample string 8</OrganizationNumber>
        <Role>
          <Action>sample string 1</Action>
          <Name>sample string 2</Name>
        </Role>
        <SigningMethod>sample string 9</SigningMethod>
        <Telephone>sample string 10</Telephone>
        <Uid>sample string 1</Uid>
      </recipient>
    </HeimRecipient>
    <HeimRecipient>
      <dataSource>Unknown</dataSource>
      <heimRecipientId>sample string 1</heimRecipientId>
      <heimSigningMethod>Unknown</heimSigningMethod>
      <recipient>
        <Company>sample string 2</Company>
        <Email>sample string 3</Email>
        <FamilyName>sample string 4</FamilyName>
        <GivenName>sample string 5</GivenName>
        <Language>sample string 6</Language>
        <Order>7</Order>
        <OrganizationNumber>sample string 8</OrganizationNumber>
        <Role>
          <Action>sample string 1</Action>
          <Name>sample string 2</Name>
        </Role>
        <SigningMethod>sample string 9</SigningMethod>
        <Telephone>sample string 10</Telephone>
        <Uid>sample string 1</Uid>
      </recipient>
    </HeimRecipient>
  </heimRecipientList>
  <name>sample string 2</name>
  <sequentialSigning>true</sequentialSigning>
  <username>sample string 4</username>
</HeimEnvelope>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HeimEnvelopeResponse

Name	Type	Additional information
dataSource	DataSourceEnum	None.
heimEnvelopeId	string	None.
verifiedEnvelopeId	string	None.
heimRecipientResponseList	Collection of HeimRecipientResponse	None.
heimDocumentResponseList	Collection of HeimDocumentResponse	None.
httpStatus	string	None.

Response Formats

application/json, text/json

Sample:

{
  "dataSource": 0,
  "heimEnvelopeId": "sample string 1",
  "verifiedEnvelopeId": "sample string 2",
  "heimRecipientResponseList": [
    {
      "dataSource": 0,
      "heimEnvelopeId": "sample string 1",
      "heimRecipientId": "sample string 2",
      "verifiedRecipientId": "sample string 3",
      "heimSignStatus": 0,
      "httpStatus": "sample string 4"
    },
    {
      "dataSource": 0,
      "heimEnvelopeId": "sample string 1",
      "heimRecipientId": "sample string 2",
      "verifiedRecipientId": "sample string 3",
      "heimSignStatus": 0,
      "httpStatus": "sample string 4"
    }
  ],
  "heimDocumentResponseList": [
    {
      "dataSource": 0,
      "heimEnvelopeId": "sample string 1",
      "heimDokSignType": 10,
      "heimDocId": "sample string 2",
      "verifiedDocId": "sample string 3",
      "verifiedDocUrl": "sample string 4",
      "httpStatus": "sample string 5"
    },
    {
      "dataSource": 0,
      "heimEnvelopeId": "sample string 1",
      "heimDokSignType": 10,
      "heimDocId": "sample string 2",
      "verifiedDocId": "sample string 3",
      "verifiedDocUrl": "sample string 4",
      "httpStatus": "sample string 5"
    }
  ],
  "httpStatus": "sample string 3"
}

application/xml, text/xml

Sample:

<HeimEnvelopeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModel.ModelsSignering">
  <dataSource>Unknown</dataSource>
  <heimDocumentResponseList>
    <HeimDocumentResponse>
      <dataSource>Unknown</dataSource>
      <heimDocId>sample string 2</heimDocId>
      <heimDokSignType>SignThisDoc</heimDokSignType>
      <heimEnvelopeId>sample string 1</heimEnvelopeId>
      <httpStatus>sample string 5</httpStatus>
      <verifiedDocId>sample string 3</verifiedDocId>
      <verifiedDocUrl>sample string 4</verifiedDocUrl>
    </HeimDocumentResponse>
    <HeimDocumentResponse>
      <dataSource>Unknown</dataSource>
      <heimDocId>sample string 2</heimDocId>
      <heimDokSignType>SignThisDoc</heimDokSignType>
      <heimEnvelopeId>sample string 1</heimEnvelopeId>
      <httpStatus>sample string 5</httpStatus>
      <verifiedDocId>sample string 3</verifiedDocId>
      <verifiedDocUrl>sample string 4</verifiedDocUrl>
    </HeimDocumentResponse>
  </heimDocumentResponseList>
  <heimEnvelopeId>sample string 1</heimEnvelopeId>
  <heimRecipientResponseList>
    <HeimRecipientResponse>
      <dataSource>Unknown</dataSource>
      <heimEnvelopeId>sample string 1</heimEnvelopeId>
      <heimRecipientId>sample string 2</heimRecipientId>
      <heimSignStatus>Unknown</heimSignStatus>
      <httpStatus>sample string 4</httpStatus>
      <verifiedRecipientId>sample string 3</verifiedRecipientId>
    </HeimRecipientResponse>
    <HeimRecipientResponse>
      <dataSource>Unknown</dataSource>
      <heimEnvelopeId>sample string 1</heimEnvelopeId>
      <heimRecipientId>sample string 2</heimRecipientId>
      <heimSignStatus>Unknown</heimSignStatus>
      <httpStatus>sample string 4</httpStatus>
      <verifiedRecipientId>sample string 3</verifiedRecipientId>
    </HeimRecipientResponse>
  </heimRecipientResponseList>
  <httpStatus>sample string 3</httpStatus>
  <verifiedEnvelopeId>sample string 2</verifiedEnvelopeId>
</HeimEnvelopeResponse>