AccuZip 360

Base URI

https://cloud2.iaccutrace.com
API Methods
POST /ws_360_webapps/uploadProcess.jsp/{manual_submit}
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/QUOTE
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/CASS
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/CleanAddresses/{filterSubType}
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/NCOA
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/MoveUpdate/{filterSubType}
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/DUPS/{duplicateSubType}
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/DUPLICATES/{duplicateSubType}
PUT /servoy-service/rest_ws/ws_360/job/{generated_guid}/QUOTE
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/PRESORT
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/{option}
GET /ws_360_webapps/download.jsp/{guid}/{ftype}
GET /ws_360_webapps/download.jsp/{guid}/{ftype}
PUT /servoy-service/rest_ws/ws_360/job/{generated_guid}
Upload File
POST /ws_360_webapps/uploadProcess.jsp/{manual_submit}

Upload Name and Address Files for CASS Certification, NCOALink Certification, Duplicate Detection, Postal Presorting, USPS Documentation and print-ready CSV files. Basically, the file you are uploading must be an ASCII Text file where each row is terminated with a CRLF and the columns are delimited using a consistent delimiter. If you are creating a Comma Separated file, then make sure that the columns are also surrounded by Quotes so that if there are commas in the actual data, the columns end up in the correct spot. The Column Header Names should conform to the names listed above, however, you can have additional column names using whatever naming convention you would like. callBack in form data: For example, if you specify: http://mysite.com/getAccuzipCallback.php, our Web Service will do an HTTP GET to: http://mysite.com/getAccuzipCallback.php?guid=<guid> (“<guid>” is the guid returned in the JSON object in the “Upload File” POST REST API call) when one of the GET REST API calls are finished processing in the AccuZIP Cloud. This allows your Web Service to get notified the job was complete, which could then fire off other REST calls to us to get the available PDF or CSV files that contain the Postal Documentation and Print Ready data. This technique is also known as “WebHooks”. Which essentially means user-defined callbacks. So we are allowing you to tell us where you want the callback to go to.

Path variables

manual_submit
boolean required

false

Example:
false

Notes

More about envionrments setup and examles execution on https://github.com/accuzip-opensource/direct-mail

Request parameters

backOfficeOption
string required

json

apiKey
string required

GUID key provided with your account.

callback
string optional

http://mysite.com/getAccuzipCallback.php. See additional comments (below)

file
string required

filepath

Responses

200 OK

if success, redirecting to ../360?guid=generated-or-existing-guid&backOfficeOption=json otherwise prints failure cause

Body
Object
successMongoDBImport
Object
message
string
Example:
Upload process done
success
boolean
Example:
true
quote_started
boolean
Example:
true
cass_started
boolean
Example:
false
guid
string
Example:
45d57e1a-ac8c-4f1f-bc08-2f0384e4f255
license
Object
Total_Credits_Remaining
number
Example:
97
Monthly_Credits_Remaining
number
Example:
97
Annual_Credits_Remaining
number
Example:
97

Examples

Success Response

POST https://cloud2.iaccutrace.com/ws_360_webapps/uploadProcess.jsp/false HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "successMongoDBImport": {
        "message": "Upload process done",
        "success": "true"
    },
    "quote_started": "true",
    "cass_started": "false",
    "guid": "45d57e1a-ac8c-4f1f-bc08-2f0384e4f255",
    "license": {
        "Total_Credits_Remaining": "97",
        "Monthly_Credits_Remaining": "97",
        "Annual_Credits_Remaining": "97"
    }
}

Error Response

POST https://cloud2.iaccutrace.com/ws_360_webapps/uploadProcess.jsp/false HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

ERROR Invalid API Key!
Get Quote
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/QUOTE

Use this web service call after a file has been uploaded to our Cloud. This GET web service call will return a quote for the approximate postage amount the user will save vs. what they would have paid if they did not clean, standardize and presort their list. You can use the Mail Class and Size Object, e.g., Standard Letter to get the savings. Savings is based on if the customer did not clean, standardize and presort their list using this service and would be forced to mail at First-Class Single Piece Rate. So the Standard Letter savings is $402 as compared with a 1oz. First-Class Letter mailed at full single-piece postage.

Path variables

generated_guid
string required

gernerated-guid-with-specific-format

Responses

200 OK
Body
Object
Standard_Flat
string
Example:
$1,015
Standard_Letter
string
Example:
$402
total_presort_records
string
Standard_Card
string
Example:
$402
format
string
First_Class_Card
string
Example:
$150
mail_piece_size
string
presort_class
string
First_Class_Letter
string
Example:
$148
postage_saved
string
total_postage
string
drop_zip
string
success
string
Example:
true
First_Class_Flat
string
Example:
$691

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/QUOTE HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "Standard_Flat": "$1,015",
    "Standard_Letter": "$402",
    "total_presort_records": "",
    "Standard_Card": "$402",
    "format": "",
    "First_Class_Card": "$150",
    "mail_piece_size": "",
    "presort_class": "",
    "First_Class_Letter": "$148",
    "postage_saved": "",
    "total_postage": "",
    "drop_zip": "",
    "success": "true",
    "First_Class_Flat": "$691"
}

Error Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/QUOTE HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
"message": "QUOTE is still processing.",
"success": "false"
}
CASS Certification
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/CASS

Use this web service call to clean and standardize all of the addresses in the file. This web service call must be called after the file has been uploaded successfully and before the NCOALink, Duplicate Detection or Presort web service calls. It is important to note that you should never call the NCOALink, Duplicate Detection or Presort web services call before the CASS Certification web service call returns <”success”=true>.

Path variables

generated_guid
string required

Responses

