Address Import
Session Import Addresses
Import a batch of addresses for pre-collection within a session
POST
Overview
The Session Import Addresses API allows you to submit a batch of addresses to be processed and stored in our database within a specific session context. This endpoint is designed for bulk address importing as part of a multi-batch import workflow.
To obtain an API key, please contact our sales team.
Authorization
Your API key for authentication
Body
The session ID obtained from the Create Import Session endpoint
Array of addresses to import and process
Notes
- This endpoint must be used with a valid session ID created using the Create Import Session endpoint
- Each address in the response includes:
- The original address string
- An
imported
flag indicating whether the address was successfully processed - A
status
field with detailed information about what happened with the address
- Possible status values include:
- “Imported”: Address was successfully validated and added to the database
- “Already exists”: Address already exists in the database
- “Invalid address”: Address could not be validated or standardized
- The response includes summary counts for each type of result
- If none of the addresses could be imported,
batch_id
will benull
- Use the Check Batch Status endpoint to monitor the processing status of imported addresses
- There is a limit to how many addresses can be imported in a single request