Sertifi API Web Service
Method/testsite/Services/Gateway.asmx/GetFileSigners
Description
Get an xml list of each signer and the status of their signature.
Request (GetFileSignersSoapIn)

The request body is of type GetFileSigners.

Request Body Parameters

NameDescriptionData Type
pstr_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
pstr_FileIDThe id of the relevant file.xml:string
pstr_FileID Element pstr_APICode Element Sequence GetFileSigners Element
Response (GetFileSignersSoapOut)

The response body is of type GetFileSignersResponse.

Response Body Parameters

NameDescriptionData Type
GetFileSignersResult xml:string
GetFileSignersResult Element Sequence GetFileSignersResponse Element
Example

Sample Call:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/">
   <soap:Header/>
   <soap:Body>
      <ser:GetFileSigners>
         <ser:pstr_APICode>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</ser:pstr_APICode>
         <ser:pstr_FileID>dpZaMtBrYvE=</ser:pstr_FileID>
      </ser:GetFileSigners>
   </soap:Body>
</soap:Envelope>

Sample Response:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetFileSignersResponse xmlns="http://apps.sertifi.net/services/">
         <GetFileSignersResult><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<Signers>
  <Signer>
    <DocumentID>+7tvlFanzEU=</DocumentID>
    <Status>Unsigned</Status>
    <Email>[email protected]</Email>
    <NameSigned />
    <IpAddress />
    <SignMethod>Electronic</SignMethod>
    <DateSigned>1/1/0001 12:00:00 AM</DateSigned>
  </Signer>
</Signers>]]></GetFileSignersResult>
      </GetFileSignersResponse>
   </soap:Body>
</soap:Envelope>

Remarks
Common Errors include:
"ERROR: Invalid API Code"
"ERROR: File could not be accessed"
See Also
All Operations Resource GroupSertifi API Web Service

 

 


© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.