validate_recipient_address
HTTP Method: POST

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

Endpoint

https://api.finerworks.com/v3/validate_recipient_address


Authorization Credentials
Must include in header or as querystring parameters during request.

Name/KeyDescriptionTypeAdditional information
web_api_key

Can be found here within your FinerWorks account.

text

Required

app_key

Can be generated here within your FinerWorks account.

text

Required

Body Parameters

address_request object

NameDescriptionTypeAdditional information
recipient

Address object

address

Required

Example

application/json, text/json

{
  "recipient": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company_name": "sample string 3",
    "address_1": "sample string 4",
    "address_2": "sample string 5",
    "address_3": "sample string 6",
    "city": "sample string 7",
    "state_code": "sample string 8",
    "province": "sample string 9",
    "zip_postal_code": "sample string 10",
    "country_code": "sample string 11",
    "phone": "sample string 12",
    "email": "sample string 13"
  }
}

NameDescriptionTypeAdditional information
status

response_status

None.

address

Address object

address

None.

Example

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  },
  "address": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "company_name": "sample string 3",
    "address_1": "sample string 4",
    "address_2": "sample string 5",
    "address_3": "sample string 6",
    "city": "sample string 7",
    "state_code": "sample string 8",
    "province": "sample string 9",
    "zip_postal_code": "sample string 10",
    "country_code": "sample string 11",
    "phone": "sample string 12",
    "email": "sample string 13"
  }
}