---
title: "Performs address verification and standardization of the addresses file"
method: POST
path: "/v2/bulk-verify"
tags: ["Bulk Geo Addressing"]
---

# Performs address verification and standardization of the addresses file

`POST /v2/bulk-verify`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v2/bulk-verify`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

This V2 API performs address verification and standardization of the addresses file. It takes file id corresponding to uploaded file and returns the url to check the status of address verification job.

## Headers

- `X-Request-Id` string
- `X-CASS-FLOW` string

## Request body

- BulkGeocodeRequest: Bulk geocode request
  - `fileId` string, required: file id of the uploaded file to gecode/verify
  - `reportDetails` ReportDetails: Details for the Report
    - `listProcessorName` string: Name of the company
    - `listNameId` string: Name of the processed file
    - `totalList` string: Total number of lists
    - `mailingAddress` string: Company mailing address
    - `postNumber` string: Seven-digit POST contract number
  - `delimiter` string: Delimiter for separating fields in the file. Supported delimiters are pipe(|) comma(,) semi-comma(;) and tab(\t)
  - `preferences` Preferences: Preferences that will processed with the request
    - `maxResults` integer: The maximum number of candidates to return. Default = 1.
    - `returnAllInfo` boolean: Specifies whether to return all available information for each candidate.
    - `factoryDescription` FactoryDescription: Controls which address processor will process the request.
      - `label` string: Sets the addressing processor based on the configured data. Labels are case-sensitive and must be lowercase. Default is "".
      - `featureSpecific` object: Ability to map a feature to an address processor, based on specified label.
        - `GEOCODE` string
        - `PARSE` string
        - `VERIFY` string
        - `REVERSE_GEOCODE` string
        - `INTERACTIVE` string
        - `LOOKUP` string
    - `customPreferences` object: For use against any country dataset, define custom preferences to control additional functionality such as matching criteria, address casing, and enable functionality like DPV and SuiteLink.
    - `clientLocale` Locale: Represents a locale with language, script, country, and variant information.
      - `language` string: The ISO 639 language code.
      - `script` string: The ISO 15924 script code.
      - `country` string: The ISO 3166 country code.
      - `variant` string: The variant code for the locale.
      - `unicodeLocaleAttributes` string[]: The Unicode locale attributes.
      - `unicodeLocaleKeys` object: The Unicode locale keys.
      - `extensionKeys` object: The extension keys.
    - `clientCoordSysName` string: Specifies the coordinate system that you want to convert the geometry to. The format must be the European Petroleum Survey Group (EPSG) code or the SRID code. Default = EPSG:4326.
    - `distance` Distance: 'distance' displays the defined search radius (default is 5 meters). 'streetOffset' specifies the offset distance from the street segments to use in street-level geocoding. 'cornerOffset' specifies the distance to offset the street end points in street-level matching (default is 7 meters).
      - `value` number, double: Distance of the radius in which to search for a match. Default is 5.
      - `distanceUnit` 'FOOT' | 'METER' | 'MILE' | 'KILOMETER': Distance unit
    - `streetOffset` Distance: 'distance' displays the defined search radius (default is 5 meters). 'streetOffset' specifies the offset distance from the street segments to use in street-level geocoding. 'cornerOffset' specifies the distance to offset the street end points in street-level matching (default is 7 meters).
      - `value` number, double: Distance of the radius in which to search for a match. Default is 5.
      - `distanceUnit` 'FOOT' | 'METER' | 'MILE' | 'KILOMETER': Distance unit
    - `cornerOffset` Distance: 'distance' displays the defined search radius (default is 5 meters). 'streetOffset' specifies the offset distance from the street segments to use in street-level geocoding. 'cornerOffset' specifies the distance to offset the street end points in street-level matching (default is 7 meters).
      - `value` number, double: Distance of the radius in which to search for a match. Default is 5.
      - `distanceUnit` 'FOOT' | 'METER' | 'MILE' | 'KILOMETER': Distance unit
    - `fallbackToGeographic` boolean: Specifies whether to attempt to determine a geographic centroid when an address-level geocode cannot be determined. Optional.
    - `fallbackToPostal` boolean: Specifies whether to attempt to determine a post code centroid when an address-level geocode cannot be determined. Optional.
    - `matchMode` string: Match modes determine the leniency used to make a match between the input address and the reference data.
    - `originXY` number[]: XY coordinates of the origin address.
    - `returnOfAdditionalFields` string[]: This lets the user control which additional fields they want to have returned if they do not want to return all info.

## Response `202`

Bulk Verify Job Accepted

- BulkGeocodeResponse: Bulk geocode response
  - `statusUrl` string, uri, required: URL for checking the status of the Bulk Geocode or Verify job
  - `status` string, nullable: Status of Job Submission in not accepted
  - `message` string, nullable: Message of job submission

## Other responses

- `400`: Invalid request for Bulk Verify API
- `401`: Unauthorized: Invalid token for Bulk Verify API
- `403`: Forbidden for Bulk Verify API
- `429`: Too many requests for Bulk Verify API
- `500`: Internal Server Error for Bulk Verify API

---

[API](https://skmtc.dev/precisely/apis/bulk-geo-addressing-api.md) · [All operations](https://skmtc.dev/precisely/apis/bulk-geo-addressing-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/bulk-geo-addressing-api/revisions/aad307eeb518?raw)