200 OK
Body
Object
NoFilteredRows
number
Example:
0
Addresses
Object
Rows
unknown
success
boolean
Example:
true
TotalRows
number
Example:
0

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/CASS HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
"NoFilteredRows": 0,
"Addresses": {
"Rows": [ ]
},
"success": true,
"TotalRows": 0
}

Error Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/CASS HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

HTTP 500 – INTERNAL_SERVER_ERROR
Retrieve CASS Certified Records
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/CleanAddresses/{filterSubType}

Use this web service call to retrieve certain types of CASS Certified records to display in a grid for the user to review and edit if necessary. You can allow the user to edit the CASS Certified result and make corrections. Then using the CASS REST API Documentation (https://api.iaccutrace.com/docs/api-cass), you can create a one-button CASS Certified lookup to correct the address on-the-fly.

Path variables

generated_guid
string required

generated guid with specific format

filterSubType
string required

2=Unit number provided but not verified

3=Unit number missing from known high-rise address

4=Vacant

5=Business address

6=Private Mail Box address

7=Address not valid

8=Missing address element(s)

9=Foreign

99=All

Responses

200 OK
Body
Object
NoFilteredRows
string
Example:
2
Addresses
Object
Rows
Object
ozipcode
string
Example:
01772
pre_
string
last
string
Example:
last name
stelink_
string
suffix_
string
Example:
RD
stno_
string
Example:
25
address2
string
errno_
string
Example:
11.14,12.2,14.5,14.7,15.1,A1
middle
string
sal
string
city
string
Example:
SOUTHBOROUGH
dpc
string
Example:
993
chkdg
string
Example:
3
dp_
string
Example:
99
financeno_
string
Example:
247242
countyno_
string
Example:
027
status_
string
Example:
V
ocompany
string
st
string
Example:
MA
latitude_
string
Example:
42.30020
ocity
string
Example:
Southborough
barcode
string
Example:
/017722082993/
pmbno_
string
company
string
ascdesc_
string
Example:
A
primary_
string
Example:
106
dpv_
string
Example:
DN NN
lacsrc_
string
vacant_
string
Example:
N
type_
string
Example:
H
area_
string
Example:
508
longitude_
string
Example:
71.53230
lot_
string
Example:
0101
lacsind_
string
countynm_
string
Example:
WORCESTER
street_
string
Example:
SOUTHVILLE
zip5
string
Example:
01772
congress_
string
Example:
05
secy_
string
lacs_
string
abrev_
string
zip4
string
Example:
2082
ostate
string
Example:
MA
dp
string
Example:
99
oaddress2
string
zip
string
Example:
01772-2082
post_
string
jsPcid_
string
Example:
00000355
crrt
string
Example:
R003
rdi_
string
Example:
N
dpvnotes_
string
Example:
AAN1
oaddress
string
Example:
106 Southville Road
timezone_
string
Example:
EST
pmb_
string
address
string
Example:
106 SOUTHVILLE RD
first
string
Example:
first name
x
string
leftout_
string
success
string
Example:
true
TotalRows
string
Example:
2000

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/CleanAddresses/3 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "NoFilteredRows": "2",
  "Addresses": {
    "Rows": [
      {
        "ozipcode": "01772",
        "pre_": "",
        "last": "last name",
        "stelink_": "",
        "suffix_": "RD",
        "stno_": "25",
        "address2": "",
        "errno_": "11.14,12.2,14.5,14.7,15.1,A1",
        "middle": "",
        "sal": "",
        "city": "SOUTHBOROUGH",
        "dpc": "993",
        "chkdg": "3",
        "dp_": "99",
        "financeno_": "247242",
        "countyno_": "027",
        "status_": "V",
        "ocompany": "",
        "st": "MA",
        "latitude_": "42.30020",
        "ocity": "Southborough",
        "barcode": "/017722082993/",
        "pmbno_": "",
        "company": "",
        "ascdesc_": "A",
        "primary_": "106",
        "dpv_": "DN NN",
        "lacsrc_": "",
        "vacant_": "N",
        "type_": "H",
        "area_": "508",
        "longitude_": "71.53230",
        "lot_": "0101",
        "lacsind_": "",
        "countynm_": "WORCESTER",
        "street_": "SOUTHVILLE",
        "zip5": "01772",
        "congress_": "05",
        "secy_": "",
        "lacs_": "",
        "abrev_": "",
        "zip4": "2082",
        "ostate": "MA",
        "dp": "99",
        "oaddress2": "",
        "zip": "01772-2082",
        "post_": "",
        "jsPcid_": "00000355",
        "crrt": "R003",
        "rdi_": "N",
        "dpvnotes_": "AAN1",
        "oaddress": "106 Southville Road",
        "timezone_": "EST",
        "pmb_": "",
        "address": "106 SOUTHVILLE RD",
        "first": "first name",
        "x": "",
        "leftout_": ""
      },
      {
        "ozipcode": "02115",
        "pre_": "",
        "last": "last name",
        "stelink_": "",
        "suffix_": "AVE",
        "stno_": "25",
        "address2": "",
        "errno_": "11.14,12.2,14.5,15.1,A1",
        "middle": "",
        "sal": "",
        "city": "BOSTON",
        "dpc": "992",
        "chkdg": "2",
        "dp_": "99",
        "financeno_": "240799",
        "countyno_": "025",
        "status_": "V",
        "ocompany": "",
        "st": "MA",
        "latitude_": "42.34100",
        "ocity": "Boston",
        "barcode": "/021153134992/",
        "pmbno_": "",
        "company": "",
        "ascdesc_": "A",
        "primary_": "177",
        "dpv_": "DN NN",
        "lacsrc_": "",
        "vacant_": "N",
        "type_": "H",
        "area_": "617",
        "longitude_": "71.09480",
        "lot_": "0143",
        "lacsind_": "",
        "countynm_": "SUFFOLK",
        "street_": "HUNTINGTON",
        "zip5": "02115",
        "congress_": "07",
        "secy_": "",
        "lacs_": "",
        "abrev_": "",
        "zip4": "3134",
        "ostate": "MA",
        "dp": "99",
        "oaddress2": "",
        "zip": "02115-3134",
        "post_": "",
        "jsPcid_": "00000706",
        "crrt": "C012",
        "rdi_": "N",
        "dpvnotes_": "AAN1",
        "oaddress": "177 Huntington Avenue",
        "timezone_": "EST",
        "pmb_": "",
        "address": "177 HUNTINGTON AVE",
        "first": "first name",
        "x": "",
        "leftout_": ""
      }
    ]
  },
  "success": "true",
  "TotalRows": "2000"
}
GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/CleanAddresses/'' HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "message": "Missing filter value",
    "success": false
}
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/NCOA

