POST api/sign

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
recipientArray	Collection of Recipient	Required
signMethod	SignMethod	Required
subject	string	Required
text	string	Required
fileName	string	Required
attachmentName	string	Required
printCommand	string	Required
SignRequest	AddSignatureRequest	None.
ExtraParams	Collection of Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "recipientArray": [
    {
      "phoneNumber": "sample string 1",
      "email": "sample string 2"
    },
    {
      "phoneNumber": "sample string 1",
      "email": "sample string 2"
    }
  ],
  "signMethod": 0,
  "subject": "sample string 1",
  "text": "sample string 2",
  "fileName": "sample string 3",
  "attachmentName": "sample string 4",
  "printCommand": "sample string 5",
  "SignRequest": {
    "SignatureId": 1,
    "JobId": "sample string 2",
    "FromAddress": "sample string 3",
    "FromName": "sample string 4",
    "SingleSignatureUrl": "sample string 5",
    "JobSignaturesUrl": "sample string 6",
    "UserId": 7,
    "ClientNumber": 8,
    "ReportName": "sample string 9",
    "Sender": "sample string 10",
    "CancelSignatureReason": "sample string 11",
    "FullySigned": true,
    "SignedOfJob": "sample string 12",
    "CancelSignatureDate": "2026-08-21T08:31:36.1912842+00:00",
    "RecentEventDate": "2026-08-21T08:31:36.1912842+00:00",
    "ViewedDate": "2026-08-21T08:31:36.1912842+00:00",
    "SignatureDate": "2026-08-21T08:31:36.1912842+00:00",
    "CancelConfirmTo": "sample string 13",
    "SignedContractBlob": "QEA=",
    "SignedContractBlobUrl": "sample string 14",
    "SignProjects": [
      {
        "ProjectId": 1,
        "ProjectTaskId": 2,
        "DeviationId": 3
      },
      {
        "ProjectId": 1,
        "ProjectTaskId": 2,
        "DeviationId": 3
      }
    ]
  },
  "ExtraParams": [
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<TransitTarget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProjectPortal.SignAPI.Models">
  <ExtraParams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </ExtraParams>
  <SignRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProjectPortal.DTO.Request">
    <d2p1:CancelConfirmTo>sample string 13</d2p1:CancelConfirmTo>
    <d2p1:CancelSignatureDate>2026-08-21T08:31:36.1912842+00:00</d2p1:CancelSignatureDate>
    <d2p1:CancelSignatureReason>sample string 11</d2p1:CancelSignatureReason>
    <d2p1:ClientNumber>8</d2p1:ClientNumber>
    <d2p1:FromAddress>sample string 3</d2p1:FromAddress>
    <d2p1:FromName>sample string 4</d2p1:FromName>
    <d2p1:FullySigned>true</d2p1:FullySigned>
    <d2p1:JobId>sample string 2</d2p1:JobId>
    <d2p1:JobSignaturesUrl>sample string 6</d2p1:JobSignaturesUrl>
    <d2p1:RecentEventDate>2026-08-21T08:31:36.1912842+00:00</d2p1:RecentEventDate>
    <d2p1:ReportName>sample string 9</d2p1:ReportName>
    <d2p1:Sender>sample string 10</d2p1:Sender>
    <d2p1:SignProjects>
      <d2p1:SignProjectRequest>
        <d2p1:DeviationId>3</d2p1:DeviationId>
        <d2p1:ProjectId>1</d2p1:ProjectId>
        <d2p1:ProjectTaskId>2</d2p1:ProjectTaskId>
      </d2p1:SignProjectRequest>
      <d2p1:SignProjectRequest>
        <d2p1:DeviationId>3</d2p1:DeviationId>
        <d2p1:ProjectId>1</d2p1:ProjectId>
        <d2p1:ProjectTaskId>2</d2p1:ProjectTaskId>
      </d2p1:SignProjectRequest>
    </d2p1:SignProjects>
    <d2p1:SignatureDate>2026-08-21T08:31:36.1912842+00:00</d2p1:SignatureDate>
    <d2p1:SignatureId>1</d2p1:SignatureId>
    <d2p1:SignedContractBlob>QEA=</d2p1:SignedContractBlob>
    <d2p1:SignedContractBlobUrl>sample string 14</d2p1:SignedContractBlobUrl>
    <d2p1:SignedOfJob>sample string 12</d2p1:SignedOfJob>
    <d2p1:SingleSignatureUrl>sample string 5</d2p1:SingleSignatureUrl>
    <d2p1:UserId>7</d2p1:UserId>
    <d2p1:ViewedDate>2026-08-21T08:31:36.1912842+00:00</d2p1:ViewedDate>
  </SignRequest>
  <attachmentName>sample string 4</attachmentName>
  <fileName>sample string 3</fileName>
  <printCommand>sample string 5</printCommand>
  <recipientArray>
    <Recipient>
      <email>sample string 2</email>
      <phoneNumber>sample string 1</phoneNumber>
    </Recipient>
    <Recipient>
      <email>sample string 2</email>
      <phoneNumber>sample string 1</phoneNumber>
    </Recipient>
  </recipientArray>
  <signMethod>bankid_show_personal_identity_number</signMethod>
  <subject>sample string 1</subject>
  <text>sample string 2</text>
</TransitTarget>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TransitTarget'.

Response Information

Resource Description

ResponseObj

Name	Description	Type	Additional information
job_id		string	None.
message		string	None.

Response Formats

application/json, text/json

Sample:

{
  "job_id": "sample string 1",
  "message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseObj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProjectPortal.SignAPI.Models">
  <job_id>sample string 1</job_id>
  <message>sample string 2</message>
</ResponseObj>