This collection contains the documentation for our different RESTful APIs.\n
\nBefore making any of the processing calls, you would want to make sure that the variables within the AccuZIP RESTful API Documentation environment match your account information, including the API Key.\n
\nThe sample API Keys provided below are only for testing. Please replace this with your licensed API Key.
To get details about your account and what is available for you based on your account, use the web service call above.
\nMake sure to put your API Key in the api_key slot in the call. If you're not using a variable, replace {{api_key}} with your real API Key.
\nHere's what each access level means:
Required
\n"},{"key":"apiKey","value":"{{dq_api_key}}","type":"text","description":"Required
\n"},{"key":"callback_url","value":"https://accuzip.com","type":"text","description":"Optional
\n"},{"key":"guid","value":"","type":"text","description":"Required
\n"},{"key":"file","type":"file","description":"Required
\n","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","src":"/C:/Users/auror/Desktop/Test/Demofile.csv"}]},"url":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/uploadProcess.jsp?manual_submit=false","description":"However, the information inside the file can be organized with Tabs, PIPE (|), Comma-Quote, or some other consistent way of separating things. Each row should end with a CRLF (Carriage Return + Line Feed), which is like pressing Enter on your keyboard.
\nREQUIRED COLUMN NAMES:
\nFirst: Can have the full name of the recipient or just the first name.
\nAddress: Contains the primary address used for delivery.
\nCity: Can have the City, State, and ZIP Code or just the City if the state and ZIP code are in separate fields.
\nSal: Can contain the name prefix, for example, Mr; Mrs; Mr. and Mrs.
\nMiddle: Can contain the middle name of the recipient.
\nLast: Can contain the last name of the recipient.
\nAddress2: Can contain secondary address information like the apartment or suite number.
\nSt: Can contain the abbreviated form of the state.
\nZip: Can contain the ZIP or ZIP+4 for the address.
\nUrban: Can contain the Puerto Rico Urbanization Code.
\nCompany: Can contain the company name.
\nIf you want to use your own field names instead of the ones listed above, you can set them up using the values below in the body of the upload call. The field names you use must exactly match (case doesn't matter) the field names in the first row (Header) of the file you're uploading for the address components.
\nMAPPING FIELD NAMES:
\ncol_address: Header field name for the main mailing address (e.g., \"my address\").
\ncol_address2: Header field name for the secondary address, like an apartment or suite number (e.g., \"my adr2\").
\ncol_city: Header field name for the city name (e.g., \"my city\").
\ncol_st: Header field name for the state abbreviation (e.g., \"my state\").
\ncol_zip: Header field name for the ZIP Code, ZIP+4, or Postal code (e.g., \"my zip code\").
\nIt is also recommended that the uploaded mailing list has at least 500 records for a First Class Mail Presort, 200 for a Marketing Mail (Standard) Presort, 100 for NCOALink processing, or fewer for CASS-only processing with no Presort.
\nTo check how many Data Enhancement Services (DES) credits you have left, you can add \"des_credits\": true to the body of the upload call. Once the file is uploaded, make the GET Quote call, and you'll see the number of remaining credits under \"des_credits_available\".
\nWhen you're uploading a file for an EDDM mailing, it always needs to be named \"eddm@.csv.\" The data inside should be separated by commas, and each row should end with a CRLF (Carriage Return + Line Feed). No need for a header record like in a regular mailing list, but the information inside must follow this specific order:
\n5-Digit ZIP Code: This is either the starting ZIP Code of a range or a specific ZIP Code.
\n5-Digit ZIP Code: If you want to specify a range of ZIP Codes, this is the ending ZIP Code.
\nCRRT Code: This is either the starting carrier route code or a specific one.
\nCRRT Code: If you want to specify a range of carrier route codes, this is the ending CRRT code for the ZIP Code(s) mentioned earlier.
\nExample:
1 - For a single ZIP Code in an EDDM list covering 100% of all possible stops for carrier routes in that ZIP Code:
\"93422,,,\"
2 - For a single ZIP Code with all possible City Routes within it:
\"93422,,C000,C999\"
3 - For a range of ZIP Codes covering 100% of all possible stops for carrier routes within any ZIP Codes between the Low and High ZIP Codes:
\"93422,93425,,\"
4 - For multiple ZIP Codes with specific CRRT Codes and CRRT Code ranges:
\"93422,,C001,C002\"
\"93423,,C001,C010\"
\"93434,,C011,\" (Note: This line ends in a comma to match the format.)
\"93401,,,,\" (Note: There are four commas at the end to match the format.)
\"93446,93447,,,\" (Note: There are three commas at the end to match the format.)
If you tell our Web service where to reach you by providing a callBack URL, like https://mysite.com/getAccuzipCallback.php, it will make a special kind of request called an HTTP GET call to that URL once the processing has completed, like https://mysite.com/getAccuzipCallback.php?guid={{GUID}}. However, the {{GUID}} part would be replaced with the actual unique ID (GUID) of your job.
\nThis setup allows your program to receive a message when the job finishes. Once you receive it, you can then make other requests to download the PDF, CSV, or maildat.zip file which are now part of the completed job. So, in simpler terms, it's like telling our system where to tell you when the job has completed so that you can then grab the results.
\n","urlObject":{"path":["ws_360_webapps","v2_0/uploadProcess.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"manual_submit","value":"false"}],"variable":[]}},"response":[{"id":"a78ac46a-f01b-4d5c-95e3-a93f23dee6c9","name":"Upload File","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"backOfficeOption","value":"json","type":"text","description":"Required"},{"key":"apiKey","value":"{{dq_api_key}}","type":"text","description":"Required"},{"key":"callback_url","value":"https://accuzip.com","type":"text","description":"Optional"},{"key":"guid","value":"","type":"text","description":"Required"},{"key":"file","type":"file","description":"Required","src":"/C:/Input/Your/Full/Path/here.csv"}]},"url":{"raw":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/uploadProcess.jsp?manual_submit=false","protocol":"https","host":["cloud2","iaccutrace","com"],"path":["ws_360_webapps","v2_0","uploadProcess.jsp"],"query":[{"key":"manual_submit","value":"false","description":"Required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 11 Dec 2023 22:56:45 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"115"},{"key":"Set-Cookie","value":"JSESSIONID=A0B59008A974E98CCF01DF152E25921F; Path=/ws_360_webapps"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Wed, 11 Jan 1984 05:00:00 GMT"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\"success360Import\":true,\"quote_started\":true,\"cass_started\":false,\"guid\":\"23121183-DBA5-4E46-A57D-199FAEFC658B\"}\r\n"}],"_postman_id":"0fa2b7d3-f4cc-4c49-854b-ba47618dbad0"},{"name":"QUOTE","event":[{"listen":"test","script":{"id":"6fdba514-5e68-48c4-9e5f-e8daa0c89b8c","exec":["tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;","","var data = JSON.parse(responseBody);","tests[\"success\"] = data.success;","","if(responseCode.code === 200){"," // var data = JSON.parse(responseBody);"," // case:new uploaded file"," if((data.success === true || data.success === 'true') && data.Standard_Flat && data.Standard_Card && data.First_Class_Letter ){"," tests[\"success\"] = data.success===\"true\";"," tests[\"Standard_Flat: \"+data.Standard_Flat] = responseBody.has(\"Standard_Flat\");"," "," tests[\"total_presort_records: \"+data.total_presort_records] = responseBody.has(\"total_presort_records\");"," tests[\"Standard_Card: \"+data.Standard_Card] = responseBody.has(\"Standard_Card\");"," tests[\"format: \"+data.format] = responseBody.has(\"format\");"," tests[\"First_Class_Card: \"+data.First_Class_Card] = responseBody.has(\"First_Class_Card\");"," tests[\"mail_piece_size: \"+data.mail_piece_size] = responseBody.has(\"mail_piece_size\");"," tests[\"presort_class: \"+data.presort_class] = responseBody.has(\"presort_class\");"," tests[\"First_Class_Letter: \"+data.First_Class_Letter] = responseBody.has(\"First_Class_Letter\");"," tests[\"postage_saved: \"+data.postage_saved] = responseBody.has(\"postage_saved\");"," tests[\"total_postage: \"+data.total_postage] = responseBody.has(\"total_postage\");"," tests[\"drop_zip: \"+data.drop_zip] = responseBody.has(\"drop_zip\");"," tests[\"First_Class_Flat: \"+data.First_Class_Flat] = responseBody.has(\"First_Class_Flat\");"," // }else if((data.success !== true || data.success === 'false') && (data.message )){"," // }else if((data.success !== true || data.success === 'false')){"," var version = postman.getEnvironmentVariable(\"ver\");"," if(version === null || version === ''){"," var validResponse = validateJSON(data, 0);"," tests[\"Expected JSON format response\"] = validResponse;"," }else if(version !== null && version === 'v2_0/'){"," var validResponse = validateJSON(data, 2);"," tests[\"Expected JSON format response\"] = validResponse;"," }else{"," tests[\"Unknown version => \" + version] = false;"," }"," "," }else if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," //case:previously uploaded file with update Quote run on file"," "," //tests[\"success\"] = data.success===\"true\";","",""," //tests[\"exact_postage\"] = data.exact_postage === \"\";"," tests[\"print_imb\"] = data.print_imb === \"1\";"," tests[\"include_crrt\"] = data.include_crrt === \"0\";"," "," //tests[\"Standard_Letter\"] = data.Standard_Letter === \"\";"," //tests[\"imb_mid\"] = data.imb_mid === \"999999\";"," tests[\"mailing_date\"] = data.mailing_date === \"08/20/2014\";"," //tests[\"thickness_based_on\"] = data.thickness_based_on === \"1\";"," //tests[\"prepared_for_name_address\"] = data.prepared_for_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," //tests[\"postage_saved\"] = data.postage_saved === \"\";"," tests[\"print_barcode\"] = data.print_barcode === \"1\";"," tests[\"weight_value\"] = data.weight_value === \".2\";"," //tests[\"mailing_agent_phone\"] = data.mailing_agent_phone === \"8054617300\";"," tests[\"machinability\"] = data.machinability === \"NONMACHINABLE\";"," //tests[\"json_accutrace_job_id\"] = data.json_accutrace_job_id === \"123456\";"," //tests[\"First_Class_Flat\"] = data.First_Class_Flat === \"\";"," tests[\"permit_holder_mailer_id\"] = data.permit_holder_mailer_id === \"999999\";"," tests[\"tray_type\"] = data.tray_type === \"MMM\";"," tests[\"permit_holder_crid\"] = data.permit_holder_crid === \"8888888\";"," //tests[\"Standard_Card\"] = data.Standard_Card === \"\";"," tests[\"mail_permit_number\"] = data.mail_permit_number === \"199\";"," tests[\"format\"] = data.format === \"UPPER\";"," //tests[\"max2ft\"] = data.max2ft === \"\";"," //tests[\"json_maildat_mpu_name\"] = data.json_maildat_mpu_name === \"JOB1\";"," //tests[\"json_maildat_mpu_description\"] = data.json_maildat_mpu_description === \"TEST JOB\";"," //tests[\"json_accutrace_customer_id\"] = data.json_accutrace_customer_id === \"7700000101\";"," tests[\"calculate_container_volume\"] = data.calculate_container_volume === \"1\";"," //tests[\"mailing_agent_name_address\"] = data.mailing_agent_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," //tests[\"max1ft\"] = data.max1ft === \"\";"," tests[\"mailing_agent_mailer_id\"] = data.mailing_agent_mailer_id === \"999999\";"," tests[\"agent_or_mailer_signing_statement\"] = data.agent_or_mailer_signing_statement === \"STEVE BELMONTE\";"," //tests[\"permit_holder_phone\"] = data.permit_holder_phone === \"8054617300\";"," //tests[\"json_list_owner_information\"] = data.json_list_owner_information === \"company|address|city|state|zip+4|telephone|naics|email|name|title|08/01/2014\";"," tests[\"mailing_agent_edoc_sender_crid\"] = data.mailing_agent_edoc_sender_crid === \"8888888\";"," //tests[\"print_reverse\"] = data.print_reverse === \"0\";"," tests[\"statement_number\"] = data.statement_number === \"1\";"," //tests[\"json_accutrace_api_key\"] = data.json_accutrace_api_key === \"8B5A8632-31FC-4DA7-BDB9-D8B88897AF96\";"," tests[\"agent_or_mailer_email\"] = data.agent_or_mailer_email === \"steve@accuzip.com\";"," tests[\"mail_pay_method\"] = data.mail_pay_method === \"IMPRINT\";"," //tests[\"entry_scf\"] = data.entry_scf === \"0\";"," tests[\"thickness_value\"] = data.thickness_value === \".009\";"," //tests[\"prepared_for_nonprofit_authorization_number\"] = data.prepared_for_nonprofit_authorization_number === \"\";"," //tests[\"min2ft\"] = data.min2ft === \"\";"," tests[\"agent_or_mailer_company\"] = data.agent_or_mailer_company === \"ACCUZIP INC.\";"," //tests[\"prepared_for_crid\"] = data.prepared_for_crid === \"8888888\";"," //tests[\"First_Class_Card\"] = data.First_Class_Card === \"\";"," tests[\"mail_piece_size\"] = data.mail_piece_size === \"LETTER\";"," //tests[\"min1ft\"] = data.min1ft === \"\";"," tests[\"presort_class\"] = data.presort_class === \"STANDARD MAIL\";"," tests[\"piece_length\"] = data.piece_length === \"5.00\";"," //tests[\"permit_holder_name_address\"] = data.permit_holder_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," tests[\"piece_height\"] = data.piece_height === \"4.00\";"," //tests[\"imb_starting_serial_number\"] = data.imb_starting_serial_number === \"\";"," //tests[\"json_maildat_pdr\"] = data.json_maildat_pdr === \"0\";"," //tests[\"entry_ndc\"] = data.entry_ndc === \"0\";"," //tests[\"postage_affixed\"] = data.postage_affixed === \"\";"," //tests[\"Standard_Flat\"] = data.Standard_Flat === \"\";"," //tests[\"net_postage_due_permit_number\"] = data.net_postage_due_permit_number === \"\";"," tests[\"weight_unit\"] = data.weight_unit === \"OUNCES\";"," //tests[\"json_accutrace_job_description\"] = data.json_accutrace_job_description === \"TEST JOB\";"," //tests[\"weight_based_on\"] = data.weight_based_on === \"1\";"," //tests[\"imb_service_type\"] = data.imb_service_type === \"270\";"," //tests[\"First_Class_Letter\"] = data.First_Class_Letter === \"\";"," tests[\"mailing_agent_crid\"] = data.mailing_agent_crid === \"8888888\";"," //tests[\"total_postage\"] = data.total_postage === \"\";"," tests[\"mail_permit_type\"] = data.mail_permit_type === \"PROFIT\";"," tests[\"drop_zip\"] = data.drop_zip === \"93422\";"," //tests[\"json_list_owner_paf_id\"] = data.json_list_owner_paf_id === \"E00001\";"," tests[\"agent_or_mailer_phone\"] = data.agent_or_mailer_phone === \"8054617300\";"," //tests[\"prepared_for_mailer_id\"] = data.prepared_for_mailer_id === \"999999\";"," //tests[\"json_accutrace_notice_email\"] = data.json_accutrace_notice_email === \"steve@accuzip.com\" ;"," tests[\"include_non_zip4\"] = data.include_non_zip4 === \"1\";"," //tests[\"json_accutrace_job_id2\"] = data.json_accutrace_job_id2 === \"789\";"," tests[\"imb_default_mid\"] = data.imb_default_mid === \"999999\";"," }","}","","function validateJSON(result_in, version){"," "," var schema = \"\";"," "," if(version === 0){"," schema = {"," \"name\":\"JSON_response\","," \"properties\":{"," \"Standard_Flat\":{"," \"type\":\"string\","," \"required\":true"," },"," \"Standard_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_presort_records\":{"," \"type\": \"string\","," \"required\":true"," },"," \"format\":{"," \"type\":\"string\","," \"required\":true"," },"," "," \"First_Class_Card\":{"," \"type\":\"string\","," \"required\":true"," },"," \"mail_piece_size\":{"," \"type\":\"string\","," \"required\":true"," },"," \"presort_class\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"postage_saved\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_postage\":{"," \"type\":\"string\","," \"required\":true"," },"," \"drop_zip\":{"," \"type\":\"string\","," \"required\":true"," },"," \"success\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Flat\":{"," \"type\":\"string\","," \"required\":true"," }"," }"," };"," "," }else if(version === 2){"," schema = {"," \"name\":\"JSON_response\","," \"properties\":{"," \"Standard_Flat\":{"," \"type\":\"string\","," \"required\":true"," },"," \"Standard_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_presort_records\":{"," \"type\": \"string\","," \"required\":true"," },"," \"format\":{"," \"type\":\"string\","," \"required\":true"," },"," "," \"First_Class_Card\":{"," \"type\":\"string\","," \"required\":true"," },"," \"mail_piece_size\":{"," \"type\":\"string\","," \"required\":true"," },"," \"presort_class\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"postage_saved\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_postage\":{"," \"type\":\"string\","," \"required\":true"," },"," \"drop_zip\":{"," \"type\":\"string\","," \"required\":true"," },"," \"success\":{"," \"type\":\"boolean\","," \"required\":true"," },"," \"First_Class_Flat\":{"," \"type\":\"string\","," \"required\":true"," }"," }"," }; "," }"," "," // tests[\"Expected JSON format response\"] = tv4.validate(result, schema);"," return tv4.validate(result_in, schema);","}","",""],"type":"text/javascript"}}],"id":"ffbeeacf-239f-4d34-9d1c-930d1f4b82a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{dq_pGUID}}/QUOTE","description":"After you upload a file, use this call to get an estimate of the postage cost for the job and find out if the file was uploaded correctly.\n
Then, keep making the GET Quote call every 10 or so seconds until it says \"success\": true in the response. Once it says \"success\": true, please keep in mind that you would want to wait at least 5 seconds before continuing on to the next call. This is really important because if you jump ahead without waiting for the quote to show \"success\": true after uploading the file, the job might not work properly.
\nIf using one of the \"Additional Data Parameters\" availble in the Upload File call, then the quote might look like this:
\n{\"dq_dpvhsa_d\":\"11\",\"dq_dpvhsv\":\"19\",\"Estimated_Postage_Standard_Card\":\"$548\",\"Estimated_Postage_Standard_Letter\":\"$548\",\"First_Class_Card\":\"$154\",\"dq_message\":\"DQ results have been calculated successfully\",\"Estimated_Postage_First_Class_Card\":\"$526\",\"dq_dpvhsa_n\":\"27\", \"First_Class_Letter\":\"$132\",\"Standard_Card\":\"$382\",\"dq_dpvhsa_s\":\"56\",\"total_postage\":\"\",\"presort_class\":\"\",\"total_records\":\"2,000\",\"dq_dpvhsa_y\":\"1906\",\"mail_piece_size\":\"\",\"First_Class_Flat\":\"$619\",\"format\":\"\",\"drop_zip\":\"\",\"total_presort_records\":\"\",\"Estimated_Postage_Standard_Flat\":\"$935\",\"Standard_Letter\":\"$382\",\"Estimated_Postage_First_Class_Flat\":\"$1,261\",\"success\":true,\"Estimated_Postage_First_Class_Letter\":\"$798\",\"Standard_Flat\":\"$945\",\"postage_saved\":\"\",\"des_credits\": \"0\"}\n\nWhen using the one of the \"dataQualityResults_*\" options, the quote might look like this:
\n{\"dq_dpvhsa_s\":\"70\",\"First_Class\":[{\"flat\":[{\"postage\":\"1126.12\",\"AB\":\"91\",\"PRESORT\":\"0\",\"MB\":\"30\",\"savings\":\"846.88\",\"5B\":\"470\",\"SP\":\"27\",\"3B\":\"1355\"}],\"letter\":[{\"postage\":\"812.98\",\"AB\":\"1186\",\"PRESORT\":\"0\",\"MB\":\"760\",\"savings\":\"114.33\",\"5B\":\"0\",\"SP\":\"27\",\"3B\":\"0\"}],\"card\":[{\"postage\":\"529.70\",\"AB\":\"1186\",\"PRESORT\":\"0\",\"MB\":\"760\",\"savings\":\"160.85\",\"5B\":\"0\",\"SP\":\"27\",\"3B\":\"0\"}]}],\"Nonprofit\":[{\"flat\":[{\"AB\":\"77\",\"AD\":\"8\",\"HP\":\"0\",\"5B\":\"607\",\"CR\":\"0\",\"3B\":\"1233\",\"5D\":\"0\",\"postage\":\"603.20\",\"3D\":\"3\",\"MB\":\"29\",\"MD\":\"16\",\"savings\":\"1369.80\",\"WS\":\"0\",\"HD\":\"0\",\"SP\":\"0\"}],\"letter\":[{\"AB\":\"1186\",\"AD\":\"0\",\"HP\":\"0\",\"5B\":\"0\",\"CR\":\"0\",\"3B\":\"0\",\"5D\":\"0\",\"postage\":\"321.97\",\"3D\":\"0\",\"MB\":\"787\",\"MD\":\"0\",\"savings\":\"605.34\",\"WS\":\"0\",\"HD\":\"0\",\"SP\":\"0\"}]}],\"Duplicates\":[{\"found\":\"20\",\"description\":\"by Address and First and Last Name\",\"setting\":\"2\"}],\"dq_dpvhsa_d\":\"11\",\"dq_dpvhsv\":\"31\",\"NCOALink\":[{\"months_19_48\":\"205\",\"matches\":\"296\",\"months_1_18\":\"91\",\"moved_no_forwarding\":\"7\"}],\"success\":true,\"dq_dpvhsa_y\":\"1892\",\"dq_message\":\"DQ results have been calculated successfully\",\"Standard\":[{\"flat\":[{\"AB\":\"77\",\"AD\":\"8\",\"HP\":\"0\",\"5B\":\"607\",\"CR\":\"0\",\"3B\":\"1233\",\"5D\":\"0\",\"postage\":\"930.72\",\"3D\":\"3\",\"MB\":\"29\",\"MD\":\"16\",\"savings\":\"1042.28\",\"WS\":\"0\",\"HD\":\"0\",\"SP\":\"0\"}],\"letter\":[{\"AB\":\"1186\",\"AD\":\"0\",\"HP\":\"0\",\"5B\":\"0\",\"CR\":\"0\",\"3B\":\"0\",\"5D\":\"0\",\"postage\":\"548.86\",\"3D\":\"0\",\"MB\":\"787\",\"MD\":\"0\",\"savings\":\"378.45\",\"WS\":\"0\",\"HD\":\"0\",\"SP\":\"0\"}]}],\"dq_dpvhsa_n\":\"27\"}\n\n\"dq_message\": \"DQ results have been calculated successfully\" = The DQ Message
\"dq_dpvhsa_y\": \"1906\" = Address was DPV confirmed for both primary and (if present) secondary numbers.
\"dq_dpvhsa_d\": \"11\" = Address was DPV confirmed for the primary number only, and Secondary number information was missing.
\"dq_dpvhsa_s\": \"56\" = Address was DPV confirmed for the primary number only, and secondary number information was present but unconfirmed.
\"dq_dpvhsa_n\": \"27\" = Both Primary and (if present) Secondary number information failed to DPV Confirm.
\"dq_dpvhsv\": \"19\" = Address is Vacant for at least 90-days
Use this call to update the Quote the parameters for the mailing. After this call has been made, you will also want to make the GET Quote call again to verify that the new quote was accepted
\nThe call will return 200 OK when successful, and the values from the body of the call will be within the response from the GET Quote call afterwards. Also, all JSON Values within the quote below have a JSON Type of String.
\nThis call does two main things: it cleans up and organizes all the addresses in your list using something called CASS. After that's done, it automatically starts the PRESORT process based on the type of mail, size, and other details you provided in the earlier UPDATE Quote call.
\nThere are other calls that can be made for different kinds of processing, but in this example, we're talking about CASS and PRESORT.
\n
\nOne more thing, if any records are taken out during Duplicate Detection, you'll find them in a file called \".del\" within the downloadable maildat.zip file after your job is done processing.
CASS = The file will only run through CASS
\nNCOA = The file will only run through CASS and NCOA
\nCASS-PRESORT = The file will run through CASS and PRESORT.
\nCASS-NCOA-PRESORT = It will process through CASS, NCOA, and PRESORT the list
\nCASS-NCOA-DUPS-PRESORT = It will process through CASS, NCOA, Duplicate Detection (by Address and Company if present), and PRESORT.
\nCASS-NCOA-DUPS_01-PRESORT = It will process through CASS, NCOA, Duplicate Detection (by Address and Company if present), and PRESORT.
\nCASS-NCOA-DUPS_02-PRESORT = It will process through CASS, NCOA, Duplicate Detection (by Address, First, and Last), and PRESORT.
\nCASS-NCOA-DUPS_03-PRESORT = It will process through CASS, NCOA, Duplicate Detection (by Address and Last name), and PRESORT.
\nCASS-DUPS-PRESORT = It will process through CASS, Duplicate Detection (by Address and Company if present)
\nCASS-DUPS_01-PRESORT = It will process through CASS, Duplicate Detection (by Address and Company if present)
\nCASS-DUPS_02-PRESORT = It will process through CASS, Duplicate Detection (by Address, First, and Last)
\nCASS-DUPS_03-PRESORT = It will process through CASS, Duplicate Detection (by Address and Last name)
\n
\nPlease keep in mind that you will need to make sure that a fully executed Processing Acknowledgment Form (PAF) for each List Owner is submitted to AccuZIP when making one of the processing calls that contains NCOA.
Our electronic PAF can be completed at: http://accuzip.com/products/ncoalink/paf/new
\n","urlObject":{"path":["servoy-service","rest_ws","ws_360","v2_0/job","{{dq_pGUID}}","CASS-PRESORT"],"host":["https://cloud2.iaccutrace.com"],"query":[],"variable":[]}},"response":[{"id":"48143acf-3e2b-4803-91fb-0366fa5501af","name":"CASS-PRESORT","originalRequest":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{dq_pGUID}}/CASS-PRESORT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 22:58:38 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"16"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"dee48fae-0e15-4cda-9117-9afa1ffb38df"},{"name":"QUOTE - Check status","event":[{"listen":"test","script":{"id":"15b3ed39-f43f-4fcd-8273-cba40882fbbf","exec":["tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;","","var data = JSON.parse(responseBody);","tests[\"success\"] = data.success;","","if(responseCode.code === 200){"," // var data = JSON.parse(responseBody);"," // case:new uploaded file"," if((data.success === true || data.success === 'true') && data.Standard_Flat && data.Standard_Card && data.First_Class_Letter ){"," tests[\"success\"] = data.success===\"true\";"," tests[\"Standard_Flat: \"+data.Standard_Flat] = responseBody.has(\"Standard_Flat\");"," "," tests[\"total_presort_records: \"+data.total_presort_records] = responseBody.has(\"total_presort_records\");"," tests[\"Standard_Card: \"+data.Standard_Card] = responseBody.has(\"Standard_Card\");"," tests[\"format: \"+data.format] = responseBody.has(\"format\");"," tests[\"First_Class_Card: \"+data.First_Class_Card] = responseBody.has(\"First_Class_Card\");"," tests[\"mail_piece_size: \"+data.mail_piece_size] = responseBody.has(\"mail_piece_size\");"," tests[\"presort_class: \"+data.presort_class] = responseBody.has(\"presort_class\");"," tests[\"First_Class_Letter: \"+data.First_Class_Letter] = responseBody.has(\"First_Class_Letter\");"," tests[\"postage_saved: \"+data.postage_saved] = responseBody.has(\"postage_saved\");"," tests[\"total_postage: \"+data.total_postage] = responseBody.has(\"total_postage\");"," tests[\"drop_zip: \"+data.drop_zip] = responseBody.has(\"drop_zip\");"," tests[\"First_Class_Flat: \"+data.First_Class_Flat] = responseBody.has(\"First_Class_Flat\");"," // }else if((data.success !== true || data.success === 'false') && (data.message )){"," // }else if((data.success !== true || data.success === 'false')){"," var version = postman.getEnvironmentVariable(\"ver\");"," if(version === null || version === ''){"," var validResponse = validateJSON(data, 0);"," tests[\"Expected JSON format response\"] = validResponse;"," }else if(version !== null && version === 'v2_0/'){"," var validResponse = validateJSON(data, 2);"," tests[\"Expected JSON format response\"] = validResponse;"," }else{"," tests[\"Unknown version => \" + version] = false;"," }"," "," }else if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," //case:previously uploaded file with update Quote run on file"," "," //tests[\"success\"] = data.success===\"true\";","",""," //tests[\"exact_postage\"] = data.exact_postage === \"\";"," tests[\"print_imb\"] = data.print_imb === \"1\";"," tests[\"include_crrt\"] = data.include_crrt === \"0\";"," "," //tests[\"Standard_Letter\"] = data.Standard_Letter === \"\";"," //tests[\"imb_mid\"] = data.imb_mid === \"999999\";"," tests[\"mailing_date\"] = data.mailing_date === \"08/20/2014\";"," //tests[\"thickness_based_on\"] = data.thickness_based_on === \"1\";"," //tests[\"prepared_for_name_address\"] = data.prepared_for_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," //tests[\"postage_saved\"] = data.postage_saved === \"\";"," tests[\"print_barcode\"] = data.print_barcode === \"1\";"," tests[\"weight_value\"] = data.weight_value === \".2\";"," //tests[\"mailing_agent_phone\"] = data.mailing_agent_phone === \"8054617300\";"," tests[\"machinability\"] = data.machinability === \"NONMACHINABLE\";"," //tests[\"json_accutrace_job_id\"] = data.json_accutrace_job_id === \"123456\";"," //tests[\"First_Class_Flat\"] = data.First_Class_Flat === \"\";"," tests[\"permit_holder_mailer_id\"] = data.permit_holder_mailer_id === \"999999\";"," tests[\"tray_type\"] = data.tray_type === \"MMM\";"," tests[\"permit_holder_crid\"] = data.permit_holder_crid === \"8888888\";"," //tests[\"Standard_Card\"] = data.Standard_Card === \"\";"," tests[\"mail_permit_number\"] = data.mail_permit_number === \"199\";"," tests[\"format\"] = data.format === \"UPPER\";"," //tests[\"max2ft\"] = data.max2ft === \"\";"," //tests[\"json_maildat_mpu_name\"] = data.json_maildat_mpu_name === \"JOB1\";"," //tests[\"json_maildat_mpu_description\"] = data.json_maildat_mpu_description === \"TEST JOB\";"," //tests[\"json_accutrace_customer_id\"] = data.json_accutrace_customer_id === \"7700000101\";"," tests[\"calculate_container_volume\"] = data.calculate_container_volume === \"1\";"," //tests[\"mailing_agent_name_address\"] = data.mailing_agent_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," //tests[\"max1ft\"] = data.max1ft === \"\";"," tests[\"mailing_agent_mailer_id\"] = data.mailing_agent_mailer_id === \"999999\";"," tests[\"agent_or_mailer_signing_statement\"] = data.agent_or_mailer_signing_statement === \"STEVE BELMONTE\";"," //tests[\"permit_holder_phone\"] = data.permit_holder_phone === \"8054617300\";"," //tests[\"json_list_owner_information\"] = data.json_list_owner_information === \"company|address|city|state|zip+4|telephone|naics|email|name|title|08/01/2014\";"," tests[\"mailing_agent_edoc_sender_crid\"] = data.mailing_agent_edoc_sender_crid === \"8888888\";"," //tests[\"print_reverse\"] = data.print_reverse === \"0\";"," tests[\"statement_number\"] = data.statement_number === \"1\";"," //tests[\"json_accutrace_api_key\"] = data.json_accutrace_api_key === \"8B5A8632-31FC-4DA7-BDB9-D8B88897AF96\";"," tests[\"agent_or_mailer_email\"] = data.agent_or_mailer_email === \"steve@accuzip.com\";"," tests[\"mail_pay_method\"] = data.mail_pay_method === \"IMPRINT\";"," //tests[\"entry_scf\"] = data.entry_scf === \"0\";"," tests[\"thickness_value\"] = data.thickness_value === \".009\";"," //tests[\"prepared_for_nonprofit_authorization_number\"] = data.prepared_for_nonprofit_authorization_number === \"\";"," //tests[\"min2ft\"] = data.min2ft === \"\";"," tests[\"agent_or_mailer_company\"] = data.agent_or_mailer_company === \"ACCUZIP INC.\";"," //tests[\"prepared_for_crid\"] = data.prepared_for_crid === \"8888888\";"," //tests[\"First_Class_Card\"] = data.First_Class_Card === \"\";"," tests[\"mail_piece_size\"] = data.mail_piece_size === \"LETTER\";"," //tests[\"min1ft\"] = data.min1ft === \"\";"," tests[\"presort_class\"] = data.presort_class === \"STANDARD MAIL\";"," tests[\"piece_length\"] = data.piece_length === \"5.00\";"," //tests[\"permit_holder_name_address\"] = data.permit_holder_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," tests[\"piece_height\"] = data.piece_height === \"4.00\";"," //tests[\"imb_starting_serial_number\"] = data.imb_starting_serial_number === \"\";"," //tests[\"json_maildat_pdr\"] = data.json_maildat_pdr === \"0\";"," //tests[\"entry_ndc\"] = data.entry_ndc === \"0\";"," //tests[\"postage_affixed\"] = data.postage_affixed === \"\";"," //tests[\"Standard_Flat\"] = data.Standard_Flat === \"\";"," //tests[\"net_postage_due_permit_number\"] = data.net_postage_due_permit_number === \"\";"," tests[\"weight_unit\"] = data.weight_unit === \"OUNCES\";"," //tests[\"json_accutrace_job_description\"] = data.json_accutrace_job_description === \"TEST JOB\";"," //tests[\"weight_based_on\"] = data.weight_based_on === \"1\";"," //tests[\"imb_service_type\"] = data.imb_service_type === \"270\";"," //tests[\"First_Class_Letter\"] = data.First_Class_Letter === \"\";"," tests[\"mailing_agent_crid\"] = data.mailing_agent_crid === \"8888888\";"," //tests[\"total_postage\"] = data.total_postage === \"\";"," tests[\"mail_permit_type\"] = data.mail_permit_type === \"PROFIT\";"," tests[\"drop_zip\"] = data.drop_zip === \"93422\";"," //tests[\"json_list_owner_paf_id\"] = data.json_list_owner_paf_id === \"E00001\";"," tests[\"agent_or_mailer_phone\"] = data.agent_or_mailer_phone === \"8054617300\";"," //tests[\"prepared_for_mailer_id\"] = data.prepared_for_mailer_id === \"999999\";"," //tests[\"json_accutrace_notice_email\"] = data.json_accutrace_notice_email === \"steve@accuzip.com\" ;"," tests[\"include_non_zip4\"] = data.include_non_zip4 === \"1\";"," //tests[\"json_accutrace_job_id2\"] = data.json_accutrace_job_id2 === \"789\";"," tests[\"imb_default_mid\"] = data.imb_default_mid === \"999999\";"," }","}","","function validateJSON(result_in, version){"," "," var schema = \"\";"," "," if(version === 0){"," schema = {"," \"name\":\"JSON_response\","," \"properties\":{"," \"Standard_Flat\":{"," \"type\":\"string\","," \"required\":true"," },"," \"Standard_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_presort_records\":{"," \"type\": \"string\","," \"required\":true"," },"," \"format\":{"," \"type\":\"string\","," \"required\":true"," },"," "," \"First_Class_Card\":{"," \"type\":\"string\","," \"required\":true"," },"," \"mail_piece_size\":{"," \"type\":\"string\","," \"required\":true"," },"," \"presort_class\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"postage_saved\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_postage\":{"," \"type\":\"string\","," \"required\":true"," },"," \"drop_zip\":{"," \"type\":\"string\","," \"required\":true"," },"," \"success\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Flat\":{"," \"type\":\"string\","," \"required\":true"," }"," }"," };"," "," }else if(version === 2){"," schema = {"," \"name\":\"JSON_response\","," \"properties\":{"," \"Standard_Flat\":{"," \"type\":\"string\","," \"required\":true"," },"," \"Standard_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_presort_records\":{"," \"type\": \"string\","," \"required\":true"," },"," \"format\":{"," \"type\":\"string\","," \"required\":true"," },"," "," \"First_Class_Card\":{"," \"type\":\"string\","," \"required\":true"," },"," \"mail_piece_size\":{"," \"type\":\"string\","," \"required\":true"," },"," \"presort_class\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"postage_saved\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_postage\":{"," \"type\":\"string\","," \"required\":true"," },"," \"drop_zip\":{"," \"type\":\"string\","," \"required\":true"," },"," \"success\":{"," \"type\":\"boolean\","," \"required\":true"," },"," \"First_Class_Flat\":{"," \"type\":\"string\","," \"required\":true"," }"," }"," }; "," }"," "," // tests[\"Expected JSON format response\"] = tv4.validate(result, schema);"," return tv4.validate(result_in, schema);","}","",""],"type":"text/javascript"}}],"id":"03e200f1-b55b-42ab-afb3-f88ccaced7c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{dq_pGUID}}/QUOTE","description":"This call is the same call as the previous GET Quote call, but you would want to make the call once every 5-10 seconds until \"task_name\": \"FINISHED\" is present within the returned quote. This means that whichever processing call you made (like CASS-PRESORT) has finished.
\nOnce you see \"task_name\": \"FINISHED\", you will want to wait at least 5 seconds to prevent race conditions before making the download call to get your results.
\n","urlObject":{"path":["servoy-service","rest_ws","ws_360","v2_0/job","{{dq_pGUID}}","QUOTE"],"host":["https://cloud2.iaccutrace.com"],"query":[],"variable":[]}},"response":[{"id":"ebfb878a-e765-4a3d-b75c-2b8830a508cf","name":"QUOTE - Check status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{dq_pGUID}}/QUOTE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Dec 2023 23:00:27 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"2340"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"prepared_for_name_address\": \"Contact|company|address|city|state|zip+4\",\n \"accutrace_job_id2\": \"789\",\n \"maildat_mpu_description\": \"TEST JOB\",\n \"task_percentage_completed\": \"100\",\n \"First_Class_Card\": \"\",\n \"agent_or_mailer_phone\": \"8059991234\",\n \"permit_holder_crid\": \"8888888\",\n \"First_Class_Letter\": \"\",\n \"Standard_Card\": \"\",\n \"max2ft\": \"\",\n \"total_postage\": \"$1,185.25\",\n \"print_barcode\": \"1\",\n \"min2ft\": \"\",\n \"total_records\": \"3111\",\n \"mailing_agent_edoc_sender_crid\": \"8888888\",\n \"piece_length\": \"5.00\",\n \"mailing_date\": \"06/30/2016\",\n \"statement_number\": \"1\",\n \"thickness_value\": \".009\",\n \"imb_starting_serial_number\": \"\",\n \"accutrace_notice_email\": \"\",\n \"format\": \"UPPER\",\n \"machinability\": \"MACHINABLE\",\n \"include_crrt\": \"0\",\n \"permit_holder_mailer_id\": \"999999\",\n \"prepared_for_crid\": \"8888888\",\n \"total_presort_records\": \"3108\",\n \"maildat_mpu_name\": \"JOB1\",\n \"imb_default_mid\": \"999999\",\n \"list_owner_information\": \"company|address|city|state|zip+4|telephone|naics|email|name|title|08/01/2014\",\n \"weight_unit\": \"OUNCES\",\n \"success\": true,\n \"print_reverse\": \"0\",\n \"agent_or_mailer_signing_statement\": \"JOHN DOE\",\n \"entry_scf\": \"0\",\n \"northsouth\": \"\",\n \"thickness_based_on\": \"1\",\n \"task_name\": \"FINISHED\",\n \"print_imb\": \"1\",\n \"imb_mid\": \"999999\",\n \"accutrace_api_key\": \"\",\n \"mail_permit_type\": \"PROFIT\",\n \"mailing_agent_crid\": \"8888888\",\n \"prepared_for_nonprofit_authorization_number\": \"\",\n \"entry_ndc\": \"0\",\n \"tray_type\": \"MMM\",\n \"max1ft\": \"\",\n \"mail_pay_method\": \"IMPRINT\",\n \"include_non_zip4\": \"1\",\n \"presort_class\": \"FIRST CLASS\",\n \"min1ft\": \"\",\n \"prepared_for_mailer_id\": \"999999\",\n \"imb_service_type\": \"270\",\n \"exact_postage\": \"\",\n \"mail_piece_size\": \"CARD\",\n \"accutrace_customer_id\": \"\",\n \"First_Class_Flat\": \"\",\n \"weight_based_on\": \"1\",\n \"mailing_agent_name_address\": \"Contact|company|address|city|state|zip+4\",\n \"weight_value\": \".2\",\n \"calculate_container_volume\": \"1\",\n \"permit_holder_phone\": \"8059991234\",\n \"task_state\": \"FINISHED\",\n \"permit_holder_name_address\": \"Contact|company|address|city|state|zip+4\",\n \"drop_zip\": \"93422\",\n \"piece_height\": \"4.00\",\n \"postage_affixed\": \"\",\n \"task_process\": \"CASS-PRESORT\",\n \"accutrace_job_description\": \"TEST JOB\",\n \"mail_permit_number\": \"199\",\n \"accutrace_job_id\": \"123456\",\n \"maildat_commingle\": \"0\",\n \"Standard_Letter\": \"\",\n \"maildat_pdr\": \"0\",\n \"net_postage_due_permit_number\": \"\",\n \"mailing_agent_phone\": \"8059991234\",\n \"agent_or_mailer_company\": \"ABC INC.\",\n \"mailing_agent_mailer_id\": \"999999\",\n \"agent_or_mailer_email\": \"email@mydotcom.com\",\n \"list_owner_paf_id\": \"\",\n \"postage_saved\": \"$399.83\",\n \"Standard_Flat\": \"\"\n}"}],"_postman_id":"03e200f1-b55b-42ab-afb3-f88ccaced7c0"},{"name":"Download Completed - Documentation, Mail.dat, Print Ready CSV","event":[{"listen":"test","script":{"id":"af342634-3a78-40fd-aacc-d55e555ad78a","exec":["try{",""," tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;"," "," "," "," var jsonData = responseBody.has(\"{\\\"success\\\"\" + \":\");"," if(responseCode.code === 200 && jsonData){"," var data = JSON.parse(responseBody);"," if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," tests[\"Data format issue. responseBody => \" + responseBody] = false;"," }"," }","","}catch(exception){"," tests[\"Exception => \" + exception.message] = false;"," tests[\"responseBody => \" + responseBody] = false;"," console.log(\"exception => \" + exception.message);"," console.log(\"responseBody => \" + responseBody);","}"],"type":"text/javascript"}}],"id":"f920f45f-f99a-4d55-a548-3d1a6239131a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{dq_pGUID}}&ftype=maildat.zip","description":"This request lets you download all the finished files for a particular job GUID by choosing the file type (ftype) you want. You can get the ready-to-print CSV, a preview of the CSV, the eDocumentation, or the complete maildat.zip file. The maildat.zip includes the print-ready CSV, the eDocumentation, and the necessary mail.dat files for uploading the job to PostalOne.
\nHere are all of the different \"ftype\" values you can use within the call:
This is the same as the previous Upload Call, but the generated quote also includes estimated presort record and postage totals based on the Data Quality option enabled.
\nThere are also other options that can be added to the body of the Upload call to perform different features to get their estimations. However, you can only have one \"dataQualityResults\" feature enabled for a file.
\nAdditional Data Parameters:
\ndataQualityResults_CASS: false = CASS only
\ndataQualityResults_NCOA: false = CASS and NCOA only
\ndataQualityResults_NCOA_DUPS_01: false = CASS, NCOA, and Duplicate Detection by Address and Company
\ndataQualityResults_NCOA_DUPS_02: false = CASS, NCOA, and Duplicate Detection by First, Last, and Address
\ndataQualityResults_NCOA_DUPS_03: false = CASS, NCOA, and Duplicate Detection by Address and Last name
\ndataQualityResults_DUPS_01: false = CASS and Duplicate Detection by Address and Company
\ndataQualityResults_DUPS_02: false = CASS and Duplicate Detection by First, Last, and Address
\ndataQualityResults_DUPS_03: false = CASS and Duplicate Detection by Address and Last name.
\nIf set to true (not recommended), our service will automatically check and verify addresses using DPV Confirmation after the upload call has been made. However, Setting this value to true does not produce any detail output and is an unnecessary option for most scenarios. Our recommendation is to set this as false. The Data Quality (DQ) results will appear in the result from the GET QUOTE call, and can help you determine the quality. See GET QUOTE for the DQ return values. This process only returns a few summary values and does not replace the GET CASS call.
\nIf you wish to run your list through Data Enhancement Services (DES) to add walk sequence information to claim carrier route rates for the mailing, you would need DES credits. If you have previously purchased DES credits, you can check the number remaining on your account by enabling \"des_credits\" within the body of the upload call. Then, the quote you get back after uploading will show the total DES credits available for your account.
To learn more about DES Services, you can visit this link: DES Services Information.
\n","urlObject":{"path":["ws_360_webapps","v2_0/uploadProcess.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"key":"manual_submit","value":"false"}],"variable":[]}},"response":[{"id":"9196de22-9c7f-4f4a-a723-993bb6a09aaa","name":"Upload File with dataQualityResults_CASS","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"backOfficeOption","value":"json","type":"text"},{"key":"apiKey","value":"{{dq_api_key}}","type":"text"},{"key":"callbackURL","value":"https://accuzip.com","type":"text"},{"key":"guid","value":"","type":"text"},{"key":"file","type":"file","src":"/C:/Users/auror/Desktop/Test/demofile.csv"},{"key":"dataQualityResults_CASS","value":"true","type":"text"}]},"url":{"raw":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/uploadProcess.jsp?manual_submit=false","host":["https://cloud2.iaccutrace.com"],"path":["ws_360_webapps","v2_0/uploadProcess.jsp"],"query":[{"key":"manual_submit","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 12 Dec 2023 14:03:48 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"115"},{"key":"Set-Cookie","value":"JSESSIONID=B732DAC7619292702877C06D03D58F10; Path=/ws_360_webapps"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Wed, 11 Jan 1984 05:00:00 GMT"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\"success360Import\":true,\"quote_started\":true,\"cass_started\":false,\"guid\":\"23121249-92C1-44A8-8109-521A148C700F\"}\r\n"}],"_postman_id":"3a197a06-1649-44b5-b3db-0da77ded2fe2"},{"name":"QUOTE with dataQualityResults_CASS","event":[{"listen":"test","script":{"id":"6fdba514-5e68-48c4-9e5f-e8daa0c89b8c","exec":["tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;","","var data = JSON.parse(responseBody);","tests[\"success\"] = data.success;","","if(responseCode.code === 200){"," // var data = JSON.parse(responseBody);"," // case:new uploaded file"," if((data.success === true || data.success === 'true') && data.Standard_Flat && data.Standard_Card && data.First_Class_Letter ){"," tests[\"success\"] = data.success===\"true\";"," tests[\"Standard_Flat: \"+data.Standard_Flat] = responseBody.has(\"Standard_Flat\");"," "," tests[\"total_presort_records: \"+data.total_presort_records] = responseBody.has(\"total_presort_records\");"," tests[\"Standard_Card: \"+data.Standard_Card] = responseBody.has(\"Standard_Card\");"," tests[\"format: \"+data.format] = responseBody.has(\"format\");"," tests[\"First_Class_Card: \"+data.First_Class_Card] = responseBody.has(\"First_Class_Card\");"," tests[\"mail_piece_size: \"+data.mail_piece_size] = responseBody.has(\"mail_piece_size\");"," tests[\"presort_class: \"+data.presort_class] = responseBody.has(\"presort_class\");"," tests[\"First_Class_Letter: \"+data.First_Class_Letter] = responseBody.has(\"First_Class_Letter\");"," tests[\"postage_saved: \"+data.postage_saved] = responseBody.has(\"postage_saved\");"," tests[\"total_postage: \"+data.total_postage] = responseBody.has(\"total_postage\");"," tests[\"drop_zip: \"+data.drop_zip] = responseBody.has(\"drop_zip\");"," tests[\"First_Class_Flat: \"+data.First_Class_Flat] = responseBody.has(\"First_Class_Flat\");"," // }else if((data.success !== true || data.success === 'false') && (data.message )){"," // }else if((data.success !== true || data.success === 'false')){"," var version = postman.getEnvironmentVariable(\"ver\");"," if(version === null || version === ''){"," var validResponse = validateJSON(data, 0);"," tests[\"Expected JSON format response\"] = validResponse;"," }else if(version !== null && version === 'v2_0/'){"," var validResponse = validateJSON(data, 2);"," tests[\"Expected JSON format response\"] = validResponse;"," }else{"," tests[\"Unknown version => \" + version] = false;"," }"," "," }else if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," //case:previously uploaded file with update Quote run on file"," "," //tests[\"success\"] = data.success===\"true\";","",""," //tests[\"exact_postage\"] = data.exact_postage === \"\";"," tests[\"print_imb\"] = data.print_imb === \"1\";"," tests[\"include_crrt\"] = data.include_crrt === \"0\";"," "," //tests[\"Standard_Letter\"] = data.Standard_Letter === \"\";"," //tests[\"imb_mid\"] = data.imb_mid === \"999999\";"," tests[\"mailing_date\"] = data.mailing_date === \"08/20/2014\";"," //tests[\"thickness_based_on\"] = data.thickness_based_on === \"1\";"," //tests[\"prepared_for_name_address\"] = data.prepared_for_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," //tests[\"postage_saved\"] = data.postage_saved === \"\";"," tests[\"print_barcode\"] = data.print_barcode === \"1\";"," tests[\"weight_value\"] = data.weight_value === \".2\";"," //tests[\"mailing_agent_phone\"] = data.mailing_agent_phone === \"8054617300\";"," tests[\"machinability\"] = data.machinability === \"NONMACHINABLE\";"," //tests[\"json_accutrace_job_id\"] = data.json_accutrace_job_id === \"123456\";"," //tests[\"First_Class_Flat\"] = data.First_Class_Flat === \"\";"," tests[\"permit_holder_mailer_id\"] = data.permit_holder_mailer_id === \"999999\";"," tests[\"tray_type\"] = data.tray_type === \"MMM\";"," tests[\"permit_holder_crid\"] = data.permit_holder_crid === \"8888888\";"," //tests[\"Standard_Card\"] = data.Standard_Card === \"\";"," tests[\"mail_permit_number\"] = data.mail_permit_number === \"199\";"," tests[\"format\"] = data.format === \"UPPER\";"," //tests[\"max2ft\"] = data.max2ft === \"\";"," //tests[\"json_maildat_mpu_name\"] = data.json_maildat_mpu_name === \"JOB1\";"," //tests[\"json_maildat_mpu_description\"] = data.json_maildat_mpu_description === \"TEST JOB\";"," //tests[\"json_accutrace_customer_id\"] = data.json_accutrace_customer_id === \"7700000101\";"," tests[\"calculate_container_volume\"] = data.calculate_container_volume === \"1\";"," //tests[\"mailing_agent_name_address\"] = data.mailing_agent_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," //tests[\"max1ft\"] = data.max1ft === \"\";"," tests[\"mailing_agent_mailer_id\"] = data.mailing_agent_mailer_id === \"999999\";"," tests[\"agent_or_mailer_signing_statement\"] = data.agent_or_mailer_signing_statement === \"STEVE BELMONTE\";"," //tests[\"permit_holder_phone\"] = data.permit_holder_phone === \"8054617300\";"," //tests[\"json_list_owner_information\"] = data.json_list_owner_information === \"company|address|city|state|zip+4|telephone|naics|email|name|title|08/01/2014\";"," tests[\"mailing_agent_edoc_sender_crid\"] = data.mailing_agent_edoc_sender_crid === \"8888888\";"," //tests[\"print_reverse\"] = data.print_reverse === \"0\";"," tests[\"statement_number\"] = data.statement_number === \"1\";"," //tests[\"json_accutrace_api_key\"] = data.json_accutrace_api_key === \"8B5A8632-31FC-4DA7-BDB9-D8B88897AF96\";"," tests[\"agent_or_mailer_email\"] = data.agent_or_mailer_email === \"steve@accuzip.com\";"," tests[\"mail_pay_method\"] = data.mail_pay_method === \"IMPRINT\";"," //tests[\"entry_scf\"] = data.entry_scf === \"0\";"," tests[\"thickness_value\"] = data.thickness_value === \".009\";"," //tests[\"prepared_for_nonprofit_authorization_number\"] = data.prepared_for_nonprofit_authorization_number === \"\";"," //tests[\"min2ft\"] = data.min2ft === \"\";"," tests[\"agent_or_mailer_company\"] = data.agent_or_mailer_company === \"ACCUZIP INC.\";"," //tests[\"prepared_for_crid\"] = data.prepared_for_crid === \"8888888\";"," //tests[\"First_Class_Card\"] = data.First_Class_Card === \"\";"," tests[\"mail_piece_size\"] = data.mail_piece_size === \"LETTER\";"," //tests[\"min1ft\"] = data.min1ft === \"\";"," tests[\"presort_class\"] = data.presort_class === \"STANDARD MAIL\";"," tests[\"piece_length\"] = data.piece_length === \"5.00\";"," //tests[\"permit_holder_name_address\"] = data.permit_holder_name_address === \"Steve Belmonte|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\";"," tests[\"piece_height\"] = data.piece_height === \"4.00\";"," //tests[\"imb_starting_serial_number\"] = data.imb_starting_serial_number === \"\";"," //tests[\"json_maildat_pdr\"] = data.json_maildat_pdr === \"0\";"," //tests[\"entry_ndc\"] = data.entry_ndc === \"0\";"," //tests[\"postage_affixed\"] = data.postage_affixed === \"\";"," //tests[\"Standard_Flat\"] = data.Standard_Flat === \"\";"," //tests[\"net_postage_due_permit_number\"] = data.net_postage_due_permit_number === \"\";"," tests[\"weight_unit\"] = data.weight_unit === \"OUNCES\";"," //tests[\"json_accutrace_job_description\"] = data.json_accutrace_job_description === \"TEST JOB\";"," //tests[\"weight_based_on\"] = data.weight_based_on === \"1\";"," //tests[\"imb_service_type\"] = data.imb_service_type === \"270\";"," //tests[\"First_Class_Letter\"] = data.First_Class_Letter === \"\";"," tests[\"mailing_agent_crid\"] = data.mailing_agent_crid === \"8888888\";"," //tests[\"total_postage\"] = data.total_postage === \"\";"," tests[\"mail_permit_type\"] = data.mail_permit_type === \"PROFIT\";"," tests[\"drop_zip\"] = data.drop_zip === \"93422\";"," //tests[\"json_list_owner_paf_id\"] = data.json_list_owner_paf_id === \"E00001\";"," tests[\"agent_or_mailer_phone\"] = data.agent_or_mailer_phone === \"8054617300\";"," //tests[\"prepared_for_mailer_id\"] = data.prepared_for_mailer_id === \"999999\";"," //tests[\"json_accutrace_notice_email\"] = data.json_accutrace_notice_email === \"steve@accuzip.com\" ;"," tests[\"include_non_zip4\"] = data.include_non_zip4 === \"1\";"," //tests[\"json_accutrace_job_id2\"] = data.json_accutrace_job_id2 === \"789\";"," tests[\"imb_default_mid\"] = data.imb_default_mid === \"999999\";"," }","}","","function validateJSON(result_in, version){"," "," var schema = \"\";"," "," if(version === 0){"," schema = {"," \"name\":\"JSON_response\","," \"properties\":{"," \"Standard_Flat\":{"," \"type\":\"string\","," \"required\":true"," },"," \"Standard_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_presort_records\":{"," \"type\": \"string\","," \"required\":true"," },"," \"format\":{"," \"type\":\"string\","," \"required\":true"," },"," "," \"First_Class_Card\":{"," \"type\":\"string\","," \"required\":true"," },"," \"mail_piece_size\":{"," \"type\":\"string\","," \"required\":true"," },"," \"presort_class\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"postage_saved\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_postage\":{"," \"type\":\"string\","," \"required\":true"," },"," \"drop_zip\":{"," \"type\":\"string\","," \"required\":true"," },"," \"success\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Flat\":{"," \"type\":\"string\","," \"required\":true"," }"," }"," };"," "," }else if(version === 2){"," schema = {"," \"name\":\"JSON_response\","," \"properties\":{"," \"Standard_Flat\":{"," \"type\":\"string\","," \"required\":true"," },"," \"Standard_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_presort_records\":{"," \"type\": \"string\","," \"required\":true"," },"," \"format\":{"," \"type\":\"string\","," \"required\":true"," },"," "," \"First_Class_Card\":{"," \"type\":\"string\","," \"required\":true"," },"," \"mail_piece_size\":{"," \"type\":\"string\","," \"required\":true"," },"," \"presort_class\":{"," \"type\":\"string\","," \"required\":true"," },"," \"First_Class_Letter\":{"," \"type\":\"string\","," \"required\":true"," },"," \"postage_saved\":{"," \"type\":\"string\","," \"required\":true"," },"," \"total_postage\":{"," \"type\":\"string\","," \"required\":true"," },"," \"drop_zip\":{"," \"type\":\"string\","," \"required\":true"," },"," \"success\":{"," \"type\":\"boolean\","," \"required\":true"," },"," \"First_Class_Flat\":{"," \"type\":\"string\","," \"required\":true"," }"," }"," }; "," }"," "," // tests[\"Expected JSON format response\"] = tv4.validate(result, schema);"," return tv4.validate(result_in, schema);","}","",""],"type":"text/javascript"}}],"id":"0c6933c2-5645-46b3-944f-278e2e7f3e37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{dq_pGUID}}/QUOTE","description":"This call is the same as the first GET Quote call, but shows an example of the response returned after the Upload File call is made with \"dataQualityResults_CASS\" enabled.\n
\nData Quality (DQ) Result Descriptions:
\"dq_message\": \"DQ results have been calculated successfully\" = The DQ Message
\"dq_dpvhsa_y\": \"1906\" = Address was DPV confirmed for both primary and (if present) secondary numbers.
\"dq_dpvhsa_d\": \"11\" = Address was DPV confirmed for the primary number only, and Secondary number information was missing.
\"dq_dpvhsa_s\": \"56\" = Address was DPV confirmed for the primary number only, and secondary number information was present but unconfirmed.
\"dq_dpvhsa_n\": \"27\" = Both Primary and (if present) Secondary number information failed to DPV Confirm.
\"dq_dpvhsv\": \"19\" = Address is Vacant for at least 90-days
Downloads the 25-record preview of the final CSV.
\n","urlObject":{"path":["ws_360_webapps","v2_0/download.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"key":"guid","value":"{{pGUID}}"},{"key":"ftype","value":"prev.csv"}],"variable":[]}},"response":[],"_postman_id":"1da0fe2b-7db1-48c4-b0c9-6ef7ba39be27"},{"name":"Download Production CSV","event":[{"listen":"test","script":{"id":"0e6cdaca-9e8b-40f5-92b5-b97e027966cf","exec":["try{",""," tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;"," "," "," "," var jsonData = responseBody.has(\"{\\\"success\\\"\" + \":\");"," if(responseCode.code === 200 && jsonData){"," var data = JSON.parse(responseBody);"," if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," tests[\"Data format issue. responseBody => \" + responseBody] = false;"," }"," }","","}catch(exception){"," tests[\"Exception => \" + exception.message] = false;"," tests[\"responseBody => \" + responseBody] = false;"," console.log(\"exception => \" + exception.message);"," console.log(\"responseBody => \" + responseBody);","}"],"type":"text/javascript"}}],"id":"4f74fcd7-d7d1-49df-8de3-c2244f6cbc21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{pGUID}}&ftype=csv","description":"Allows you to download the final print-ready CSV separately from the maildat.zip file.
\n","urlObject":{"path":["ws_360_webapps","v2_0/download.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"key":"guid","value":"{{pGUID}}"},{"key":"ftype","value":"csv"}],"variable":[]}},"response":[],"_postman_id":"4f74fcd7-d7d1-49df-8de3-c2244f6cbc21"},{"name":"Download JSON","id":"d9b6e884-ab81-4f1f-b9df-6a8a982f8d8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{pGUID}}&ftype=json","description":"Downloads the same data within the final print-ready CSV file in a JSON format instead.
\n","urlObject":{"path":["ws_360_webapps","v2_0/download.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"key":"guid","value":"{{pGUID}}"},{"key":"ftype","value":"json"}],"variable":[]}},"response":[],"_postman_id":"d9b6e884-ab81-4f1f-b9df-6a8a982f8d8f"},{"name":"Retrieve CASS Certified Records","id":"0daae354-3eb2-41fc-b9ca-a67b91a5e414","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{pGUID}}/CleanAddresses/{{pFilterCASSSubType}}","description":"You can use this call to retrieve any records that had issues with validation during the CASS/DPV process. This can include secondary problems, address range issues, or any other form of validation error.
\n{pFilterCASSSubType} available values:
\n2 = Unit number provided but not verified
\n3 = Unit number missing from known high-rise address
\n4 = Vacant
\n5 = Business address
\n6 = Private Mail Box address
\n7 = Address not valid
\n8 = Missing address element(s)
\n9 = Foreign
\n11_1 = IDA (Internal Drop Address) – Addresses that do not receive mail directly from the USPS but are delivered to a drop address that services them
\n11_2 = CDS NoStat – Addresses that have not yet become deliverable. For example, a new subdivision where lots and primary numbers have been determined, but no structure exists yet for occupancy
\n11_3 = Collision – Addresses that do not actually DPV confirm. In this case, the ‘Y’ should be set to ‘N’ on the DPV ‘A’ table and all other table values should be blank
\n11_4 = CMZ (College, Military and Other Types) – ZIP + 4 records USPS has incorporated into the data
\n11_5 = Regular NoStat – Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries
\n11_6 = Secondary Required – The address requires secondary information
\n99 = All
\nYou can use this web service call to retrieve certain match types from NCOALink for records.
\n{pFilterNCOASubType} available values:
You can use this web service call to get the duplicate records that were identified by the \"Duplicate Detection\" call. To make sure you get the right results, use the same filter you used when making the initial \"Duplicate Detection\" call.
\n{duplicateSubType} available values:
Use this web service call to talk to PostalOne! and handle tasks like uploading, updating, canceling, and deleting Full-Service Mail.dat jobs.\n
\nIt is extremely important that before you make the POSTALONE call, that you call UPDATE QUOTE with the correct Mail.dat values as well as the PostalOne! values below.
{\n \"p1_env\": \"{{environment}}\",\n \"p1_usr\": \"{{username}}\",\n \"p1_psw\": \"{{password}}\",\n \"p1_action\": \"{{action}}\",\n \"mailing_date\": \"{{mailingdate}}\"\n}\n\nThe \"maildat_jobid\" must be unique and a maximum of 8 Alphanumeric characters only. If this JSON value is not provided, the first 8 characters of the Input File name is used.\n
\nNote: See available JSON values by downloading this file or by using the table within the Update Quote documentation above
Before going into the documentation itself, here are some basic explanations for the different types of web service calls within the API.
\nGET:
\nPurpose: Asking for information.
\nExplanation: When you make a GET request, you're asking the server to give you some type of data. It's like when you open a web page in your browser - you're getting information from a server. GET is used for retrieving data, like reading a book without making any changes to it.
\nPOST:
\nPurpose: Submitting information.
\nExplanation: When you make a POST request, you're sending data to the server - similar to filling out a form and submitting it. POST is used when you want to create something new on the server.
\nPUT:
\nPurpose: Updating or replacing existing data.
\nExplanation: When you make a PUT request, you're telling the server to update or replace a resource with new data, like editing an existing document and saving your changes. PUT is used when you want to update information on the server with new data that you provide.
\nIn summary:
\nGET is for getting (retrieving) information.
\nPOST is for posting (creating) new data.
\nPUT is for putting (updating or replacing) existing data.
\nRemember, these are just conventions - a way for both your code and the server to understand what kind of operation you want to perform. It's like telling the server, \"Hey, I'm GETting data from you,\" or \"I'm POSTing some new data to you.\"
\nThis collection is actually implemented within Postman, which is a helpful tool for beginner programmers to test and interact with APIs (like the AccuZIP DQ). It allows you to send requests to web services and receive their responses. You can also create and organize different types of requests (like GET, POST, and PUT mentioned above as well as others not used in this collection) and examine the data sent and received.
\nAs best practice, you will want to introduce slight delays between the API Calls to prevent race conditions and ensure proper sequencing since the service is asynchronus (async), meaning that the next call can be made before the last one has finished.
\nTo ensure reliability and eliminate timing conflicts, the workflow below is recommended:
\nUpload File
\nGET Quote
\n\"success\" = true, pause for 5 seconds to prevent race conditionsUpdate Quote
\nGET Quote to verify that the Update Quote request was accepted
\nProceed with file processing via our processing calls
\nPoll GET Quote every 5-10 seconds until \"task_name\": \"FINISHED\" is present in the quote
Pause for 5 seconds to prevent race conditions
\nDownload File
\nOnce your web page loads, initiate a new request to the AccuZIP EDDM Web Service by making an HTTP POST call.
The callback_url is the web address on your site where the user's browser will go after they finish using the EDDM interface (by clicking Save or Cancel).
Reach out to AccuZIP to obtain your API_KEY, or use the API_KEY you were given for the AccuZIP DirectMail Solution RESTful API.
\nNext, use the \"eddm_url\" that comes back in the Success Response to show the EDDM UI (User Interface) for the user to pick EDDM routes. This value is like a special code (GUID) that identifies your request.
\nTo make this happen, you would want to include the \"eddm_url\" in a kind of window on your webpage called an iframe.
For example:
\n<iframe src=\"https://cloud2.iaccutrace.com/eddm3/?GUID=\" width=\"100%\" height=\"100%\" frameborder=\"0\" border=\"0\" scrolling=\"auto\"></iframe>\n\nYou should make this web service call after the user has finished choosing their delivery routes since it helps let you know when the job is ready to start processing. When the returned quote contains \"success\": true, you will want to pause for at least 5 seconds to prevent race conditions before proceeding to the next call.
\nYou can also look into the \"Estimated_Postage_*\" JSON objects in the response to figure out the expected postage cost the customer will pay to USPS for their EDDM mailing. The other amounts (like \"Standard_Flat\") show how much less you'll spend on postage compared to the First-Class rate for a mail-piece of that size.
\n","urlObject":{"path":["servoy-service","rest_ws","ws_360","v2_0/job","{{eddm_pGUID}}","QUOTE","true"],"host":["https://cloud2.iaccutrace.com"],"query":[],"variable":[]}},"response":[{"id":"fbcef56e-b87d-4c4a-bc11-c4ad3defa714","name":"Get QUOTE","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{eddm_pGUID}}/QUOTE/true"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Dec 2023 22:58:22 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"489"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Standard_Nonprofit_Flat\": \"$5,139\",\n \"Standard_Nonprofit_Letter\": \"$2,197\",\n \"Estimated_Postage_Standard_Nonprofit_Letter\": \"$645\",\n \"format\": \"\",\n \"Estimated_Postage_Standard_Letter\": \"$1,029\",\n \"Total_Residential\": \"4,296\",\n \"drop_zip\": \"\",\n \"Estimated_Postage_Standard_Flat\": \"$1,358\",\n \"total_postage\": \"\",\n \"Standard_Letter\": \"$1,814\",\n \"success\": true,\n \"presort_class\": \"\",\n \"Estimated_Postage_Standard_Nonprofit_Flat\": \"$952\",\n \"mail_piece_size\": \"\",\n \"Total_Possible\": \"4,296\",\n \"Standard_Flat\": \"$4,733\",\n \"postage_saved\": \"\"\n}"}],"_postman_id":"540c8e88-8a4b-43e2-a895-0abbc3e462aa"},{"name":"Update QUOTE","event":[{"listen":"test","script":{"id":"dd16d325-3caa-4694-8242-bbc137837b6a","exec":["","if(responseCode.code === 200){"," tests[\"QUOTE updated properly, response status code is 200\"] = responseCode.code === 200;","}else{"," tests[\"Expected status code 200. Received Status code:\" + responseCode.code] = false; ","}"],"type":"text/javascript"}}],"id":"d32da63d-8244-4bcd-bf40-b78024569b28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"success\": \"true\",\r\n\"presort_class\": \"STANDARD MAIL (EDDM)\",\r\n\"drop_zip\": \"93422\",\r\n\"mail_piece_size\": \"FLAT\",\r\n\"piece_height\": \"9.00\",\r\n\"piece_length\": \"12.00\",\r\n\"thickness_value\": \".105\",\r\n\"thickness_based_on\": \"1\",\r\n\"tray_type\": \"MMM\",\r\n\"calculate_container_volume\": \"1\",\r\n\"min1ft\": \"\",\r\n\"max1ft\": \"\",\r\n\"min2ft\": \"\",\r\n\"max2ft\": \"\",\r\n\"print_barcode\": \"1\",\r\n\"print_imb\": \"1\",\r\n\"machinability\": \"MACHINABLE\",\r\n\"weight_value\": \"1.1\",\r\n\"weight_unit\": \"OUNCES\",\r\n\"weight_based_on\": \"1\",\r\n\"mail_permit_type\": \"PROFIT\",\r\n\"mail_pay_method\": \"IMPRINT\",\r\n\"include_non_zip4\": \"1\",\r\n\"include_crrt\": \"0\",\r\n\"print_reverse\": \"0\",\r\n\"entry_scf\": \"0\",\r\n\"entry_ndc\": \"0\",\r\n\"agent_or_mailer_signing_statement\": \"John Doe\",\r\n\"agent_or_mailer_company\": \"ACCUZIP INC.\",\r\n\"agent_or_mailer_phone\": \"8054617300\",\r\n\"agent_or_mailer_email\": \"me@myemail.com\",\r\n\"mailing_agent_name_address\": \"John Doe|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\",\r\n\"mailing_agent_phone\": \"8054617300\",\r\n\"mailing_agent_mailer_id\": \"999999\",\r\n\"mailing_agent_crid\": \"8888888\",\r\n\"mailing_agent_edoc_sender_crid\": \"8888888\",\r\n\"prepared_for_name_address\": \"John Doe|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\",\r\n\"prepared_for_mailer_id\": \"999999\",\r\n\"prepared_for_crid\": \"8888888\",\r\n\"prepared_for_nonprofit_authorization_number\": \"\",\r\n\"permit_holder_name_address\": \"John Doe|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\",\r\n\"permit_holder_phone\": \"8054617300\",\r\n\"permit_holder_mailer_id\": \"999999\",\r\n\"permit_holder_crid\": \"8888888\",\r\n\"statement_number\": \"1\",\r\n\"mailing_date\": \"12/20/2023\",\r\n\"mail_permit_number\": \"YOUR PERMIT\",\r\n\"net_postage_due_permit_number\": \"\",\r\n\"postage_affixed\": \"\",\r\n\"exact_postage\": \"\",\r\n\"imb_default_mid\": \"999999\",\r\n\"imb_mid\": \"999999\",\r\n\"imb_starting_serial_number\": \"\",\r\n\"imb_service_type\": \"270\",\r\n\"maildat_pdr\": \"0\",\r\n\"maildat_mpu_name\": \"JOB1\",\r\n\"maildat_mpu_description\": \"TEST JOB\",\r\n\"accutrace_job_description\": \"TEST JOB\",\r\n\"accutrace_job_id\": \"123456\",\r\n\"accutrace_job_id2\": \"789\",\r\n\"accutrace_notice_email\": \"me@myemail.com\",\r\n\"accutrace_customer_id\": \"\",\r\n\"accutrace_api_key\": \"\",\r\n\"format\": \"UPPER\",\r\n\"list_owner_paf_id\": \"E00001\",\r\n\"list_owner_information\": \"company|address|city|state|zip+4|telephone|naics|email|name|title|08/01/2023\",\r\n\"total_postage\": \"\",\r\n\"postage_saved\": \"\",\r\n\"First_Class_Card\": \"\",\r\n\"First_Class_Letter\": \"\",\r\n\"First_Class_Flat\": \"\",\r\n\"Standard_Card\": \"\",\r\n\"Standard_Letter\": \"\",\r\n\"Standard_Flat\": \"\"\r\n}"},"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{eddm_pGUID}}/QUOTE","description":"This call would be used to update the quote with your job parameters. A full list of possible values can be downloaded here, or the values can be found in the Update Quote documentation above for the AccuZIP DQ.
\nHowever, the \"presort_class\" JSON value must be \"STANDARD MAIL (EDDM)\" and \"include_crrt\": \"1\" must be present within the quote to allow the pieces to claim the correct carrier route postage rates for an EDDM mailing.
This call will automatically process the list through CASS to validate the addreses, NCOA to find any potential moves, Duplicate Detection to find and remove any duplicates, and finally PRESORT to prepare the job to be processed through the USPS mailing system.\n
\nHowever, since an EDDM mailing does not contain any names or addresses and only contains the carrier route, city, state, and zip code, you should not need to worry about CASS, NCOA, or Duplicate Detection removing any records.
This is the same as the previous GET Quote call. However, you would want to look for \"task_name\": \"FINISHED\" within the response this time to know when the job has finished processing.
\nOnce \"task_name\": \"FINISHED\" is present in the quote, the list should be ready to download.
\n","urlObject":{"path":["servoy-service","rest_ws","ws_360","v2_0/job","{{pGUID}}","QUOTE"],"host":["https://cloud2.iaccutrace.com"],"query":[],"variable":[]}},"response":[{"id":"0964df87-2586-42fc-877f-5bfceb1d0859","name":"QUOTE - Check status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://cloud2.iaccutrace.com/servoy-service/rest_ws/ws_360/v2_0/job/{{eddm_pGUID}}/QUOTE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Dec 2023 15:46:21 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"2430"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"prepared_for_name_address\": \"John Doe|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\",\n \"accutrace_job_id2\": \"789\",\n \"maildat_mpu_description\": \"TEST JOB\",\n \"task_percentage_completed\": \"100\",\n \"First_Class_Card\": \"\",\n \"agent_or_mailer_phone\": \"8054617300\",\n \"permit_holder_crid\": \"8888888\",\n \"First_Class_Letter\": \"\",\n \"Standard_Card\": \"\",\n \"max2ft\": \"\",\n \"total_postage\": \"$850.61\",\n \"print_barcode\": \"1\",\n \"min2ft\": \"\",\n \"total_records\": \"4296\",\n \"mailing_agent_edoc_sender_crid\": \"8888888\",\n \"piece_length\": \"12.00\",\n \"mailing_date\": \"12/20/2023\",\n \"statement_number\": \"1\",\n \"thickness_value\": \".105\",\n \"imb_starting_serial_number\": \"\",\n \"accutrace_notice_email\": \"me@myemail.com\",\n \"format\": \"UPPER\",\n \"machinability\": \"MACHINABLE\",\n \"include_crrt\": \"0\",\n \"permit_holder_mailer_id\": \"999999\",\n \"prepared_for_crid\": \"8888888\",\n \"total_presort_records\": \"4296\",\n \"maildat_mpu_name\": \"JOB1\",\n \"imb_default_mid\": \"999999\",\n \"list_owner_information\": \"company|address|city|state|zip+4|telephone|naics|email|name|title|08/01/2023\",\n \"weight_unit\": \"OUNCES\",\n \"success\": true,\n \"print_reverse\": \"0\",\n \"agent_or_mailer_signing_statement\": \"John Doe\",\n \"entry_scf\": \"0\",\n \"thickness_based_on\": \"1\",\n \"task_name\": \"FINISHED\",\n \"print_imb\": \"1\",\n \"imb_mid\": \"999999\",\n \"accutrace_api_key\": \"\",\n \"mail_permit_type\": \"PROFIT\",\n \"mailing_agent_crid\": \"8888888\",\n \"prepared_for_nonprofit_authorization_number\": \"\",\n \"entry_ndc\": \"0\",\n \"tray_type\": \"MMM\",\n \"max1ft\": \"\",\n \"mail_pay_method\": \"IMPRINT\",\n \"include_non_zip4\": \"1\",\n \"presort_class\": \"STANDARD MAIL (EDDM)\",\n \"min1ft\": \"\",\n \"prepared_for_mailer_id\": \"999999\",\n \"imb_service_type\": \"270\",\n \"exact_postage\": \"\",\n \"mail_piece_size\": \"FLAT\",\n \"accutrace_customer_id\": \"\",\n \"First_Class_Flat\": \"\",\n \"weight_based_on\": \"1\",\n \"mailing_agent_name_address\": \"John Doe|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\",\n \"weight_value\": \"1.1\",\n \"calculate_container_volume\": \"1\",\n \"permit_holder_phone\": \"8054617300\",\n \"task_state\": \"FINISHED\",\n \"permit_holder_name_address\": \"John Doe|AccuZIP Inc.|3216 El Camino Real|Atascadero CA 93422-2500\",\n \"drop_zip\": \"93422\",\n \"piece_height\": \"9.00\",\n \"postage_affixed\": \"\",\n \"task_process\": \"CASS-NCOA-DUPS_01-PRESORT\",\n \"accutrace_job_description\": \"TEST JOB\",\n \"mail_permit_number\": \"YOUR PERMIT\",\n \"accutrace_job_id\": \"123456\",\n \"Standard_Letter\": \"\",\n \"maildat_pdr\": \"0\",\n \"net_postage_due_permit_number\": \"\",\n \"mailing_agent_phone\": \"8054617300\",\n \"agent_or_mailer_company\": \"ACCUZIP INC.\",\n \"mailing_agent_mailer_id\": \"999999\",\n \"agent_or_mailer_email\": \"me@myemail.com\",\n \"list_owner_paf_id\": \"E00001\",\n \"postage_saved\": \"$4,948.99\",\n \"Standard_Flat\": \"\"\n}"}],"_postman_id":"ce0c6763-cb31-4d01-a783-3eb2359035a9"},{"name":"Download Preview CSV","event":[{"listen":"test","script":{"id":"c5a3c667-ceca-416d-8445-4c0eefaf7da7","exec":["try{",""," tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;"," "," "," "," var jsonData = responseBody.has(\"{\\\"success\\\"\" + \":\");"," if(responseCode.code === 200 && jsonData){"," var data = JSON.parse(responseBody);"," if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," tests[\"Data format issue. responseBody => \" + responseBody] = false;"," }"," }","","}catch(exception){"," tests[\"Exception => \" + exception.message] = false;"," tests[\"responseBody => \" + responseBody] = false;"," console.log(\"exception => \" + exception.message);"," console.log(\"responseBody => \" + responseBody);","}"],"type":"text/javascript"}}],"id":"c8d1ae8d-a484-4aa9-a01d-405ff0dee2b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{eddm_pGUID}}&ftype=prev.csv","description":"This request lets you download all the finished files for a particular job GUID by choosing the file type (ftype) you want. This specific call allows you to download the 25 record preview of the print-ready CSV file.\n
\nHowever, there are different \"ftype\" values you can use within the call that are shown below:
This call is the same as the previous download call, but it will download the print-ready CSV file for the mailing.
\nHowever, you will want to make the download call for the maildat.zip file if you want the documentation and mail.dat files as well as the full print ready CSV.
\n","urlObject":{"path":["ws_360_webapps","v2_0/download.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"key":"guid","value":"{{eddm_pGUID}}"},{"key":"ftype","value":"csv"}],"variable":[]}},"response":[{"id":"4927ef51-905a-4f2c-9096-c3f2d4055201","name":"Download Production CSV","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{eddm_pGUID}}&ftype=csv","host":["https://cloud2.iaccutrace.com"],"path":["ws_360_webapps","v2_0/download.jsp"],"query":[{"key":"guid","value":"{{eddm_pGUID}}"},{"key":"ftype","value":"csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Date","value":"Wed, 20 Dec 2023 16:36:12 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Content-Disposition","value":"attachment;filename=\"23121461-DAEB-4A70-87DC-814D6BA6D4CD_eddm@.csv\""},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Set-Cookie","value":"JSESSIONID=9F69B1DCC6E0AD44CB4D2E45B03BD828; Path=/ws_360_webapps"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Wed, 11 Jan 1984 05:00:00 GMT"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"56e1da69-6373-4298-acb4-813e605bdf26"},{"name":"Download Completed - Documentation, Mail.dat, Print Ready CSV","event":[{"listen":"test","script":{"id":"d3c171c7-ee5c-437a-b6ac-09247ee0fc92","exec":["try{",""," tests[\"Expected status code:200. Received status code:\" + responseCode.code] = responseCode.code === 200;"," "," "," "," var jsonData = responseBody.has(\"{\\\"success\\\"\" + \":\");"," if(responseCode.code === 200 && jsonData){"," var data = JSON.parse(responseBody);"," if(!data.success && data.message){"," var now = new Date();"," var dateStr = (now.getMonth() + 1) + \"-\" + now.getDate() + \"-\" + now.getFullYear() + \" \" + now.getHours() + \":\" + now.getMinutes() + \":\" + now.getSeconds() ;"," tests[\"Error Message:\" + dateStr + \" => \" + data.message] = false;"," }else{"," tests[\"Data format issue. responseBody => \" + responseBody] = false;"," }"," }","","}catch(exception){"," tests[\"Exception => \" + exception.message] = false;"," tests[\"responseBody => \" + responseBody] = false;"," console.log(\"exception => \" + exception.message);"," console.log(\"responseBody => \" + responseBody);","}"],"type":"text/javascript"}}],"id":"08db97dc-d7f8-4572-b4bc-52767bc8574e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{eddm_pGUID}}&ftype=maildat.zip","description":"This request is the similar to the other two download calls, but it allows you to download the maildat.zip file that contains the print-ready CSV file, eDocumentation, eTags, and the mail.dat files
\n","urlObject":{"path":["ws_360_webapps","v2_0/download.jsp"],"host":["https://cloud2.iaccutrace.com"],"query":[{"key":"guid","value":"{{eddm_pGUID}}"},{"key":"ftype","value":"maildat.zip"}],"variable":[]}},"response":[{"id":"b851ea38-6f8a-41b3-964f-bdfa413bc94e","name":"Download Completed - Documentation, Mail.dat, Print Ready CSV","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://cloud2.iaccutrace.com/ws_360_webapps/v2_0/download.jsp?guid={{eddm_pGUID}}&ftype=maildat.zip","host":["https://cloud2.iaccutrace.com"],"path":["ws_360_webapps","v2_0/download.jsp"],"query":[{"key":"guid","value":"{{eddm_pGUID}}"},{"key":"ftype","value":"maildat.zip"}]}},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Date","value":"Wed, 20 Dec 2023 16:36:46 GMT"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Content-Disposition","value":"attachment;filename=\"23121461-DAEB-4A70-87DC-814D6BA6D4CD_eddm@.maildat.zip\""},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Set-Cookie","value":"JSESSIONID=1F173A989C7B0397C8499B2DC6E7EDE5; Path=/ws_360_webapps"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Wed, 11 Jan 1984 05:00:00 GMT"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"08db97dc-d7f8-4572-b4bc-52767bc8574e"}],"id":"549c6f8f-8165-4538-a515-5a84440d7a4a","description":"The AccuZIP EDDM Web Service lets you connect to it in two ways: through a RESTful integration, which is a way to communicate with it using code, and through a user interface where you can choose delivery routes on a map. To use this service, you need a special code called an API Key. If you're already using the AccuZIP Direct Mail RESTful API, you can use the same API Key for both services. This also allows you add any company branding information to the EDDM UI route selection.\n
\nIn the examples below, we will assume your website is running at http://mysite.com and that a file, eddm.html, has been created on your web service with the ability to run JavaScript. The specific names and programming languages can vary, but we will use those names for the rest of this documentation example.
Use this web service call to confirm a single US, US Territory, or Canadian Mailing Addresses
\nPlease keep in mind that the values entered should not include escape characters or double byte/unicode characters
\nPossible values for the body of the CASS API Validation call:
\nCASS RESTful API Response JSON Object Descriptions:
\n","urlObject":{"path":["servoy-service","rest_ws","ws_address","ws_validate"],"host":["https://api.cassonline.com"],"query":[],"variable":[]}},"response":[{"id":"5ddbfef5-f73e-4f15-a548-df3c1dae4488","name":"CASS Certify Single Address","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"API_KEY\": \"{{cass_api_key}}\",\r\n\t\"Address\": [{\r\n\t\t\"AZSetQuery_iadl2\": \"AccuZIP Inc.\",\r\n\t\t\"AZSetQuery_iadl1\": \"2450 S Shore Blvd, Ste 125\",\r\n\t\t\"AZSetQuery_iadl3\": \"\",\r\n\t\t\"AZSetQuery_ictyi\": \"League City\",\r\n\t\t\"AZSetQuery_istai\": \"TX\",\r\n\t\t\"AZSetQuery_izipc\": \"\",\r\n\t\t\"AZSetQuery_icountry\": \"US\",\r\n\t\t\"AZSetQuery_iforeignid\": \"534d93d8-1cbe-437d-81db-ff1abee29aa4\"\r\n\t}]\r\n}"},"url":"https://api.cassonline.com/servoy-service/rest_ws/ws_address/ws_validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"2060"},{"key":"Date","value":"Wed, 03 Jan 2024 20:11:00 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"license\": {\n \"Annual_Credits_Remaining\": \"199300185\"\n },\n \"success\": true,\n \"Addr_Result\": [\n {\n \"00\": \"\",\n \"dctys\": \"LEAGUE CITY\",\n \"ppre1\": \"S\",\n \"01\": \"\",\n \"ppre2\": \"\",\n \"02\": \"\",\n \"03\": \"\",\n \"sec_low\": \"00000125\",\n \"04\": \"\",\n \"pmb\": \"\",\n \"05\": \"\",\n \"DPVfoot_AA\": \"1\",\n \"DPVfoot_R1\": \"0\",\n \"DPVfoot_R7\": \"0\",\n \"pre_dir\": \"S\",\n \"dstaa\": \"TX\",\n \"msnum\": \"125\",\n \"DPVA\": \"Y\",\n \"DPVC\": \"N\",\n \"state\": \"48\",\n \"DPVF\": \"Y\",\n \"DPVfoot_BB\": \"1\",\n \"DPVfoot_RR\": \"0\",\n \"pmbnum\": \"\",\n \"dctya\": \"\",\n \"mpnum\": \"2450\",\n \"addon_high\": \"2996\",\n \"dprurb\": \"\",\n \"stelnkInd\": \"\",\n \"LlkRc\": \"\",\n \"irecid\": \"1\",\n \"A\": \"\",\n \"B\": \"\",\n \"C\": \"\",\n \"D\": \"D\",\n \"ppnam\": \"SHORE\",\n \"E\": \"E\",\n \"DPVfoot_CC\": \"0\",\n \"F\": \"\",\n \"G\": \"\",\n \"H\": \"\",\n \"psnum2\": \"\",\n \"dlast\": \"LEAGUE CITY TX 77573-2996\",\n \"I\": \"\",\n \"J\": \"\",\n \"K\": \"\",\n \"izipc\": \"\",\n \"L\": \"\",\n \"M\": \"\",\n \"post_dir\": \"\",\n \"N\": \"N\",\n \"sec_code\": \"B\",\n \"O\": \"\",\n \"P\": \"\",\n \"foreignid\": \"534d93d8-1cbe-437d-81db-ff1abee29aa4\",\n \"Q\": \"\",\n \"R\": \"\",\n \"S\": \"\",\n \"T\": \"\",\n \"U\": \"\",\n \"V\": \"V\",\n \"W\": \"\",\n \"X\": \"\",\n \"Y\": \"\",\n \"Z\": \"\",\n \"zipc\": \"77573\",\n \"DPVfoot_U1\": \"0\",\n \"elot_num\": \"0033\",\n \"iadl1\": \"2450 S Shore Blvd, Ste 125\",\n \"iadl3\": \"\",\n \"iadl2\": \"AccuZIP Inc.\",\n \"DPVfoot_M1\": \"0\",\n \"DPVV\": \"N\",\n \"DPVfoot_M3\": \"0\",\n \"DPVX\": \"B\",\n \"DPVfoot_DN\": \"0\",\n \"county_no\": \"167\",\n \"rdi\": \"N\",\n \"punit2\": \"\",\n \"icountry\": \"US\",\n \"prote\": \"C020\",\n \"sec_high\": \"00000220\",\n \"municipality\": \"\",\n \"DPVfoot_N1\": \"0\",\n \"suffix\": \"BLVD\",\n \"Footnotes\": \"D#E#N#V#\",\n \"DPVfoot_F1\": \"0\",\n \"punit\": \"STE\",\n \"lacs\": \"\",\n \"DPVfoot_ND\": \"0\",\n \"dadl3\": \"\",\n \"dadl1\": \"2450 S SHORE BLVD STE 125\",\n \"addon_low\": \"2996\",\n \"dadl2\": \"ACCUZIP INC\",\n \"str_name\": \"SHORE\",\n \"DPVfoot_NS\": \"0\",\n \"elot_code\": \"A\",\n \"ppst1\": \"\",\n \"ppst2\": \"\",\n \"DPVfoot_G1\": \"0\",\n \"unit\": \"STE\",\n \"retcc\": \"31\",\n \"psuf1\": \"BLVD\",\n \"psuf2\": \"\",\n \"DPVfoot_X2\": \"0\",\n \"DPVfoot_X1\": \"0\",\n \"DPVfoot_X4\": \"0\",\n \"psnum\": \"125\",\n \"DPVfoot_X3\": \"0\",\n \"DPVfoot_X6\": \"0\",\n \"addon\": \"2996\",\n \"DPVfoot_X5\": \"0\",\n \"LlkInd\": \"\",\n \"DPVfoot_X7\": \"0\",\n \"DPVfoot_P1\": \"0\",\n \"DPVfoot_P3\": \"0\",\n \"istai\": \"TX\",\n \"iprurb\": \"\",\n \"postalcode\": \"\",\n \"ppnum\": \"2450\",\n \"DPVfoot_PB\": \"0\",\n \"ictyi\": \"League City\",\n \"misc\": \"\",\n \"dpbc\": \"258\",\n \"sec_name\": \"\",\n \"abcty\": \"\",\n \"DPVfoot_PO\": \"0\",\n \"DPVfoot_02\": \"0\",\n \"respn\": \"3\",\n \"DPVfoot_01\": \"0\",\n \"DPVfoot_04\": \"0\",\n \"congress_dist\": \"14\",\n \"DPVfoot_03\": \"0\",\n \"county_name\": \"GALVESTON\",\n \"DPVfoot_05\": \"0\",\n \"rec_type\": \"H\",\n \"DPVfoot_A1\": \"0\",\n \"cris\": \"C020\",\n \"finance\": \"485030\"\n }\n ]\n}"}],"_postman_id":"723c6a41-ef00-4203-ac29-c5072563682b"},{"name":"CASS Certify Multiple Addresses","id":"c44168cc-3ba0-4985-8f77-68a2722ca40b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"API_KEY\": \"{{cass_api_key}}\",\r\n\t\"Address\": [{\r\n\t\t\t\"AZSetQuery_iadl2\": \"AccuZIP Inc.\",\r\n\t\t\t\"AZSetQuery_iadl1\": \"2450 S Shore Blvd, Ste 125\",\r\n\t\t\t\"AZSetQuery_iadl3\": \"\",\r\n\t\t\t\"AZSetQuery_ictyi\": \"League City\",\r\n\t\t\t\"AZSetQuery_istai\": \"TX\",\r\n\t\t\t\"AZSetQuery_izipc\": \"\",\r\n\t\t\t\"AZSetQuery_icountry\": \"US\",\r\n\t\t\t\"AZSetQuery_iforeignid\": \"534d93d8-1cbe-437d-81db-ff1abee29aa4\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"AZSetQuery_iadl2\": \"ACCUZIP\",\r\n\t\t\t\"AZSetQuery_iadl1\": \"3216 El Camino Real\",\r\n\t\t\t\"AZSetQuery_iadl3\": \"\",\r\n\t\t\t\"AZSetQuery_ictyi\": \"\",\r\n\t\t\t\"AZSetQuery_istai\": \"\",\r\n\t\t\t\"AZSetQuery_izipc\": \"93422\",\r\n\t\t\t\"AZSetQuery_icountry\": \"US\",\r\n\t\t\t\"AZSetQuery_iforeignid\": \"6d4a6b0f-3ce5-4d07-abe0-5099f1626e7c\"\r\n\t\t}\r\n\t]\r\n}"},"url":"https://api.cassonline.com/servoy-service/rest_ws/ws_address/ws_validate","description":"Use this web service to check up to 20 mailing addresses in the United States, U.S. territories, or Canada simultaneously.
\nMake sure to format each set of address data within curly brackets {} and separate them with commas, similar to the example on the right. Also, please ensure that the JSON values for each address match those used in the single address validation call.
\nIn the response of this call, the results will be displayed in a format similar to how the addresses were entered, enclosed in curly brackets {} and separated by commas. Please refer to the response table in the single address validation call above for the definitions of the response values.
\n","urlObject":{"path":["servoy-service","rest_ws","ws_address","ws_validate"],"host":["https://api.cassonline.com"],"query":[],"variable":[]}},"response":[{"id":"7ec0b1b4-bc03-4605-82d0-42b1800f320a","name":"CASS Certify Multiple Addresses","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"API_KEY\": \"{{cass_api_key}}\",\r\n\t\"Address\": [{\r\n\t\t\t\"AZSetQuery_iadl2\": \"AccuZIP Inc.\",\r\n\t\t\t\"AZSetQuery_iadl1\": \"2450 S Shore Blvd, Ste 125\",\r\n\t\t\t\"AZSetQuery_iadl3\": \"\",\r\n\t\t\t\"AZSetQuery_ictyi\": \"League City\",\r\n\t\t\t\"AZSetQuery_istai\": \"TX\",\r\n\t\t\t\"AZSetQuery_izipc\": \"\",\r\n\t\t\t\"AZSetQuery_icountry\": \"US\",\r\n\t\t\t\"AZSetQuery_iforeignid\": \"534d93d8-1cbe-437d-81db-ff1abee29aa4\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"AZSetQuery_iadl2\": \"ACCUZIP\",\r\n\t\t\t\"AZSetQuery_iadl1\": \"3216 El Camino Real\",\r\n\t\t\t\"AZSetQuery_iadl3\": \"\",\r\n\t\t\t\"AZSetQuery_ictyi\": \"\",\r\n\t\t\t\"AZSetQuery_istai\": \"\",\r\n\t\t\t\"AZSetQuery_izipc\": \"93422\",\r\n\t\t\t\"AZSetQuery_icountry\": \"US\",\r\n\t\t\t\"AZSetQuery_iforeignid\": \"6d4a6b0f-3ce5-4d07-abe0-5099f1626e7c\"\r\n\t\t}\r\n\t]\r\n}"},"url":"https://api.cassonline.com/servoy-service/rest_ws/ws_address/ws_validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"3984"},{"key":"Date","value":"Wed, 03 Jan 2024 20:12:03 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"license\": {\n \"Annual_Credits_Remaining\": \"199300183\"\n },\n \"success\": true,\n \"Addr_Result\": [\n {\n \"00\": \"\",\n \"dctys\": \"LEAGUE CITY\",\n \"ppre1\": \"S\",\n \"01\": \"\",\n \"ppre2\": \"\",\n \"02\": \"\",\n \"03\": \"\",\n \"sec_low\": \"00000125\",\n \"04\": \"\",\n \"pmb\": \"\",\n \"05\": \"\",\n \"DPVfoot_AA\": \"1\",\n \"DPVfoot_R1\": \"0\",\n \"DPVfoot_R7\": \"0\",\n \"pre_dir\": \"S\",\n \"dstaa\": \"TX\",\n \"msnum\": \"125\",\n \"DPVA\": \"Y\",\n \"DPVC\": \"N\",\n \"state\": \"48\",\n \"DPVF\": \"Y\",\n \"DPVfoot_BB\": \"1\",\n \"DPVfoot_RR\": \"0\",\n \"pmbnum\": \"\",\n \"dctya\": \"\",\n \"mpnum\": \"2450\",\n \"addon_high\": \"2996\",\n \"dprurb\": \"\",\n \"stelnkInd\": \"\",\n \"LlkRc\": \"\",\n \"irecid\": \"1\",\n \"A\": \"\",\n \"B\": \"\",\n \"C\": \"\",\n \"D\": \"D\",\n \"ppnam\": \"SHORE\",\n \"E\": \"E\",\n \"DPVfoot_CC\": \"0\",\n \"F\": \"\",\n \"G\": \"\",\n \"H\": \"\",\n \"psnum2\": \"\",\n \"dlast\": \"LEAGUE CITY TX 77573-2996\",\n \"I\": \"\",\n \"J\": \"\",\n \"K\": \"\",\n \"izipc\": \"\",\n \"L\": \"\",\n \"M\": \"\",\n \"post_dir\": \"\",\n \"N\": \"N\",\n \"sec_code\": \"B\",\n \"O\": \"\",\n \"P\": \"\",\n \"foreignid\": \"534d93d8-1cbe-437d-81db-ff1abee29aa4\",\n \"Q\": \"\",\n \"R\": \"\",\n \"S\": \"\",\n \"T\": \"\",\n \"U\": \"\",\n \"V\": \"V\",\n \"W\": \"\",\n \"X\": \"\",\n \"Y\": \"\",\n \"Z\": \"\",\n \"zipc\": \"77573\",\n \"DPVfoot_U1\": \"0\",\n \"elot_num\": \"0033\",\n \"iadl1\": \"2450 S Shore Blvd, Ste 125\",\n \"iadl3\": \"\",\n \"iadl2\": \"AccuZIP Inc.\",\n \"DPVfoot_M1\": \"0\",\n \"DPVV\": \"N\",\n \"DPVfoot_M3\": \"0\",\n \"DPVX\": \"B\",\n \"DPVfoot_DN\": \"0\",\n \"county_no\": \"167\",\n \"rdi\": \"N\",\n \"punit2\": \"\",\n \"icountry\": \"US\",\n \"prote\": \"C020\",\n \"sec_high\": \"00000220\",\n \"municipality\": \"\",\n \"DPVfoot_N1\": \"0\",\n \"suffix\": \"BLVD\",\n \"Footnotes\": \"D#E#N#V#\",\n \"DPVfoot_F1\": \"0\",\n \"punit\": \"STE\",\n \"lacs\": \"\",\n \"DPVfoot_ND\": \"0\",\n \"dadl3\": \"\",\n \"dadl1\": \"2450 S SHORE BLVD STE 125\",\n \"addon_low\": \"2996\",\n \"dadl2\": \"ACCUZIP INC\",\n \"str_name\": \"SHORE\",\n \"DPVfoot_NS\": \"0\",\n \"elot_code\": \"A\",\n \"ppst1\": \"\",\n \"ppst2\": \"\",\n \"DPVfoot_G1\": \"0\",\n \"unit\": \"STE\",\n \"retcc\": \"31\",\n \"psuf1\": \"BLVD\",\n \"psuf2\": \"\",\n \"DPVfoot_X2\": \"0\",\n \"DPVfoot_X1\": \"0\",\n \"DPVfoot_X4\": \"0\",\n \"psnum\": \"125\",\n \"DPVfoot_X3\": \"0\",\n \"DPVfoot_X6\": \"0\",\n \"addon\": \"2996\",\n \"DPVfoot_X5\": \"0\",\n \"LlkInd\": \"\",\n \"DPVfoot_X7\": \"0\",\n \"DPVfoot_P1\": \"0\",\n \"DPVfoot_P3\": \"0\",\n \"istai\": \"TX\",\n \"iprurb\": \"\",\n \"postalcode\": \"\",\n \"ppnum\": \"2450\",\n \"DPVfoot_PB\": \"0\",\n \"ictyi\": \"League City\",\n \"misc\": \"\",\n \"dpbc\": \"258\",\n \"sec_name\": \"\",\n \"abcty\": \"\",\n \"DPVfoot_PO\": \"0\",\n \"DPVfoot_02\": \"0\",\n \"respn\": \"3\",\n \"DPVfoot_01\": \"0\",\n \"DPVfoot_04\": \"0\",\n \"congress_dist\": \"14\",\n \"DPVfoot_03\": \"0\",\n \"county_name\": \"GALVESTON\",\n \"DPVfoot_05\": \"0\",\n \"rec_type\": \"H\",\n \"DPVfoot_A1\": \"0\",\n \"cris\": \"C020\",\n \"finance\": \"485030\"\n },\n {\n \"00\": \"\",\n \"dctys\": \"ATASCADERO\",\n \"ppre1\": \"\",\n \"01\": \"\",\n \"ppre2\": \"\",\n \"02\": \"\",\n \"03\": \"\",\n \"sec_low\": \"\",\n \"04\": \"\",\n \"pmb\": \"\",\n \"05\": \"\",\n \"DPVfoot_AA\": \"1\",\n \"DPVfoot_R1\": \"1\",\n \"DPVfoot_R7\": \"0\",\n \"pre_dir\": \"\",\n \"dstaa\": \"CA\",\n \"msnum\": \"\",\n \"DPVA\": \"Y\",\n \"DPVC\": \"Y\",\n \"state\": \"06\",\n \"DPVF\": \"Y\",\n \"DPVfoot_BB\": \"1\",\n \"DPVfoot_RR\": \"0\",\n \"pmbnum\": \"\",\n \"dctya\": \"\",\n \"mpnum\": \"3216\",\n \"addon_high\": \"2500\",\n \"dprurb\": \"\",\n \"stelnkInd\": \"\",\n \"LlkRc\": \"\",\n \"irecid\": \"1\",\n \"A\": \"\",\n \"B\": \"\",\n \"C\": \"\",\n \"D\": \"\",\n \"ppnam\": \"EL CAMINO REAL\",\n \"E\": \"\",\n \"DPVfoot_CC\": \"0\",\n \"F\": \"\",\n \"G\": \"\",\n \"H\": \"\",\n \"psnum2\": \"\",\n \"dlast\": \"ATASCADERO CA 93422-2500\",\n \"I\": \"\",\n \"J\": \"\",\n \"K\": \"\",\n \"izipc\": \"93422\",\n \"L\": \"\",\n \"M\": \"\",\n \"post_dir\": \"\",\n \"N\": \"N\",\n \"sec_code\": \"\",\n \"O\": \"\",\n \"P\": \"\",\n \"foreignid\": \"6d4a6b0f-3ce5-4d07-abe0-5099f1626e7c\",\n \"Q\": \"\",\n \"R\": \"\",\n \"S\": \"\",\n \"T\": \"\",\n \"U\": \"\",\n \"V\": \"V\",\n \"W\": \"\",\n \"X\": \"\",\n \"Y\": \"\",\n \"Z\": \"\",\n \"zipc\": \"93422\",\n \"DPVfoot_U1\": \"0\",\n \"elot_num\": \"0195\",\n \"iadl1\": \"3216 El Camino Real\",\n \"iadl3\": \"\",\n \"iadl2\": \"ACCUZIP\",\n \"DPVfoot_M1\": \"0\",\n \"DPVV\": \"N\",\n \"DPVfoot_M3\": \"0\",\n \"DPVX\": \"B\",\n \"DPVfoot_DN\": \"0\",\n \"county_no\": \"079\",\n \"rdi\": \"N\",\n \"punit2\": \"\",\n \"icountry\": \"US\",\n \"prote\": \"C008\",\n \"sec_high\": \"\",\n \"municipality\": \"\",\n \"DPVfoot_N1\": \"0\",\n \"suffix\": \"\",\n \"Footnotes\": \"N#V#\",\n \"DPVfoot_F1\": \"0\",\n \"punit\": \"\",\n \"lacs\": \"\",\n \"DPVfoot_ND\": \"0\",\n \"dadl3\": \"\",\n \"dadl1\": \"3216 EL CAMINO REAL\",\n \"addon_low\": \"2500\",\n \"dadl2\": \"ACCUZIP\",\n \"str_name\": \"EL CAMINO REAL\",\n \"DPVfoot_NS\": \"0\",\n \"elot_code\": \"A\",\n \"ppst1\": \"\",\n \"ppst2\": \"\",\n \"DPVfoot_G1\": \"0\",\n \"unit\": \"\",\n \"retcc\": \"31\",\n \"psuf1\": \"\",\n \"psuf2\": \"\",\n \"DPVfoot_X2\": \"0\",\n \"DPVfoot_X1\": \"0\",\n \"DPVfoot_X4\": \"0\",\n \"psnum\": \"\",\n \"DPVfoot_X3\": \"0\",\n \"DPVfoot_X6\": \"0\",\n \"addon\": \"2500\",\n \"DPVfoot_X5\": \"0\",\n \"LlkInd\": \"\",\n \"DPVfoot_X7\": \"0\",\n \"DPVfoot_P1\": \"0\",\n \"DPVfoot_P3\": \"0\",\n \"istai\": \"\",\n \"iprurb\": \"\",\n \"postalcode\": \"\",\n \"ppnum\": \"3216\",\n \"DPVfoot_PB\": \"0\",\n \"ictyi\": \"\",\n \"misc\": \"\",\n \"dpbc\": \"166\",\n \"sec_name\": \"\",\n \"abcty\": \"\",\n \"DPVfoot_PO\": \"0\",\n \"DPVfoot_02\": \"0\",\n \"respn\": \"1\",\n \"DPVfoot_01\": \"0\",\n \"DPVfoot_04\": \"0\",\n \"congress_dist\": \"19\",\n \"DPVfoot_03\": \"0\",\n \"county_name\": \"SAN LUIS OBISPO\",\n \"DPVfoot_05\": \"0\",\n \"rec_type\": \"S\",\n \"DPVfoot_A1\": \"0\",\n \"cris\": \"C008\",\n \"finance\": \"050378\"\n }\n ]\n}"}],"_postman_id":"c44168cc-3ba0-4985-8f77-68a2722ca40b"},{"name":"Typeahead - Get Geolocation","id":"011f7a45-1b22-45d7-9a8e-99efb455f530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cassonline.com/rest_ws/location/?API_KEY={{cass_api_key}}","description":"This call retrieves the latitude and longitude of the current client by using the IP address.
\n","urlObject":{"path":["rest_ws","location",""],"host":["https://api.cassonline.com"],"query":[{"description":{"content":"Your AccuZIP API Key
\n","type":"text/plain"},"key":"API_KEY","value":"{{cass_api_key}}"}],"variable":[]}},"response":[{"id":"db75c797-b48d-4f1e-86df-d1f6fd7ca6fb","name":"Typeahead - Get Geolocation","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.cassonline.com/rest_ws/location/?API_KEY={{cass_api_key}}","host":["https://api.cassonline.com"],"path":["rest_ws","location",""],"query":[{"key":"API_KEY","value":"{{cass_api_key}}","description":"Your AccuZIP API Key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Alt-Svc","value":"clear","name":"Alt-Svc","description":"Custom header"},{"key":"Content-Length","value":"78","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 19 Jul 2018 20:36:24 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Apache-Coyote/1.1","name":"Server","description":"A name for the server"},{"key":"Set-Cookie","value":"JSESSIONID=A3D0F8D69537D06B7E7E033EA2A93993; Path=/; Secure","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Via","value":"1.1 google","name":"Via","description":"Informs the client of proxies through which the response was sent."}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"api.cassonline.com","path":"/","secure":false,"value":"CKfF38-xgdWhAg","key":"GCLB"},{"expires":"Invalid Date","httpOnly":false,"domain":"api.cassonline.com","path":"/","secure":true,"value":"A3D0F8D69537D06B7E7E033EA2A93993","key":"JSESSIONID"}],"responseTime":null,"body":"{\"longitude\":-84.45689,\"latitude\":39.162,\"success\":true,\"ip\":\"174.98.170.192\"}"}],"_postman_id":"011f7a45-1b22-45d7-9a8e-99efb455f530"},{"name":"Typeahead - Get Results","id":"a59d6558-84b5-493a-99e5-ac37b2a8d3d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cassonline.com/servoy-service/rest_ws/ws_address/ws_autocomplete/:API_KEY/:ADDRESS/:COUNTRIES/:LATITUDE/:LONGITUDE","description":"This call returns up to 5 address matches containing the partial or entire address on one line.
\nAll Path variables should be URL encoded, but that may not be done automatically depending on the language and library you are using.
\nNote: The postal/zip code is not returned from the type-ahead call, but you can use the CASS Certify call to get that information.
\n","urlObject":{"path":["servoy-service","rest_ws","ws_address","ws_autocomplete",":API_KEY",":ADDRESS",":COUNTRIES",":LATITUDE",":LONGITUDE"],"host":["https://api.cassonline.com"],"query":[],"variable":[{"type":"any","value":"{{cass_api_key}}","key":"API_KEY"},{"type":"any","value":"2450 South Shore Blvd","key":"ADDRESS"},{"type":"any","value":"us|pr|vi|gu|ca","key":"COUNTRIES"},{"type":"any","value":"39.4842","key":"LATITUDE"},{"type":"any","value":"-84.489","key":"LONGITUDE"}]}},"response":[{"id":"ab042363-85e6-40f8-bf30-adf923094ca9","name":"Typeahead - Get Results","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cassonline.com/servoy-service/rest_ws/ws_address/ws_autocomplete/:API_KEY/:ADDRESS/:COUNTRIES/:LATITUDE/:LONGITUDE","host":["https://api.cassonline.com"],"path":["servoy-service","rest_ws","ws_address","ws_autocomplete",":API_KEY",":ADDRESS",":COUNTRIES",":LATITUDE",":LONGITUDE"],"variable":[{"key":"API_KEY","value":"{{cass_api_key}}"},{"key":"ADDRESS","value":"2450 South Shore Blvd"},{"key":"COUNTRIES","value":"us|pr|vi|gu|ca"},{"key":"LATITUDE","value":"39.4842"},{"key":"LONGITUDE","value":"-84.489"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"1728000"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, proxy-revalidate"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Content-Length","value":"922"},{"key":"Date","value":"Wed, 03 Jan 2024 19:31:57 GMT"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"country\": \"USA\",\n \"city\": \"League City\",\n \"address_secondary\": \"League City, TX\",\n \"address_main\": \"2450 South Shore Blvd\",\n \"state\": \"TX\",\n \"value\": \"2450 South Shore Blvd, League City, TX, USA\"\n },\n {\n \"country\": \"USA\",\n \"city\": \"White Bear Township\",\n \"address_secondary\": \"White Bear Township, MN\",\n \"address_main\": \"2450 S Shore Blvd\",\n \"state\": \"MN\",\n \"value\": \"2450 S Shore Blvd, White Bear Township, MN, USA\"\n },\n {\n \"country\": \"USA\",\n \"city\": \"Lake Oswego\",\n \"address_secondary\": \"Lake Oswego, OR\",\n \"address_main\": \"2450 South Shore Blvd\",\n \"state\": \"OR\",\n \"value\": \"2450 South Shore Blvd, Lake Oswego, OR, USA\"\n },\n {\n \"country\": \"USA\",\n \"city\": \"Wellington\",\n \"address_secondary\": \"Wellington, FL\",\n \"address_main\": \"2450 S Shore Blvd\",\n \"state\": \"FL\",\n \"value\": \"2450 S Shore Blvd, Wellington, FL, USA\"\n },\n {\n \"country\": \"USA\",\n \"city\": \"Oregon\",\n \"address_secondary\": \"Oregon, OH\",\n \"address_main\": \"2450 S Shore Blvd\",\n \"state\": \"OH\",\n \"value\": \"2450 S Shore Blvd, Oregon, OH, USA\"\n }\n ],\n \"success\": true\n}"}],"_postman_id":"a59d6558-84b5-493a-99e5-ac37b2a8d3d8"}],"id":"a5eed8ce-affc-46e8-812b-1b23cee0284c","description":"This collection will contain the documentation for our CASS RESTful API.
\nAlso, below are instructions on how to set up a AccuZIP CASS RESTful API test using the Postman REST Client:
\nSearch the store for: postman rest client
\nClick POSTMAN icon
\nTo add POSTMAN to your browser, click + FREE then click Add
\nBrowse to: chrome://apps/ and click Postman – REST Client
\nIn the URL enter: http://accuzip2.servoybox.com/servoy-service/rest_ws/ws_address/ws_validate
\nIn the drop-down for action, choose POST.
\nClick the Headers button. Enter Content-Type in the Header, and application/json in the Value.
\nClick the raw tab/button below the headers. In the type drop-down next to it, choose JSON
\nIn the large text box below, enter your JSON request, such as:{ API_KEY: \"06bf340a-556f-4ca1-a6c5-cf4863f21924\", Address : { AZSetQuery_iadl1: \"123 Main St\", AZSetQuery_ictyi: \"Trenton\", AZSetQuery_istai: \"OH\", AZSetQuery_izipc: \"45014\" } }
Note: You will need a valid API_KEY before you can begin testing. Please contact AccuZIP Inc. at 800-233-0555 for a valid API_KEY.
Finally, click the Send button at the bottom. Postman will run and show you the results at the bottom.
POST Multiple Address Example:{ API_KEY: \"06bf340a-556f-4ca1-a6c5-cf4863f21924\", Address : [ { AZSetQuery_iadl1: \"123 Main St\", AZSetQuery_ictyi: \"Trenton\", AZSetQuery_istai: \"OH\", AZSetQuery_izipc: \"45014\" }, { AZSetQuery_iadl1: \"3216 El Kamino Real\", AZSetQuery_ictyi: \"Atascadero\", AZSetQuery_istai: \"CA\", AZSetQuery_izipc: \" \" } ] }
When you make this call, it will start the batch process for NCOA (National Change of Address). If started successfully, you'll get a response with a 200 OK status, a JSON object that says \"success\": true, and a token for the batch.
\nTo start the batch process, you need to include the following pieces of information:
1. \"apiKey\": This is your API Key. You can either write your API Key directly here or use a variable that holds your API Key.
2. \"paf_id\": This is the PAF ID (Processing Acknowledgement Form ID). If you are processing records on behalf of someone else, use their PAF ID. Otherwise, use your own PAF ID.
3. \"propercase\": This is a setting for how you want the returned addresses to be formatted. Set this to true if you want the addresses to be properly capitalized (like \"123 Main St\"). Set it to false if you want the addresses to be in all capital letters (like \"123 MAIN ST\").
\nWhen this call works, the response will include \"success\": true and a TOKEN value. You will need this TOKEN for the NCOA JSON and Batch Stop calls.
This call is used to check and update addresses using the NCOA (National Change of Address) system. It returns the updated address in a JSON format when it finds a match.
\n{\n \"address\": [\n {\n \"uniqueid\": \"00000001\",\n \"street_primary\": \"2450\",\n \"street_pre\": \"S\",\n \"street_name\": \"SHORE\",\n \"street_suffix\": \"BLVD\",\n \"street_post\": \"\",\n \"street_secondary_name\": \"STE\",\n \"street_secondary_number\": \"125\",\n \"zip5\": \"77573\",\n \"zip4\": \"2996\",\n \"name_salutation\": \"\",\n \"name_first\": \"John\",\n \"name_middle\": \"\",\n \"name_last\": \"Jones\",\n \"name_title\": \"\",\n \"company_name\": \"\",\n \"dpv_notes\": \"BB\",\n \"delivery_point\": \"25\",\n \"record_type\": \"H\"\n }\n ]\n}\n\n
\nHere is a list of the values used in each object:
\nThe response will contain the updated address in a JSON format when it finds a match through NCOA. A specific address can be found by looking for \"uniqueid\"
This call is used to stop the batch process after you've finished sending all your records with the previous NCOA JSON call.
\nWhen this call is successful, it will give you a response with:
1. A status of 200 OK
\n2. A JSON object that includes \"success\": true
3. A \"message\" that says the batch has been stopped successfully.
This collection contains the documentation for our NCOA RESTful API which will allow you to run addresses that have already been ZIP+4 coded and DPV confirmed through NCOA.
\nHere is a basic overview of the steps:
1. Start the batch: First, you make the call to start the batch process and receive a token for the job.
\n2. Send all records: Then, you send all your address records using another call and receive the NCOA results in a JSON format.
\n3. Stop the batch: Finally, you make the call to stop the batch process and receive confirmation.
\n","auth":{"type":"bearer","bearer":{"token":"{{TOKEN}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"26596e6a-025d-47ba-9f8d-ce612ecf8f2a","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7956ba95-1fe4-406c-a420-e5a53e950f9d","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"598bef85-a53b-421e-967b-03f627ebb5d2"}],"event":[{"listen":"prerequest","script":{"id":"68d8d2f7-3dfc-426d-83e4-83f743bbce29","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59a0424b-1dc0-4852-8b5b-40fb1b1fc61b","type":"text/javascript","exec":[""]}}],"variable":[{"key":"dq_serverURL","value":"https://cloud2.iaccutrace.com","type":"string"},{"key":"dq_api_key","value":"{{dq_api_key}}","type":"string"},{"key":"dq_ver","value":"v2_0/","type":"string"},{"key":"dq_pGUID","value":"{{dq_pGUID}}","type":"string"},{"key":"dq_pBackOffice","value":"json","type":"string"},{"key":"pGUID","value":"{{pGUID}}","type":"string"},{"key":"eddm_serverURL","value":"https://cloud2.iaccutrace.com","type":"string"},{"key":"eddm_ver","value":"v2_0/","type":"string"},{"key":"eddm_pGUID","value":"{{eddm_pGUID}}","type":"string"},{"key":"eddm_api_key","value":"{{eddm_api_key}}","type":"string"},{"key":"cass_serverURL","value":"https://api.cassonline.com","type":"string"},{"key":"cass_api_key","value":"{{cass_api_key}}","type":"string"}]}