Use this web service call to process the names and addresses that have been previously CASS Certified, through our Licensed NCOALink process for Change of Address matching. It is very important that we have a completed Processing Acknowledgement Form (PAF) on file for the List Owner prior to processing the list through our NCOALink process.

Our electronic PAF can be completed at: http://accuzip.com/products/ncoalink/paf/new

You can call this web service without first calling /CASS. If the list has not been CASS Certified, calling /NCOA will also CASS Certify, and then process the list through our Licensed NCOALink service.

Path variables

generated_guid
string required

Responses

200 OK
Body
Object
success
boolean
Example:
true

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/NCOA HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true
}

Error Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/NCOA HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

HTTP 500 – INTERNAL_SERVER_ERROR
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/MoveUpdate/{filterSubType}

Use this web service call to retrieve certain types of NCOALink records to display in a grid for the user to review. Allow the user to review the results, make changes if needed, then call the “Replace All Data” web service to update the main database before presorting.

Path variables

generated_guid
string required

generated_guid_with_specific_format

filterSubType
string required

1 Moved - COA Matches

2 Moved - New Address cannot be confirmed

3 Moved - Left No Forwarding

4 Moved - Foreign Country

5 Moved - New State

6 Individual Match

7 Family Match

8 Business Match

99 All NCOALink Matches

Responses

200 OK
Body
Object
NoFilteredRows
string
Example:
2
Addresses
Object
Rows
Object
ozipcode
string
Example:
01602
pre_
string
last
string
Example:
last name
stelink_
string
suffix_
string
Example:
ST
stno_
string
Example:
25
address2
string
errno_
string
Example:
11.14,14.5,14.7,A1
middle
string
sal
string
city
string
Example:
WORCESTER
movedate_
string
Example:
201305
dpc
string
Example:
262
chkdg
string
Example:
2
dp_
string
Example:
26
financeno_
string
Example:
249622
countyno_
string
Example:
027
ank_
string
Example:
77
status_
string
Example:
V
ocompany
string
st
string
Example:
MA
latitude_
string
Example:
42.27240
ocity
string
Example:
Worcester
barcode
string
Example:
/016021406262/
pmbno_
string
company
string
ascdesc_
string
Example:
A
primary_
string
Example:
26
dpv_
string
Example:
YN NN
lacsrc_
string
vacant_
string
Example:
N
type_
string
Example:
S
area_
string
Example:
508
longitude_
string
Example:
71.84950
lot_
string
Example:
0045
lacsind_
string
countynm_
string
Example:
WORCESTER
nxi_
string
Example:
19
street_
string
Example:
BERWICK
zip5
string
Example:
01602
congress_
string
Example:
02
secy_
string
lacs_
string
ffapplied_
string
Example:
20150501
abrev_
string
zip4
string
Example:
1406
matchflag_
string
ostate
string
Example:
MA
dp
string
Example:
26
oaddress2
string
zip
string
Example:
01602-1406
post_
string
jsPcid_
string
Example:
00000228
crrt
string
Example:
C012
rdi_
string
Example:
Y
dpvnotes_
string
Example:
AABB
oaddress
string
Example:
26 Berwick Street
timezone_
string
Example:
EST
pmb_
string
movetype_
string
Example:
I
address
string
Example:
26 BERWICK ST
first
string
Example:
first name
x
string
leftout_
string
success
string
Example:
true
TotalRows
string
Example:
2000

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/MoveUpdate/2 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "NoFilteredRows": "2",
  "Addresses": {
    "Rows": [
      {
        "ozipcode": "01602",
        "pre_": "",
        "last": "last name",
        "stelink_": "",
        "suffix_": "ST",
        "stno_": "25",
        "address2": "",
        "errno_": "11.14,14.5,14.7,A1",
        "middle": "",
        "sal": "",
        "city": "WORCESTER",
        "movedate_": "201305",
        "dpc": "262",
        "chkdg": "2",
        "dp_": "26",
        "financeno_": "249622",
        "countyno_": "027",
        "ank_": "77",
        "status_": "V",
        "ocompany": "",
        "st": "MA",
        "latitude_": "42.27240",
        "ocity": "Worcester",
        "barcode": "/016021406262/",
        "pmbno_": "",
        "company": "",
        "ascdesc_": "A",
        "primary_": "26",
        "dpv_": "YN NN",
        "lacsrc_": "",
        "vacant_": "N",
        "type_": "S",
        "area_": "508",
        "longitude_": "71.84950",
        "lot_": "0045",
        "lacsind_": "",
        "countynm_": "WORCESTER",
        "nxi_": "19",
        "street_": "BERWICK",
        "zip5": "01602",
        "congress_": "02",
        "secy_": "",
        "lacs_": "",
        "ffapplied_": "20150501",
        "abrev_": "",
        "zip4": "1406",
        "matchflag_": "",
        "ostate": "MA",
        "dp": "26",
        "oaddress2": "",
        "zip": "01602-1406",
        "post_": "",
        "jsPcid_": "00000228",
        "crrt": "C012",
        "rdi_": "Y",
        "dpvnotes_": "AABB",
        "oaddress": "26 Berwick Street",
        "timezone_": "EST",
        "pmb_": "",
        "movetype_": "I",
        "address": "26 BERWICK ST",
        "first": "first name",
        "x": "",
        "leftout_": ""
      },
      {
        "ozipcode": "02210",
        "pre_": "",
        "last": "last name",
        "stelink_": "",
        "suffix_": "ST",
        "stno_": "25",
        "address2": "",
        "errno_": "11.14,14.5,14.7,15.2,A1",
        "middle": "",
        "sal": "",
        "city": "BOSTON",
        "movedate_": "201410",
        "dpc": "543",
        "chkdg": "3",
        "dp_": "54",
        "financeno_": "240799",
        "countyno_": "025",
        "ank_": "",
        "status_": "V",
        "ocompany": "",
        "st": "MA",
        "latitude_": "42.34660",
        "ocity": "Boston",
        "barcode": "/022101200543/",
        "pmbno_": "",
        "company": "",
        "ascdesc_": "A",
        "primary_": "33",
        "dpv_": "YN NN",
        "lacsrc_": "",
        "vacant_": "N",
        "type_": "H",
        "area_": "617",
        "longitude_": "71.04030",
        "lot_": "0156",
        "lacsind_": "",
        "countynm_": "SUFFOLK",
        "nxi_": "19",
        "street_": "SLEEPER",
        "zip5": "02210",
        "congress_": "08",
        "secy_": "204",
        "lacs_": "",
        "ffapplied_": "20150501",
        "abrev_": "APT",
        "zip4": "1200",
        "matchflag_": "",
        "ostate": "MA",
        "dp": "54",
        "oaddress2": "",
        "zip": "02210-1200",
        "post_": "",
        "jsPcid_": "00000959",
        "crrt": "C053",
        "rdi_": "Y",
        "dpvnotes_": "AABB",
        "oaddress": "33 Sleeper Street Unit 204",
        "timezone_": "EST",
        "pmb_": "",
        "movetype_": "I",
        "address": "33 SLEEPER ST APT 204",
        "first": "first name",
        "x": "",
        "leftout_": ""
      }
    ]
  },
  "success": "true",
  "TotalRows": "2000"
}

