Verification

Get per-address results

Returns the outcome for each address in a run, optionally filtered to one outcome. Results are available while the run is still going, so you can act on the part that has finished.

Required scope: verification:read.

The run summary travels with every page, so polling takes one request rather than two.

Each result carries a plain-English reason. Addresses not yet reached read as pending or processing.

get/verification/batches/{id}/results

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/verification/batches/{id}/results
  • Auth: HTTP bearer

Path parameters

idstring required

The run id.

Query parameters

status'pending' | 'processing' | 'valid' | 'invalid' | 'risky' | 'unknown' | 'error' | 'cancelled'

Return only addresses with this outcome. Omit for all.

limitinteger

Results per page (1–1,000).

offsetinteger

Result offset for paging.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.