Users

ClaimAnonymousAccountCall

Used to claim an anonymous user account that was already provisioned. Claiming is the process of associating an email address and a password (along with other details) with an anonymous user account.

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.
FirstName First name of the user.
LastName Last name of the user.
Email Email address of the user.
Phone Phone number of the user.
Password The user’s new password.
Country The user’s country of location.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <ClaimAnonymousAccountCall>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Email>john@smith.com</Email>
        <Phone>555-555-5555</Phone>
        <Password>passsword1234</Password>
        <Country>US</Country>
    </ClaimAnonymousAccountCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<ClaimAnonymousAccountCallResponse />

Errors

<?xml version="1.0" encoding="utf-8"?>
<ClaimAnonymousAccountCallResponse>
    <Error code="9" description="Email address already associated with a Shoeboxed account" />
</ClaimAnonymousAccountCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<ClaimAnonymousAccountCallResponse>
    <Error code="10" description="Email address was invalid" />
</ClaimAnonymousAccountCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<ClaimAnonymousAccountCallResponse>
    <Error code="11" description="Not an anonymous account." />
</ClaimAnonymousAccountCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<ClaimAnonymousAccountCallResponse>
    <Error code="20" description="Your API app is not authorized for this functionality" />
</ClaimAnonymousAccountCallResponse>

CreateFreeTrialCall

Creates a free trial user tied to this account. This call is restricted. Please contact us if you wish to use this call.

Parameters

Parameter Description
ApiUserName See authentication.
ApiUserToken See authentication.
DeviceIdentifier The unique device identifier of the device on which this call is being made.
Email The user account’s email address.
country The user’s country of location.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserName>Sample Application</ApiUserName>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
    </RequesterCredentials>
    <CreateFreeTrialCall>
        <DeviceIdentifier>A1923C34-E845-11E0-9F8A-E3879283E8D0</<DeviceIdentifier>
        <Email>john.doe@gmail.com</Email>
        <Country>us</Country>
    </CreateFreeTrialCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
</CreateFreeTrialCallResponse>

Errors

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <Error code="1" description="Bad API username"/>
</CreateFreeTrialCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <Error code="1" description="Bad API token"/>
</CreateFreeTrialCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <Error code="3" description="Api call not allowed from 108.128.57.85"/>
</CreateFreeTrialCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <Error code="9" description="Email address already associated with a Shoeboxed account"/>
</CreateFreeTrialCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <Error code="10" description="Email address was invalid"/>
</CreateFreeTrialCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<CreateFreeTrialCallResponse>
    <Error code="20" description="Your API app is not authorized for this functionality"/>
</CreateFreeTrialCallResponse>

GetNewAnonymousUserCall

Parameters

Parameter Description
ApiUserName See authentication.
ApiUserToken See authentication.
UserIdentifier The unique indentifier of this user in your API app. Used to prevent the same user from registering twice.
Country The country of the user’s location.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserName>Sample Application</ApiUserName>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
    </RequesterCredentials>
    <GetNewAnonymousUserCall>
        <UserIdentifier>A1923C34-E845-11E0-9F8A-E3879283E8D0</UserIdentifier>
        <Country>us</Country>
    </GetNewAnonymousUserCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GetNewAnonymousUserCallResponse>
    <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
</GetNewAnonymousUserCallResponse>

Errors

<GetNewAnonymousUserCallResponse>
    <Error code="1" description="Bad API username"/>
</GetNewAnonymousUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetNewAnonymousUserCallResponse>
    <Error code="1" description="Bad API token"/>
</GetNewAnonymousUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetNewAnonymousUserCallResponse>
    <Error code="3" description="Api call not allowed from 93.58.217.13"/>
</GetNewAnonymousUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetNewAnonymousUserCallResponse>
    <Error code="8" description="User already has an account and must log in."/>
</GetNewAnonymousUserCallResponse>

GetFreeTrialsAvailableCall

Gets the number of free trials that can be created by this device.

Parameters

Parameter Description
ApiUserName See authentication.
ApiUserToken See authentication.
DeviceIdentifier The unique device identifier of the device on which this call is being made.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserName>Sample Application</ApiUserName>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
    </RequesterCredentials>
    <GetFreeTrialsAvailableCall>
        <DeviceIdentifier>A1923C34-E845-11E0-9F8A-E3879283E8D0</DeviceIdentifier>
    </GetFreeTrialsAvailableCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GetFreeTrialsAvailableCallResponse>
    <FreeTrials>3</FreeTrials>
</GetFreeTrialsAvailableCallResponse>

