Address Suggest

This operation displays a valid address to match the entered address, only if the address does not seem valid to the system address map. User can select the suggested address or edit the entered address to make it valid.

SecuritybearerAuth

Request

Request Body schema: application/json

required

object

Responses

200

The address is suggested to use.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/address/suggest

Request samples

application/json

{"address": {"addressLine1": "27 Watervw Dr",
"addressLine2": "",
"addressLine3": "",
"cityTown": "Shelton",
"countryCode": "US",
"name": "John Smith",
"postalCode": "06484",
"stateProvince": "CT"
}
}

Response samples

application/json

{"address": {"addressLine1": "27 Watervw Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Shelton",
"countryCode": "US",
"name": "John Smith",
"postalCode": "06484",
"residential": "false",
"stateProvince": "CT",
"status": "VALIDATED_CHANGE",
"deliveryPoint": "57",
"carrierRoute": "C005"
},
"suggestions": {"suggestionType": " ",
"addresses": [{"addressLine1": "27 Watervw Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Shelton",
"name": "John Smith",
"postalCode": "06484",
"residential": "false",
"stateProvince": "CT",
"deliveryPoint": "57",
"carrierRoute": "C005"
}
]
}
}