POST api/KNMID/cmnInitiateSigningRequest

Request Information

URI Parameters

None.

Body Parameters

cmnPAISigningRequest
NameDescriptionTypeAdditional information
CivilIDNumber

string

None.

PromptEN

string

None.

PromptAR

string

None.

SigningReasonEN

string

None.

SigningReasonAR

string

None.

AdditionalData

string

None.

FileName

string

None.

PreviewFile

string

None.

PDFPageIndex

integer

None.

posleft

integer

None.

posBottom

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CivilIDNumber": "sample string 1",
  "PromptEN": "sample string 2",
  "PromptAR": "sample string 3",
  "SigningReasonEN": "sample string 4",
  "SigningReasonAR": "sample string 5",
  "AdditionalData": "sample string 6",
  "FileName": "sample string 7",
  "PreviewFile": "sample string 8",
  "PDFPageIndex": 9,
  "posleft": 10,
  "posBottom": 11
}

application/xml, text/xml

Sample:
<cmnPAISigningRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CivilIDNumber>sample string 1</CivilIDNumber>
  <PromptEN>sample string 2</PromptEN>
  <PromptAR>sample string 3</PromptAR>
  <SigningReasonEN>sample string 4</SigningReasonEN>
  <SigningReasonAR>sample string 5</SigningReasonAR>
  <AdditionalData>sample string 6</AdditionalData>
  <FileName>sample string 7</FileName>
  <PreviewFile>sample string 8</PreviewFile>
  <PDFPageIndex>9</PDFPageIndex>
  <posleft>10</posleft>
  <posBottom>11</posBottom>
</cmnPAISigningRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MIDAuthSignClientResponseOfString
NameDescriptionTypeAdditional information
Error

CuError

None.

Data

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "Code": 1,
    "Message": "sample string 2"
  },
  "Data": "sample string 1"
}

application/xml, text/xml

Sample:
<MIDAuthSignClientResponseOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Code>1</Code>
    <Message>sample string 2</Message>
  </Error>
  <Data>sample string 1</Data>
</MIDAuthSignClientResponseOfString>