arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/validate_recipient_address

Address Validation

Can be used to validate and test an address such as an order's recipient.

Body

address_request object

Name Description Type Additional information
recipient Address object address

Required

Example JSON Body

application/json, text/json

{
  "recipient": {
    "first_name": "Bob",
    "last_name": "Ross",
    "company_name": "Happy Little Trees, Inc",
    "address_1": "742 Evergreen Terrace",
    "address_2": null,
    "address_3": null,
    "city": "Mountain Scene",
    "state_code": "AK",
    "province": null,
    "zip_postal_code": "88888",
    "country_code": "us",
    "phone": "555-555-5555",
    "email": null,
    "address_order_po": "12345"
  }
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/validate_recipient_address' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "recipient": {
    "first_name": "Bob",
    "last_name": "Ross",
    "company_name": "Happy Little Trees, Inc",
    "address_1": "742 Evergreen Terrace",
    "address_2": null,
    "address_3": null,
    "city": "Mountain Scene",
    "state_code": "AK",
    "province": null,
    "zip_postal_code": "88888",
    "country_code": "us",
    "phone": "555-555-5555",
    "email": null,
    "address_order_po": "12345"
  }
}'