Error Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/MoveUpdate/'' HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
"message": "Missing filter value",
"success": false
}
Duplicate Detection
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/DUPS/{duplicateSubType}

Use this web service call to remove duplicate records from the CASS Certified and NCOALink Certified file. This will ensure that only one mail-piece is mailed to an address, person, household or company. This web service call is optional. If the customer wants to mail to 100% of the list, then do not make this web service call.

Path variables

generated_guid
string required
duplicateSubType
string required

01 = Address Only and if exists, Company

02 = First and Last name

03 = Household name

Responses

200 OK
Body
Object
success
boolean
Example:
true

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/DUPS/02 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true
}

Error Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/DUPS/'' HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
"message": "Missing filter value",
"success": false
}
Retrieve Duplicates
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/DUPLICATES/{duplicateSubType}

Use this web service call to retrieve the duplicate records found in the “Duplicate Detection” web service. It is important to use the same <duplicateSubType> used in the “Duplicate Detection” web service call in order to retrieve the matching records. Use the retrieved object to populate a grid that displays all of the duplicate records. If you want to highlight the duplicate records, the object named “x” will contain the value “1”. This will allow you to set a trigger that may turn the row in the grid a different color to highlight the duplicate records so they are easily identified.

Path variables

generated_guid
string required

generated_guid_with_specific_format

duplicateSubType
string required

01 = Address Only and if exists, Company

02 = First and Last name

03 = Household name

Responses

