Sertifi API Web Service
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

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
includeDocumentDatabaseXMLInclude the data filled in on the documents.  Default = False.xml:boolean
includeDocumentDatabaseXML Element pstr_FileID Element pstr_APICode Element Sequence GetFileStatus Element
Response (GetFileStatusSoapOut)

The response body is of type GetFileStatusResponse.

Response Body Parameters

NameDescriptionData Type
GetFileStatusResultFile status xml or error message.xml:string
GetFileStatusResult Element Sequence GetFileStatusResponse Element

Sample Call:
<soap:Envelope xmlns:soap="" xmlns:ser="">

Sample Response:
<soap:Envelope xmlns:soap="" xmlns:xsi="" xmlns:xsd="">
      <GetFileStatusResponse xmlns="">
         <GetFileStatusResult><![CDATA[<?xml version="1.0" encoding="utf-16"?>
  <Name>yadayada reassign</Name>
    <Email>[email protected]</Email>
    <DateInvited>09/29/2014 12:55:33AM</DateInvited>
    <DateLastVisit>1/1/0001 12:00:00 AM</DateLastVisit>
    <DateCreated>9/29/2014 12:35:40 PM</DateCreated>
    <DateSigned>1/1/0001 12:00:00 AM</DateSigned>
      <Email>[email protected]</Email>
      <NameSigned />
      <IpAddress />
      <DateSigned>1/1/0001 12:00:00 AM</DateSigned>


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:
Converting to Pdf
Partially signed
Signed and archived
Conversion Failed
Undefined (Could mean 'a fax is Awaiting Verification' or 'document is signed but signer revoked it as not a valid signature')

See Also
All Operations Resource GroupSertifi API Web Service



© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.