SATIK DEVELOPER DOCS · V1 BETA
One list. Many clearer addresses.
Upload a CSV or queue a batch through the API.
Prepare your input
Use these CSV headers. Quote addresses containing commas; escaped quotes and multiline fields are supported.
| Field | Requirement |
|---|---|
Delivery addressaddress | Required. Each address must contain 5–280 characters. |
Phone numberphone | Optional. Include the customer’s phone number when available. |
Order referenceorder_id | Optional. Use your order ID to match results to orders. |
Process asynchronously
Submit the batch, then check its progress while addresses are processed in the background.
| Step or limit | What happens |
|---|---|
1. Submit the batchPOST /v1/addresses/verify/batch | Returns a queued batch ID. Save it to check progress later. |
2. Check progressGET /v1/batches/{batch_id} | Read progress using the batch ID. In the workspace, use Refresh; the page does not automatically poll. |
| Background processing | Workers claim queued items from durable storage and process individual addresses. |
| Quota usage | Quota is consumed as individual address checks complete. |
| Batch size limit | The lower of your plan’s batch limit and 1,000 addresses. |
Cancel remaining work
Choose Cancel in Your batches or POST /v1/batches/{batch_id}/cancel with a live key. No request body is required. Queued work is cancelled immediately. Already-started checks may finish, so the batch stays cancelling until they settle. Repeating cancellation is safe. Completed batches remain completed. A cancelled batch can contain successful, failed and cancelled rows; done counts successes plus failures, not cancelled rows.
Credits and cancellation
Satik reserves quota per started verification, not for the whole batch. Rows cancelled before starting consume no verification quota. Started checks follow normal quota accounting; cancellation does not refund completed work or undo provider calls. Failed verification reservations are released through the normal failure and expiry paths.
Browse your batches
The workspace shows a limited page of recent batches with Previous and Next controls. Refresh returns to the newest page without reloading your CSV form. There is no automatic polling. Full batch IDs can be copied for API requests.
Download results
Download completed or cancelled batch results from your workspace or GET /v1/batches/{batch_id}/download with your Bearer key. The CSV includes row status, successful verification details and failure messages. Cancelled rows have no verification result. Downloads before terminal status return HTTP 409.
| Property | Behavior |
|---|---|
| Access | Downloads require authentication and belong to your workspace. |
| Availability | CSV results are available for 7 days after batch submission. |
| Failed rows | Include an error, so a malformed address does not hide the rest of the batch. |