200 OK
Body
Object
NoFilteredRows
string
Example:
1
Addresses
Object
Rows
Object
ozipcode
string
Example:
01772
pre_
string
last
string
Example:
last name
stelink_
string
suffix_
string
Example:
RD
stno_
string
Example:
25
address2
string
errno_
string
Example:
11.14,14.5,A1
middle
string
sal
string
city
string
Example:
SOUTHBOROUGH
movedate_
string
dpc
string
Example:
083
chkdg
string
Example:
3
dp_
string
Example:
-8
financeno_
string
Example:
247242
countyno_
string
Example:
027
ank_
string
status_
string
Example:
V
ocompany
string
st
string
Example:
MA
jspcid_
string
Example:
00000357
latitude_
string
Example:
42.30020
ocity
string
Example:
Southborough
barcode
string
Example:
/017721443083/
pmbno_
string
company
string
ascdesc_
string
Example:
D
primary_
string
Example:
8
dpv_
string
Example:
YN
lacsrc_
string
vacant_
string
Example:
N
type_
string
Example:
S
area_
string
Example:
508
longitude_
string
Example:
71.53230
lot_
string
Example:
0026
lacsind_
string
countynm_
string
Example:
WORCESTER
nxi_
string
street_
string
Example:
STRAWBERRY HILL
zip5
string
Example:
01772
congress_
string
Example:
05
secy_
string
lacs_
string
ffapplied_
string
abrev_
string
zip4
string
Example:
1443
matchflag_
string
ostate
string
Example:
MA
dp
string
Example:
08
oaddress2
string
zip
string
Example:
01772-1443
post_
string
crrt
string
Example:
R006
rdi_
string
Example:
Y
dpvnotes_
string
Example:
AABB
oaddress
string
Example:
8 Strawberry Hill Road
timezone_
string
Example:
EST
pmb_
string
movetype_
string
address
string
Example:
8 STRAWBERRY HILL RD
first
string
Example:
first name
x
string
Example:
2
leftout_
string
success
string
Example:
true
TotalRows
string
Example:
2000

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/DUPLICATES/02 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "NoFilteredRows": "1",
  "Addresses": {
    "Rows": [
      {
        "ozipcode": "01772",
        "pre_": "",
        "last": "last name",
        "stelink_": "",
        "suffix_": "RD",
        "stno_": "25",
        "address2": "",
        "errno_": "11.14,14.5,A1",
        "middle": "",
        "sal": "",
        "city": "SOUTHBOROUGH",
        "movedate_": "",
        "dpc": "083",
        "chkdg": "3",
        "dp_": "-8",
        "financeno_": "247242",
        "countyno_": "027",
        "ank_": "",
        "status_": "V",
        "ocompany": "",
        "st": "MA",
        "jspcid_": "00000357",
        "latitude_": "42.30020",
        "ocity": "Southborough",
        "barcode": "/017721443083/",
        "pmbno_": "",
        "company": "",
        "ascdesc_": "D",
        "primary_": "8",
        "dpv_": "YN",
        "lacsrc_": "",
        "vacant_": "N",
        "type_": "S",
        "area_": "508",
        "longitude_": "71.53230",
        "lot_": "0026",
        "lacsind_": "",
        "countynm_": "WORCESTER",
        "nxi_": "",
        "street_": "STRAWBERRY HILL",
        "zip5": "01772",
        "congress_": "05",
        "secy_": "",
        "lacs_": "",
        "ffapplied_": "",
        "abrev_": "",
        "zip4": "1443",
        "matchflag_": "",
        "ostate": "MA",
        "dp": "08",
        "oaddress2": "",
        "zip": "01772-1443",
        "post_": "",
        "crrt": "R006",
        "rdi_": "Y",
        "dpvnotes_": "AABB",
        "oaddress": "8 Strawberry Hill Road",
        "timezone_": "EST",
        "pmb_": "",
        "movetype_": "",
        "address": "8 STRAWBERRY HILL RD",
        "first": "first name",
        "x": "2",
        "leftout_": ""
      }
    ]
  },
  "success": "true",
  "TotalRows": "2000"
}

Error Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/DUPLICATES/'' HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
"message": "Missing filter value",
"success": false
}
Update Quote
PUT /servoy-service/rest_ws/ws_360/job/{generated_guid}/QUOTE

Use this web service call to update the object returned with the “Quote”, e.g., Class of Mail, Piece Size, etc… It is necessary to make a call to this web service before calling the Presort web service. Otherwise, the Presort web service will not know what Class of Mail or Piece Size you want to use for the presort. To reiterate, it is very important this Update Quote web service be called before the Presort web service. The Update Quote web service only needs to be called once in order to update the “presort_class”, “drop_zip” and “mail_piece_size” objects, and then again if any of these values change.

Path variables

generated_guid
string required

Request parameters

format
string optional

UPPER; MIXED

presort_class
string required

FIRST CLASS; STANDARD

Class of Mail that will be used to qualify the postage rate and presort levels for the mail-pieces

drop_zip
string required

5-Digit ZIP Code of Entry Post Office (BMEU) where the mail is verified

99999 or 99999-9999 (valid ZIP Code or ZIP+4 for Verification Post Office)

Example:
93422
mail_piece_size
string required

CARD; LETTER; FLAT; PARCEL

Mail piece size.

piece_height
string required

inches

Example:
4.00
piece_length
string required

inches

Example:
5.00
thickness_value
string required

inches

Example:
.009
tray_type
string required

[MMM, OMM, 1MM, 2MM, EMM]

Example:
MMM
calculate_container_volume
string required

ON - The software will automatically calculation the Minimum and Maximum container volumes and ignore the values in MIN1F, MAX1FT, MIN2FT, MAX2FT, PERTUBMIN, and PERTUBMAX

OFF - If this setting is missing or set to "0", you will need to set the Minimum and Maximum container volumes values in MIN1F, MAX1FT, MIN2FT, MAX2FT, PERTUBMIN, and PERTUBMAX as applicable

Example:
1 = ON, 0 = OFF
print_barcode
string required

0 = Not print a barcode of any type; 1 = Printing a barcode of type POSTNET, IMb or IMpb

Example:
1
print_imb
string required

0 = Not using IMb or IMpb; 1 = Using IMb or IMpb

Example:
1
machinability
string required

[MACHINABLE, NON MACHINABLE, MANUAL]

Describes the Machinability of the mail-piece

Example:
NONMACHINABLE
weight_value
string required

Weight in Pounds, Ounces, Grams, Milligrams, Kilograms

Example:
.2
weight_unit
string required

[OUNCES, POUNDS, GRAMS, MILLIGRAMS, KILOGRAMS]

Example:
OUNCES
mail_permit_type
string required

[PROFIT, NONPROFIT, IMPRINT]

Example:
PROFIT
mail_pay_method
string required

[IMPRINT, METER, STAMP]

Example:
IMPRINT
include_non_zip4
string required

0 = Do not included Non-ZIP+4 records; 1 = Include Non-ZIP+4 records

Example:
1
include_crrt
string required

0 = Do not include the Carrier Route Level presort; 1 = Include the Carrier Route Level presort (if applicable)

Example:
0
agent_or_mailer_signing_statement
string required

Name of Mailer or Agent Signing Form

