---
title: "GET /v1/addver_lists/{id}"
method: GET
path: "/v1/addver_lists/{id}"
tags: ["Bulk Verification"]
---

# GET /v1/addver_lists/{id}

`GET /v1/addver_lists/{id}`

Retrieve a single bulk verification list by ID, including its processing
status and — once processed — a link to the output CSV.

## Path parameters

- `id` string, required

## Response `200`

The request has succeeded.

- object
  - `status` 'success' | 'error', required
  - `message` string, required
  - `data` AddverList, required — A bulk address verification list — an uploaded CSV file of addresses and its processing state.
    - `id` string, required — A unique ID prefixed with `addver_list_`.
    - `name` string, required — The name supplied for the list. This only affects what is displayed in the dashboard.
    - `status` string, required — The processing status of the list, e.g. `pending`, `processing`, or `processed`.
    - `count` integer, required — The number of addresses in the uploaded file.
    - `numInvalidRows` integer — The number of invalid or skipped rows in the uploaded file. May be omitted on lists created before this field was introduced.
    - `cost` integer, required — The cost charged for processing this list.
    - `defaultCountry` string — The ISO 2-letter country code used as the fallback when a row is missing a country. Not returned for lists uploaded without one, e.g. lists which map the entire address into `line1`.
    - `useIntlVerification` boolean, required — Whether international (outside US & Canada) verification was requested.
    - `useGeocode` boolean, required — Whether geocoding (latitude/longitude) output was requested.
    - `useProperCase` boolean, required — Whether Proper Case output was requested.
    - `runNCOA` boolean — Whether NCOA (US National Change of Address) was requested. May be omitted on lists created before COA support was introduced.
    - `runCCOA` boolean — Whether CCOA (Canada Post change of address) was requested. May be omitted on lists created before COA support was introduced.
    - `mappings` AddverListMappings, required — The mapping of your CSV column names to PostGrid address fields. Each value is the name of a column in your uploaded file.
      - `line1` string, required — The column containing the first line of each address. If your entire address is in a single column, specify only this mapping.
      - `line2` string — The column containing the second line of each address.
      - `city` string — The column containing the city of each address.
      - `provinceOrState` string — The column containing the province or state of each address.
      - `postalOrZip` string — The column containing the postal or ZIP code of each address.
      - `country` string — The column containing the 2-letter ISO country code of each address (e.g. `US`, not `United States`).
      - `firstName` string — The column containing the first name of the person at each address. Only used when NCOA is run.
      - `lastName` string — The column containing the last name of the person at each address. Only used when NCOA is run.
      - `fullName` string — The column containing the full name of the person at each address. Can be supplied instead of `firstName` and `lastName`. Only used when NCOA or CCOA is run.
    - `file` string, required — A signed URL to the uploaded input CSV file.
    - `result` string — A signed URL to the processed output CSV file. Present once the list has finished processing.
    - `metadata` object — Additional metadata about the list, including a count of each status.
      - `statusCount` object — The number of addresses by resulting verification status.
        - `verified` integer
        - `corrected` integer
        - `failed` integer
    - `organization` string, required — The ID of the organization that owns this list.
    - `user` string, required — The ID of the user that created this list.
    - `createdAt` string, date-time, required — The UTC time at which this list was created.
    - `updatedAt` string, date-time, required — The UTC time at which this list was last updated.

## Other responses

- `400` — The server could not understand the request due to invalid syntax.

---

[API](https://skmtc.net/postgrid/apis/postgrid-address-verification-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-address-verification-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-address-verification-api/revisions/537d2bbc624a/schema)