Errors

<?xml version="1.0" encoding="utf-8"?>
<GetFreeTrialsAvailableCallResponse>
    <Error code="1" description="Bad API username"/>
</GetFreeTrialsAvailableCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetFreeTrialsAvailableCallResponse>
    <Error code="1" description="Bad API token"/>
</GetFreeTrialsAvailableCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetFreeTrialsAvailableCallResponse>
    <Error code="3" description="Api call not allowed from 177.223.4.68"/>
</GetFreeTrialsAvailableCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetFreeTrialsAvailableCallResponse>
    <Error code="20" description="Your API app is not authorized for this functionality"/>
</GetFreeTrialsAvailableCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetFreeTrialsAvailableCallResponse>
    <Error code="20" description="No free trials left. Please use GetFreeTrialsAvailableCall before using this call."/>
</GetFreeTrialsAvailableCallResponse>

GetUserStatisticsCall

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <GetUserStatisticsCall/>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GetUserStatisticsCallResponse>
    <AccountType>
        <Name>(( DIY, LITE, CLASSIC, BUSINESS, TRIAL ))</Name>
        <DaysLeft>3</DaysLeft> <!-- Element only present if TRIAL -->
    </AccountType>
    <Usage>
        <UsageThisPeriod>42</UsageThisPeriod>
        <UsageLimit>150</<UsageLimit>
    </Usage>
    <Processing>
        <Receipts>5</Receipts>
        <BusinessCards>3</BusinessCards>
    </Processing>
</GetUserStatisticsCallResponse>

RegisterDiyUserCall

Allows API apps to register new Shoeboxed DIY users. DIY users are free Shoeboxed accounts that get 5 credits per month for human-verified OCR and data entry. It returns the newly-created account’s access token so that you can start submiting documents and querying them right away.

Parameters

Parameter Description
ApiUserName See authentication.
ApiUserToken See authentication.
FirstName Optional. User’s first name.
LastName Optional. User’s last name.
Email User’s email.
Phone Optional. User’s phone number.
Password Optional. User’s password.
Country User’s country of location.
UserIdentifier The unique indentifier of this user in your API app. Used to prevent the same user from registering twice.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserName>Sample Application</ApiUserName>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
    </RequesterCredentials>
    <RegisterDiyUserCall>
        <FirstName>John</FirstName>
        <LastName>Doe</LastName>
        <Email>john.doe@gmail.com</Email>
        <Phone>555-555-5555</Phone>
        <Password>password1234</Password>
        <Country>us</Country>
        <UserIdentifier>A1923C34-E845-11E0-9F8A-E3879283E8D0</UserIdentifier>
    </RegisterDiyUserCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
</RegisterDiyUserCallResponse>

Errors

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <Error code="1" description="Bad API username"/>
</RegisterDiyUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <Error code="1" description="Bad API token"/>
</RegisterDiyUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <Error code="3" description="Api call not allowed from ${caller IP}"/>
</RegisterDiyUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <Error code="8" description="User already has an account and must log in."/>
</RegisterDiyUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <Error code="9" description="Email address already associated with a Shoeboxed account"/>
</RegisterDiyUserCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<RegisterDiyUserCallResponse>
    <Error code="10" description="Email address was invalid"/>
</RegisterDiyUserCallResponse>

GetLoginCall

This call is restricted. It is only used when it is not possible to complete the regular authentication process, e.g. because of user device restrictions. It returns a SbxUserToken that can be used to authenticate subsequent API calls.

Parameters

Parameter Description
ApiUserName See authentication.
ApiUserToken See authentication.
UserName The username to log in to.
UserPassword The password of the user.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserName>Sample Application</ApiUserName>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
    </RequesterCredentials>
    <GetLoginCall>
        <UserName>johndoe</UserName>             <!-- can be username or email on account -->
        <UserPassword>password1234</UserPassword>
    </GetLoginCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
</GetLoginCallResponse>

Errors

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <Error code="1" description="Bad API username"/>
</GetLoginCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <Error code="1" description="Bad API token"/>
</GetLoginCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <Error code="3" description="Api call not allowed from 36.7.184.13"/>
</GetLoginCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <Error code="7" description="Please confirm your email address before logging in."/>
</GetLoginCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <Error code="17" description="Login credentials invalid."/>
</GetLoginCallResponse>

<?xml version="1.0" encoding="utf-8"?>
<GetLoginCallResponse>
    <Error code="18" description="Too many failed logins. Account locked for 1 hour."/>
</GetLoginCallResponse>