POST api/KNMID/InitiateSigningRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
ServiceProviderID	globally unique identifier	None.
RequestType	string	None.
PromptEN	string	None.
PromptAR	string	None.
SigningReasonEN	string	None.
SigningReasonAR	string	None.
AdditionalData	string	None.
Challenge	string	None.
SPCallBackURL	string	None.
PersonCivilNo	string	None.
PreviewFile	string	None.
FileType	string	None.
FileName	string	None.
RequestUserDetails	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "ServiceProviderID": "29161037-1952-405f-b3b5-dc7a550b6ec0",
  "RequestType": "sample string 3",
  "PromptEN": "sample string 4",
  "PromptAR": "sample string 5",
  "SigningReasonEN": "sample string 6",
  "SigningReasonAR": "sample string 7",
  "AdditionalData": "sample string 8",
  "Challenge": "sample string 9",
  "SPCallBackURL": "sample string 10",
  "PersonCivilNo": "sample string 11",
  "PreviewFile": "sample string 12",
  "FileType": "sample string 13",
  "FileName": "sample string 14",
  "RequestUserDetails": true
}

application/xml, text/xml

Sample:

<PAISigningRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <ServiceProviderID>29161037-1952-405f-b3b5-dc7a550b6ec0</ServiceProviderID>
  <RequestType>sample string 3</RequestType>
  <PromptEN>sample string 4</PromptEN>
  <PromptAR>sample string 5</PromptAR>
  <SigningReasonEN>sample string 6</SigningReasonEN>
  <SigningReasonAR>sample string 7</SigningReasonAR>
  <AdditionalData>sample string 8</AdditionalData>
  <Challenge>sample string 9</Challenge>
  <SPCallBackURL>sample string 10</SPCallBackURL>
  <PersonCivilNo>sample string 11</PersonCivilNo>
  <PreviewFile>sample string 12</PreviewFile>
  <FileType>sample string 13</FileType>
  <FileName>sample string 14</FileName>
  <RequestUserDetails>true</RequestUserDetails>
</PAISigningRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SigningResponse

Name	Type	Additional information
Result	string	None.
challenge	string	None.
PACIRequestID	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": "sample string 1",
  "challenge": "sample string 2",
  "PACIRequestID": "sample string 3"
}

application/xml, text/xml

Sample:

<SigningResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>sample string 1</Result>
  <challenge>sample string 2</challenge>
  <PACIRequestID>sample string 3</PACIRequestID>
</SigningResponse>