Address verification parameters
Request and response parameters for location change requests sent to and received from the Relish Data Assure API.
Address validation input parameters
Parameters for address validation within location change requests.
| Parameter | Required | Length | Type | Description |
|---|---|---|---|---|
| type | Yes | Varies | Enum | Validation type. Use address for location changes. |
| externalId | Yes | Varies | String | Unique identifier for this validation. Copied to output for matching. |
| addressLine1 | Yes | 1-64 characters | String | Street number and name in the first line of the address. |
| city | No | 1-64 characters | String | City or locality name. For non-US users, this field acts as the locality. |
| state | Yes | 32 characters | String | State or administrative area name. For non-US users, this field acts as the administrative area. |
| zipcode | No | 16 characters | String | ZIP or postal code. For non-US users, this field acts as the postal code. |
| country | Yes | 2-3 characters | String | ISO 3166 alpha-2 or alpha-3 country code. |
Response parameters
Parameters returned in API responses for location change requests.
| Parameter | Type | Description |
|---|---|---|
| status | Enum | Transaction status: PENDING, PROCESSING, COMPLETED, or ERROR |
| result | Enum | General transaction result: PASSED, PASSED WITH CAUTIONS, FAILED, REVISION REQUIRED, or BYPASS |
| validationSummary | Array | Summary of results for each validation type. |
| validations | Array | Array of validation results processed by the API. |
Parent Topic:Verify supplier location change request
Related topics
Verify supplier location change request