...
The rest of this document describes common aspects for both endpoints.
Concepts and notation
- source authority : the system that makes the decision on whether the address is supported. The use of a delivererMask may affect which source authority processes the customer address.
- uuid : a unique identifier returned by the service when a batch of customer addresses are submitted for processing. Is used later in a subsequent request to inform the service which batch is targeted.
- expiry : the results of a processed batch will expire a certain time after the request has been completed. The status of the batch is reported in the service response.
- proxy timeout : describes when the service will cancel outstanding requests to other source systems. All associated customer addresses will be marked as not supported.
- delivererMask : a mechanism to tell the service that an address should be marked as unsupported, or to specify a set of distribution companies that qualify (all others are then disqualified and will not be considered).
...