Status Files

As shown below, PackageStatus element displays for each package recipient. Metadata also can be included. The listener writes a new version of the status file each time the PackageStatus element is updated.

Single Signer First XML Pushed Sample

The sample below shows a standard push status notification.

<?xml version="1.0" encoding="UTF-8"?>
<Package>
    <PackageDetail>
        <Id>3378247</Id>
        <Status>Waiting</Status>
        <PushEvent>CREATED</PushEvent>
    </PackageDetail>
    <PackageStatuses>
        <PackageStatus>
                <Recipient>sdxadam@gmail.com</Recipient>
                <Received>Mon, Jun 15, 2015 11:49:23</Received>
                <Viewed/>
                <Purged/>
                <Recalled/>
                <Signed/>
                <Rejected/>
                <PaperRequested/>
                <DirectToPaper/>
                <PaperCompleted/>
                <PaperNote/>
                <Label/>
                <PackageError/>
                <Consented/>
                <PushedToVault/>
                <PushedToVaultNote/>
                <AdditionalData/>
                <UserTag/>
                <TRIDUndeliverable/>
           </PackageStatus>
        </PackageStatuses>
</Package>

Smart Consent XML Pushed Sample

<?xml version="1.0"encoding="UTF-8"?>
<smartconsent>
    <user>sdxadam@gmail.com</user>
    <actiondate>Mon, Jun 15, 2015 10:24:38</actiondate>
    <action>OptOut</action>
    <reason>UserOptedOut</reason>
    <loannumber>12345</loannumber>
</smartconsent>

Smart Consent XML Pushed Sample with Metadata

A package sent with the following metadata defined will produce the XML shown below:

comment=325085SmartConsent-CustomPackageMetadata in XML Status Push attempt 2:challengeanswer1=one:challengeanswer2=two:loan number=325085:day of the week=Wed

<?xml version="1.0"encoding="UTF-8"?>
<smartconsent>
    <user>sdxadam@gmail.com</user>
    <actiondate>Mon, Jun 15, 2015 10:24:38</actiondate>
    <action>OptOut</action>
    <reason>UserOptedOut</reason>
    <comment>325085SmartConsent-CustomPackageMetadata in XML Status Push attempt 2
    </comment>
    <loannumber>325085</loannumber>
    <dayoftheweek>Wed</dayoftheweek>
</smartconsent>