The flow of the Bulk Geo Addressing APIs will be as follows:
- Use the
File Upload URL APIto get the presigned URL to upload the file to AWS S3. The upload URL will be valid only for next 10 minutes. - Then upload the file using the presigned URL.
- Then take the file ID, returned by
File upload URL APIand use theBulk Verify/Geocode APIto submit the job. It will return the URL forStatus API. - Using the
Status API, you can check the current status of the processing. Statuses can be as follows:- Scheduled: Job is scheduled and waiting to be picked.
- Running: Job is running.
- Completed: Job is completed.
- Failed: Job is failed.
- When job gets completed,
Status APIreturns the download URL for the output file. This download URL is valid for next 10 minutes. If you want to access the file again after 10 minutes, then you need to hit the status API again and it will return the new download URL which again will be valid for next 10 minutes. - There are 2 more APIs which is to get the list of uploaded files
(
List Uploaded Files API) and to delete any of the uploaded files (Delete File API) from S3.
The Geocode Address Service results can be used for last mile delivery, mortgage assessments, insurance underwriting, master data management, location enrichment, analytics - site location, risk analysis, network and coverage planning, mapping, visualization, and many more use cases around the location.
Bulk Geo Addressing Service supports global coverage but will vary from country to country, and even within countries. Coverage will depend on the data sources we use.
Error Codes
Each response to a request contains an HTTP status code. The Geocode Address Service will return one of the following error codes
| Error Code | Description |
|---|---|
| DIS-1001 | Invalid token |
| DIS-1002 | Not Authorized to access this API |
| DIS-1003 | Bulk-api-service is down |
| DIS-LI-1011 | Service is not available to serve the request |
| DIS-LI-1012 | Issue with internal services |
| DIS-LI-1013 | JWT token is not valid |
| DIS-LI-1018 | Request Body is not valid |
| DIS-LI-1019 | Request body is not specified in the request |
| DIS-LI-1024 | Workspace ID is not valid in JWT token |
| DIS-LI-1051 | Job id is incorrect |
| DIS-LI-1052 | File id is incorrect |
| DIS-LI-1053 | Mandatory input headers are missing in input file or the file is not UTF-8 encoded |
| DIS-LI-1054 | Duplicate input headers found |