Bulk Geo Addressing

Performs address verification and standardization of the addresses file

This 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.

post/v1/bulk-verify

Request

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

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

X-CASS-FLOWstring

The X-CASS-FLOW header is optional and used for the identification of cass flow.For normal flow it can be empty or null ,but for cass flow we can have one of the 2 values: with_report,no_report

Request body

fileIdstring required

file id of the uploaded file to gecode/verify

delimiterstring

Delimiter for separating fields in the file. Supported delimiters are pipe(|) comma(,) semi-comma(;) and tab(\t)

Example request

{
  "fileId": "8d907c8c-5b63-417f-b69f-2d33dbdd2fcd",
  "reportDetails": {
    "listProcessorName": "Precisely Software Inc.",
    "listNameId": "Q00362LQ",
    "totalList": "1",
    "mailingAddress": "123 Main St, New York, NY 10001 USA",
    "postNumber": "A01 331"
  },
  "delimiter": "\\t",
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "asd",
      "featureSpecific": {
        "LOOKUP": "ggs"
      }
    },
    "customPreferences": {
      "DATA_OPTION": "PREMIUM"
    },
    "clientLocale": {
      "language": "en",
      "script": "Latn",
      "country": "US",
      "variant": "POSIX",
      "unicodeLocaleAttributes": [
        "attribute1",
        "attribute2"
      ],
      "unicodeLocaleKeys": {
        "nu": "thai"
      },
      "extensionKeys": {
        "x": "private-use"
      }
    },
    "clientCoordSysName": "EPSG:4326",
    "distance": {
      "value": 5,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 5,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 5,
      "distanceUnit": "METER"
    },
    "matchMode": "EXACT",
    "originXY": [
      0,
      0
    ],
    "returnOfAdditionalFields": [
      "RESULT_CODE",
      "PRECISION_CODE"
    ]
  }
}

Response

Bulk Verify Job Accepted

statusUrlstring uri required

URL for checking the status of the Bulk Geocode or Verify job

statusstring nullable

Status of Job Submission in not accepted

messagestring nullable

Message of job submission

Example response

{
  "statusUrl": "https://api.cloud.precisely.com/v1/bulk/jobs/180c0892-affc-4f7a-b1c3-d5e965a6eefb",
  "status": "REJECTED",
  "message": "Queue full"
}

Changes

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