This Route is used to Address Validation and as well as create a new file resource.
Paths for a file resource could either be a full URL to the file resource or a FTP path. For Address Validation It should be valid csv file URL.
Resource URI
POST /files
Input Parameters
@param path {string} Path to resource file (http, https or ftp paths)
@param validation_type {string} Possible values for validation_type: none, CASS, NCOA
@param address_count {string} address_count is the run_size
JSON
{
"path":["https://8b887e04.amazonaws.com/MailingAddress-zpNqyJSbutbuH.csv"],
"validation_type":"none",
"address_count":"1000"
}
Sample Response
JSON
{
"files": [
{
"file_uuid": "cc2119c9-9e98-4071-b0ea-71b31a9df4c0",
"size_bytes": 183398,
"extension": "csv",
"reference_file_name": "42c93e14-0482-4b72-9bd4-85b4e2531ca9.csv",
"uri": "https://dev-api.4over.com/files/cc2119c9-9e98-4071-b0ea-71b3wed3xxwwee",
"created_at": "2024-09-27T19:49:15-07:00",
"updated_at": "",
"deleted_at": "",
"number_of_pages": "1"
}
],
"address_validation_response": {
"validation_type": "NONE",
"original_address_list_csv": "https://8b98ee04-eeee-46f4-b35f-e4676hu23fbe.s3.us-west-1.amazonaws.com/OriginalMailingAddress-y2ag0DfoYEIuaryhqoK08r02VWYkdQ4r.csv",
"precleanlist_csv": "https://8b98ee04-eeee-46f4-b35f-e4676hu23fbe.s3.us-west-1.amazonaws.com/precleanlist_csv-y2ag0DfoYEIuaryhqoK08r02VWYkdQ4r.csv",
"validation_report_pdf": "https://8b98ee04-eeee-46f4-b35f-e4676hu23fbe.s3.us-west-1.amazonaws.com/validation_report_pdf-y2ag0DfoYEIuaryhqoK08r02VWYkdQ4r.pdf",
"statement_id": "y2ag0DfoYEIuaryhqoK08rsjdhejhwejhe"
}
}
NOTE:
original_address_list_csv: This likely refers to a CSV file that contains a list of addresses in their original format.
precleanlist_csv: It contains addresses that have been “pre-cleaned” or processed to remove errors, duplicates.
statement_id: This is likely an identifier for a specific statement or record.