Example:
JOHN DOE
agent_or_mailer_company
string required

Name of Mailer or Agent Company Name

Example:
ABC INC.
agent_or_mailer_phone
string required

Name of Mailer or Agent Phone Number

Example:
8882359876
agent_or_mailer_email
string required

Name of Mailer or Agent Email

Example:
name@email.com
mailing_agent_mailer_id
string required

Mailing Agent - Mailer ID

Example:
999999
mailing_agent_crid
string required

Mailing Agent - CRID

Example:
999999
mailing_agent_edoc_sender_crid
string required

Mailing Agent - eDoc Sender CRID (PostalOne! Uploads)

Example:
8888888
permit_holder_mailer_id
string required

Permit Holder - Mailer ID

Example:
999999
permit_holder_crid
string required

Permit Holder - CRID

Example:
8888888
statement_number
string required

Statement Sequence Number

Example:
1
mailing_date
string required

Mailing Date MM/DD/YYYY

Example:
08/20/2014
mail_permit_number
string required

Primary Permit #

Example:
199
imb_default_mid
string required

Important: DO NOT LEAVE THIS SETTING BLANK

Example:
999999

Request body

Object

Responses

200 OK

Examples

Request Input

PUT https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/QUOTE HTTP/1.1 

Content-Type: application/json

{
"mail_pay_method": "IMPRINT",
"print_imb": "1",
"mailing_date": "08/20/2014",
"include_crrt": "0",
"thickness_value": ".009",
"agent_or_mailer_company": "ABC INC.",
"mail_piece_size": "LETTER",
"piece_length": "5.00",
"presort_class": "STANDARD MAIL",
"print_barcode": "1",
"weight_value": ".2",
"piece_height": "4.00",
"machinability": "NONMACHINABLE",
"permit_holder_mailer_id": "999999",
"tray_type": "MMM",
"permit_holder_crid": "8888888",
"mail_permit_number": "199",
"format": "UPPER",
"weight_unit": "OUNCES",
"calculate_container_volume": "1",
"mailing_agent_crid": "8888888",
"mail_permit_type": "PROFIT",
"drop_zip": "93422",
"mailing_agent_mailer_id": "999999",
"agent_or_mailer_signing_statement": "JOHN DOE",
"agent_or_mailer_phone": "8054617300",
"mailing_agent_edoc_sender_crid": "8888888",
"statement_number": "1",
"include_non_zip4": "1",
"agent_or_mailer_email": "name@email.com",
"imb_default_mid": "999999"
}
PUT https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/QUOTE HTTP/1.1 

Content-Type: application/json

HTTP 500 – INTERNAL_SERVER_ERROR
Presort Postal Discounts
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/PRESORT

Use this web service call to process addresses that have been CASS Certified through our Cloud Presort engine to claim the lowest postage rates. Our Cloud Presort supports all Classes of Mail and mail-piece sizes, including mixed weight manifest and drop shipment. However, for this initial proof of concept, we are releasing the most popular Cloud Presort options, First-Class and Standard Mail Letters and Flats.

The Cloud Presort settings are controlled by the “Replace Quote” web service call (above). After calling the Presort web service, wait for the response before calling it again. You would only call the Presort web service call again if you updated the Quote information using the “Replace Quote” web service call with new information.

Path variables

generated_guid
string required

Responses

200 OK
Body
Object
success
string
Example:
true

Examples

Success Response

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/guid/PRESORT HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true
}
GET /servoy-service/rest_ws/ws_360/job/{generated_guid}/{option}

Use this web service call to clean and standardize all of the addresses in the file; process the names and addresses that have been previously CASS Certified, through our Licensed NCOALink process for Change of Address matching; remove duplicate records from the CASS Certified and NCOALink Certified file; process addresses that have been CASS Certified through our Cloud Presort engine to claim the lowest postage rates; generate the USPS Documentation in PDF format; and generate the print-ready CSV file. This web service performs all size processes with one call.

Before you can use this REST API call, you must first upload the file (see Upload File) and PUT the JSON object (see Update Quote) that will contain all of the mail-piece characteristics and mailer information (TBA).

This REST API call does it all, however, it requires the successful “Update File” and “Update Quote” calls first.

Path variables

generated_guid
string required
option
string required

CASS-NCOA-DUPS-PRESORT = Duplicates are detected by Address

CASS-NCOA-DUPS_01-PRESORT = Duplicates are detected by Address

CASS-NCOA-DUPS_02-PRESORT = Duplicates are detected by First & Last Name

CASS-NCOA-DUPS_03-PRESORT = Duplicates are detected by Household Name

CASS-NCOA-DUPS_04-PRESORT = Duplicates are detected by Company Name

CASS-DUPS-PRESORT = Duplicates are detected by Address

CASS-DUPS_01-PRESORT = Duplicates are detected by Address

CASS-DUPS_02-PRESORT = Duplicates are detected by First & Last Name

CASS-DUPS_03-PRESORT = Duplicates are detected by Household Name

CASS-DUPS_04-PRESORT = Duplicates are detected by Company Name

CASS-NCOA-PRESORT

CASS-PRESORT

Responses

200 OK
Body
Object
success
boolean
Example:
true

Examples

GET https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/job/a25aee33-3b89-4368-b095-fff963fe98cb/CASS-NCOA-DUPS-PRESORT HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "success": true
}
Download Print Ready Presorted CSV
GET /ws_360_webapps/download.jsp/{guid}/{ftype}

Use this web service to download the print-ready CSV file that has been CASS Certified, processed through NCOALink (if applicable), Dedupped (if applicable) and Presorted for the lowest postal discounts. This web service will stream the text file direct

Path variables

guid
string required

