/testsite/Services/Gateway.asmx/GetFileStatus (Method)

Description

Get a detailed xml output for a file's status, including document and signature information.

Request (GetFileStatusSoapIn)

The request body is of type GetFileStatus.

Request Body Parameters

Name	Description	Data Type
pstr_APICode	The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings.	xml:string
pstr_FileID	The id of the relevant file.	xml:string
includeDocumentDatabaseXML	Include the data filled in on the documents. Default = False.	xml:boolean

Response (GetFileStatusSoapOut)

The response body is of type GetFileStatusResponse.

Response Body Parameters

Name	Description	Data Type
GetFileStatusResult	File status xml or error message.	xml:string

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:GetFileStatus>
         <ser:pstr_APICode>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</ser:pstr_APICode>
         <ser:pstr_FileID>dpZaMtBrYvE=</ser:pstr_FileID>
         <ser:includeDocumentDatabaseXML>false</ser:includeDocumentDatabaseXML>
      </ser:GetFileStatus>
   </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>
      <GetFileStatusResponse xmlns="http://apps.sertifi.net/services/">
         <GetFileStatusResult><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<File>
<Code>dpZaMtBrYvE=</Code>
<Name>yadayada reassign</Name>
<Status>1</Status>
<EventDate>2018-04-20</EventDate>
<Signer>
    <Email>[email protected]</Email>
    <Signed>0</Signed>
    <Open>1</Open>
    <SignerType>1</SignerType>
    <DateInvited>09/29/2014 12:55:33AM</DateInvited>
    <DateLastVisit>1/1/0001 12:00:00 AM</DateLastVisit>
</Signer>
<Document>
    <DocumentID>+7tvlFanzEU=</DocumentID>
    <Name>checkboxes!</Name>
    <Status>Unsigned</Status>
    <DateCreated>9/29/2014 12:35:40 PM</DateCreated>
    <DateSigned>1/1/0001 12:00:00 AM</DateSigned>
    <Signatures>
      <Email>[email protected]</Email>
      <NameSigned />
      <IpAddress />
      <SignMethod>Electronic</SignMethod>
      <DateSigned>1/1/0001 12:00:00 AM</DateSigned>
      <SignerType>1</SignerType>
    </Signatures>
</Document>
</File>]]></GetFileStatusResult>
      </GetFileStatusResponse>
   </soap:Body>
</soap:Envelope>

Remarks

Common Errors include:
"ERROR: Invalid API Code"
"ERROR: File could not be accessed"

File Status key:
Archived = 0,
Active = 1,
ActiveCC = 2, (Unused)
ArchivedCC = 3, (Unused)
AwaitingVerification = 4,
Creating = 5,
Declined = 6,
DeclinedAndArchived = 7,
Expired = 8,
There is no 9.
Deleted = 10

Document statuses:
Unsigned
Signed
Converting to Pdf
Partially signed
Signed and archived
Declined
Expired
Conversion Failed
Undefined (Could mean 'a fax is Awaiting Verification' or 'document is signed but signer revoked it as not a valid signature')