REST API process

Before Batch API can search on an address, it needs to know what level of searching to undertake, and how to return any matches that it finds. You will need to configure these options in the configuration file.

Method

/clean can be used to validate and format a list of addresses in one easy step:

  • Enter a list of addresses.
    POST /address/clean/v1: validates and formats the addresses in a list giving each a match code.

Recommended integration

Batch size

When integrating the product, please consider that the optimal number of searches per cleaning request depends on the deployment machine, dataset and quality of input addresses.

Given all circumstances, total request running times above 30 seconds should be avoided unless the network infrastructure is customized to tolerate longer requests.
In general, request sizes between 200 and 2000 addresses per batch should work well in most systems.

User workflow

  1. The user enters a list of addresses
  2. The user then triggers the validation process.
  3. The addresses entered will be returned formatted with a corresponding match code.

Sequence diagram

Batch sequence diagram

Developer workflow

Batch developer workflow