generated_guid_with_specific_format

ftype
string required

csv
prev.csv ( first 25 rows of data)

Example:
csv

Responses

200 OK

Streamed CSV file (content)

Body
string

Examples

Success Response

GET https://cloud2.iaccutrace.com/ws_360_webapps/download.jsp/guid/prev.csv HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

first,last,address,address2,city,st,zip,sal,middle,crrt,barcode,imbarcode,imbdigits,sequence,cont_id,gpb_id,endorse
"PETRA","BIGNAMI","200 BERKELEY ST FL 25","","BOSTON","MA","02116-5035","","","C036","/021165035250/","FAFFAFFADDTFDTFFADDTDATDATADFTTAFFAAAFTDTADFTATFTAAFFDDFTAAFFTADF","00301999999000001980","1","1","1","*****************5-DIGIT 02116"
"SPENCER","ADAMS","269 COMMONWEALTH AVE APT 3","","BOSTON","MA","02116-1600","","","C018","/021161600698/","FAFADFDFAFFADDTFTTDDDTDAFADADDTDADDDDDTFFFDFTFAATFFFDAFFAADDFAAAF","00301999999000001981","2","1","1","*****************5-DIGIT 02116"
"MELANIE","SLOMON","143 APPLETON ST","","BOSTON","MA","02116-6001","","","C020","/021166001436/","TDDTTAFFAATTFTTAAFFAAADAAAFTDFDATTTDADFATFDTFTTDFFATDAFDATDFDDAAA","00301999999000001982","3","1","1","*****************5-DIGIT 02116"
"PETER","EPSTEIN","168 MARLBOROUGH ST APT 3","","BOSTON","MA","02116-1840","","","C030","/021161840034/","TFDDTFFFFFDATDTDDDFTTFFFADAFATDFFDAFAAAFTFAFTADADTTFFTFAFTFFTTATT","00301999999000001983","4","1","1","*****************5-DIGIT 02116"
"STEVEN","CRIMALDI","8 GARRISON ST APT 401","","BOSTON","MA","02116-5717","","","C031","/021165717019/","DADDDTFATDTADADTDFFDDAADDTFFTFFFDAFDATTDTDTTFDTFTFFAFTFFAAADTDATA","00301999999000001984","5","1","1","*****************5-DIGIT 02116"
"JAMES","ASP","63 SAINT BOTOLPH ST APT 61","","BOSTON","MA","02116-6443","","","C031","/021166443995/","ATDAADTAFDATFTFDATAAATADFDFDATATDDDDAFDTFTFTAADDFDDTFDTDDFATAATDF","00301999999000001985","6","1","1","*****************5-DIGIT 02116"
"MEGAN","WILLIAMS","20 FAYETTE ST","APT 1","BOSTON","MA","02116-5507","","","C035","/021165507201/","DTDDFFAFDFDTATTDTDTAFAFFDAFTDTTAAFDATDDTTAFDAFADDFDDDTFTAADFTTATA","00301999999000001986","7","1","1","*****************5-DIGIT 02116"
"BRANDON","ANDRUSIC","14 DARTMOUTH PL APT 3","","BOSTON","MA","02116-6124","","","C038","/021166124034/","AADDFTDDTTATTFDTFTTADDTTDDAFTAADAATATDDDFTAFFADFFDFAFTDFDDDAAFDTA","00301999999000001987","8","1","1","*****************5-DIGIT 02116"
"MELISSA","ADELSTEIN","505 TREMONT ST UNIT 206","","BOSTON","MA","02116-6347","","","C041","/021166347569/","FDTTFFAAAADTFTADDFDDFFATTAADFTTFADDFTFFAADFTADADAFTTTAFTAFFADTTAT","00301999999000001988","9","1","1","*****************5-DIGIT 02116"
"DANIEL","KOCH","755 BOYLSTON ST APT 404","","BOSTON","MA","02116-2671","","","C044","/021162671040/","DTAAFAFDTFTDATDAFTFDATTDDTDTAFDFTATDTDFTTTDTFAADDDATFFDDDFTTADADF","00301999999000001989","10","1","1","*****************5-DIGIT 02116"
"KAREN","GEFFEN","303 COLUMBUS AVE UNIT 301","","BOSTON","MA","02116-5285","","","C045","/021165285767/","AADTAAAFTFTDDDATFDFFDADDFADDAFAAAADDTATFTTDAFTTFAFAFTTDFTDFFDDFDA","00301999999000001990","11","1","1","*****************5-DIGIT 02116"
"HELEN","ALKON","303 COLUMBUS AVE UNIT 604","","BOSTON","MA","02116-5288","","","C045","/021165288548/","TDFDFDDDATFFAFADTTFTFDADFDTFTTTDFFTADFFAFTFDTADDDDFDAFTTDDTADADFA","00301999999000001991","12","1","1","*****************5-DIGIT 02116"
"HOWARD","WITKES","303 COLUMBUS AVE UNIT 1002","","BOSTON","MA","02116-5291","","","C045","/021165291526/","ATTADFATAATDADTDADDAFADTDADAFDFATFDADFDTAFFATATTAFDDTDFTTDTTATTDT","00301999999000001992","13","1","1","*****************5-DIGIT 02116"
"KRISTIN","PHELAN","418 COLUMBUS AVE # 2","","BOSTON","MA","02116-5910","","","C049","/021165910186/","AADFDAFDADTADDTTTFDTDADDFAATAAAFDTFTTDDFTFAFFTDAFFDFFTDAAFTADDDFA","00301999999000001993","14","1","1","*****************5-DIGIT 02116"
"JULIE","WHITE","62 UNION AVE","","JAMAICA PLAIN","MA","02130-2616","","","C009","/021302616621/","FTFADDATFAADAFTDTTFTAFAFADADDTTFFDAFDDTADFTFTATDDDADDFDDTTTDTAADD","00301999999000001994","15","1","2","*****************5-DIGIT 02130"
"AIMEE","VANWAGENEN","70 PATTEN ST","","JAMAICA PLAIN","MA","02130-4638","","","C015","/021304638706/","AAFADAAAAAFTTAFTAFFATDTAFFFAAADFAADTDTAFTTFAFDTFDTAADFAATFDAAFTTF","00301999999000001995","16","1","2","*****************5-DIGIT 02130"
"MARK","EISENBERG","5 HAMPSTEAD RD","","JAMAICA PLAIN","MA","02130-3905","","","C017","/021303905052/","TFFAAFTAFATFTDAFDTADTDDFAADFTTDTDFAATFFFTDFFAFFFTAAATTFADFFDDATDF","00301999999000001996","17","1","2","*****************5-DIGIT 02130"
"REBECCA","HAMMOND","101 ORCHARD ST","","JAMAICA PLAIN","MA","02130-2710","","","C023","/021302710013/","AFDADTTAAATADFTAFDDTTTFAFADADFADTTDFAFFDATDDFAFFDATADDFAFDDDFDTFT","00301999999000001997","18","1","2","*****************5-DIGIT 02130"
"RYAN","KUZMICKAS","101 ORCHARD ST","","JAMAICA PLAIN","MA","02130-2710","","","C023","/021302710013/","AATDFFATFFFATDDFAAFADATAADDDDTTFFDFATATDFFFFAATATTDAAAFFADFFFATTD","00301999999000001998","19","1","2","*****************5-DIGIT 02130"
"MICHAEL","GERO","35 PRINCE ST","","JAMAICA PLAIN","MA","02130-2725","","","C023","/021302725350/","FADFTFADFDATDDADAADDTFDTADDAATAATDFFTADFDAFFTTTFDDAAFFFATAATFATTT","00301999999000001999","20","1","2","*****************5-DIGIT 02130"
"LORI","ROTHSTEIN","64 WYMAN ST","APT 1","JAMAICA PLAIN","MA","02130-1927","","","C030","/021301927645/","FDDFDFDAADTTAFDDAFDDATADDTDFTTTTDDTTDFATTDFDAADTTAFTTTADDFFAATFAD","00301999999000002000","21","1","2","*****************5-DIGIT 02130"
"AYSE","SAHIN","1 SUNNYSIDE ST","","JAMAICA PLAIN","MA","02130-1224","","","C032","/021301224014/","TFDTFTDFDADFTTTTAAFFDDTFDDFTDFATATATTFFDAAADDDDFFATAFDDAFTTATDDDT","00301999999000002001","22","1","2","*****************5-DIGIT 02130"
"CHRISTOPHER","CORREIA","122 DAY ST","","JAMAICA PLAIN","MA","02130-1105","","","C032","/021301105223/","DTAFTFAFTAATADADADDAFADTAADADDAFTFTDATDTDTTAADFTADFTAADDATATDAFTF","00301999999000002002","23","1","2","*****************5-DIGIT 02130"
"STEPHEN","HODIN","94 BROOKSIDE AVE","","JAMAICA PLAIN","MA","02130-2648","","","C042","/021302648941/","TTFAAFATFTFAADFFTTTTFFFTAFDFTDAFDDDTAATTFTDATDTTDDDDDFDDTDTTDAFAT","00301999999000002003","24","1","2","*****************5-DIGIT 02130"
"PETRA","RYDLOVA","50 QUINCY ST","","CAMBRIDGE","MA","02138-3013","","","C005","/021383013504/","TATDTATDDTTDDFAAFDTATFFFFFDFTFDFAAADDADFFFTTDADAAFDADFFFTFFDDFDDF","00301999999000002004","25","1","3","*****************5-DIGIT 02138"
GET https://cloud2.iaccutrace.com/ws_360_webapps/download.jsp/guid/prev.csv HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

HTTP 500 – INTERNAL_SERVER_ERROR
Download USPS Documentation as PDF or eDoc (Mail.dat for PostalOne!)
GET /ws_360_webapps/download.jsp/{guid}/{ftype}

Use this web service to download a bookmarked PDF of the USPS Documentation. It will include as applicable, Mailing Statement, Qualification Report, CASS Certificate, NCOALink Certificate, Presort Summary, along with other supplemental reports that may be added.

Path variables

guid
string required

generated_guid_with_specific_format

ftype
string required

pdf, maildat.zip

Example:
pdf

Responses

200 OK

This web service will stream the PDF file direct.

Examples

Success Response

GET https://cloud2.iaccutrace.com/ws_360_webapps/download.jsp/guid/pdf|maildat.zip HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

PDF file; Mail.dat Files for PostalOne! eDoc

Error Response

GET https://cloud2.iaccutrace.com/ws_360_webapps/download.jsp/guid/pdf|maildat.zip HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

HTTP 500 – INTERNAL_SERVER_ERROR
Replace All Data
PUT /servoy-service/rest_ws/ws_360/job/{generated_guid}

Use this web service call to write back all modified rows to the Cloud. This web service call would be used if you allowed the customer to edit the CASS Certified, NCOALink Certified or Duplicate Detection records where you displayed in a grid for the user to modify. This web service call should be processed before the Presort web service. You can allow the user to edit the CASS Certified result and make corrections. Then using the CASS REST API Documentation (https://api.iaccutrace.com/docs/api-cass), you can create a one-button CASS Certified lookup to correct the address on-the-fly.

Path variables

generated_guid
string required

Responses

200 OK