ValidateAddress Service Operation - Customer Management

Article
11/13/2024

Determines whether or not the submitted address is valid for Microsoft Advertising accounts.

If the address is valid you can use it as the account BusinessAddress.

For Australia (AU), Canada (CA), and The United States (US), the operation validates whether or not you could ship something to the address. For all other countries or regions basic address verification (AVS) is completed.

Request Elements

The ValidateAddressRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
Address	The address to validate.	Address

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The ValidateAddressResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
OriginalAddress	The address that was submitted for validation. The submitted Address is always passed back here in the response, so this element is always set.	Address
Status	Determines whether or not the submitted address is valid for Microsoft Advertising accounts, and whether or not any address suggestions are available via the SuggestedAddresses response element. Possible string values are AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions, and AddressInvalidWithSuggestions.	string
SuggestedAddresses	One or more suggested addresses if the Status is either AddressValidWithSuggestions or AddressInvalidWithSuggestions. This element will be nil if the Status is either AddressValidWithoutSuggestions or AddressInvalidWithoutSuggestions.	Address array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <Action mustUnderstand="1">ValidateAddress</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <ValidateAddressRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Address xmlns:e593="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e593:City i:nil="false">ValueHere</e593:City>
        <e593:CountryCode i:nil="false">ValueHere</e593:CountryCode>
        <e593:Id i:nil="false">ValueHere</e593:Id>
        <e593:Line1 i:nil="false">ValueHere</e593:Line1>
        <e593:Line2 i:nil="false">ValueHere</e593:Line2>
        <e593:Line3 i:nil="false">ValueHere</e593:Line3>
        <e593:Line4 i:nil="false">ValueHere</e593:Line4>
        <e593:PostalCode i:nil="false">ValueHere</e593:PostalCode>
        <e593:StateOrProvince i:nil="false">ValueHere</e593:StateOrProvince>
        <e593:TimeStamp i:nil="false">ValueHere</e593:TimeStamp>
        <e593:BusinessName i:nil="false">ValueHere</e593:BusinessName>
      </Address>
    </ValidateAddressRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <ValidateAddressResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <OriginalAddress xmlns:e594="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e594:City d4p1:nil="false">ValueHere</e594:City>
        <e594:CountryCode d4p1:nil="false">ValueHere</e594:CountryCode>
        <e594:Id d4p1:nil="false">ValueHere</e594:Id>
        <e594:Line1 d4p1:nil="false">ValueHere</e594:Line1>
        <e594:Line2 d4p1:nil="false">ValueHere</e594:Line2>
        <e594:Line3 d4p1:nil="false">ValueHere</e594:Line3>
        <e594:Line4 d4p1:nil="false">ValueHere</e594:Line4>
        <e594:PostalCode d4p1:nil="false">ValueHere</e594:PostalCode>
        <e594:StateOrProvince d4p1:nil="false">ValueHere</e594:StateOrProvince>
        <e594:TimeStamp d4p1:nil="false">ValueHere</e594:TimeStamp>
        <e594:BusinessName d4p1:nil="false">ValueHere</e594:BusinessName>
      </OriginalAddress>
      <Status d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Status>
      <SuggestedAddresses xmlns:e595="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e595:Address>
          <e595:City d4p1:nil="false">ValueHere</e595:City>
          <e595:CountryCode d4p1:nil="false">ValueHere</e595:CountryCode>
          <e595:Id d4p1:nil="false">ValueHere</e595:Id>
          <e595:Line1 d4p1:nil="false">ValueHere</e595:Line1>
          <e595:Line2 d4p1:nil="false">ValueHere</e595:Line2>
          <e595:Line3 d4p1:nil="false">ValueHere</e595:Line3>
          <e595:Line4 d4p1:nil="false">ValueHere</e595:Line4>
          <e595:PostalCode d4p1:nil="false">ValueHere</e595:PostalCode>
          <e595:StateOrProvince d4p1:nil="false">ValueHere</e595:StateOrProvince>
          <e595:TimeStamp d4p1:nil="false">ValueHere</e595:TimeStamp>
          <e595:BusinessName d4p1:nil="false">ValueHere</e595:BusinessName>
        </e595:Address>
      </SuggestedAddresses>
    </ValidateAddressResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<ValidateAddressResponse> ValidateAddressAsync(
	Address address)
{
	var request = new ValidateAddressRequest
	{
		Address = address
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.ValidateAddressAsync(r), request));
}

static ValidateAddressResponse validateAddress(
	Address address) throws RemoteException, Exception
{
	ValidateAddressRequest request = new ValidateAddressRequest();

	request.setAddress(address);

	return CustomerManagementService.getService().validateAddress(request);
}

static function ValidateAddress(
	$address)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new ValidateAddressRequest();

	$request->Address = $address;

	return $GLOBALS['CustomerManagementProxy']->GetService()->ValidateAddress($request);
}

response=customermanagement_service.ValidateAddress(
	Address=Address)

Requirements

Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Address/Validate

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/Address/Validate

Request Elements

The ValidateAddressRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
Address	The address to validate.	Address

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The ValidateAddressResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element	Description	Data Type
OriginalAddress	The address that was submitted for validation. The submitted Address is always passed back here in the response, so this element is always set.	Address
Status	Determines whether or not the submitted address is valid for Microsoft Advertising accounts, and whether or not any address suggestions are available via the SuggestedAddresses response element. Possible string values are AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions, and AddressInvalidWithSuggestions.	string
SuggestedAddresses	One or more suggested addresses if the Status is either AddressValidWithSuggestions or AddressInvalidWithSuggestions. This element will be nil if the Status is either AddressValidWithoutSuggestions or AddressInvalidWithoutSuggestions.	Address array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "Address": {
    "BusinessName": "ValueHere",
    "City": "ValueHere",
    "CountryCode": "ValueHere",
    "Id": "LongValueHere",
    "Line1": "ValueHere",
    "Line2": "ValueHere",
    "Line3": "ValueHere",
    "Line4": "ValueHere",
    "PostalCode": "ValueHere",
    "StateOrProvince": "ValueHere",
    "TimeStamp": "ValueHere"
  }
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "OriginalAddress": {
    "BusinessName": "ValueHere",
    "City": "ValueHere",
    "CountryCode": "ValueHere",
    "Id": "LongValueHere",
    "Line1": "ValueHere",
    "Line2": "ValueHere",
    "Line3": "ValueHere",
    "Line4": "ValueHere",
    "PostalCode": "ValueHere",
    "StateOrProvince": "ValueHere",
    "TimeStamp": "ValueHere"
  },
  "Status": "ValueHere",
  "SuggestedAddresses": [
    {
      "BusinessName": "ValueHere",
      "City": "ValueHere",
      "CountryCode": "ValueHere",
      "Id": "LongValueHere",
      "Line1": "ValueHere",
      "Line2": "ValueHere",
      "Line3": "ValueHere",
      "Line4": "ValueHere",
      "PostalCode": "ValueHere",
      "StateOrProvince": "ValueHere",
      "TimeStamp": "ValueHere"
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<ValidateAddressResponse> ValidateAddressAsync(
	Address address)
{
	var request = new ValidateAddressRequest
	{
		Address = address
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.ValidateAddressAsync(r), request));
}

static ValidateAddressResponse validateAddress(
	Address address) throws RemoteException, Exception
{
	ValidateAddressRequest request = new ValidateAddressRequest();

	request.setAddress(address);

	return CustomerManagementService.getService().validateAddress(request);
}

static function ValidateAddress(
	$address)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new ValidateAddressRequest();

	$request->Address = $address;

	return $GLOBALS['CustomerManagementProxy']->GetService()->ValidateAddress($request);
}

response=customermanagement_service.ValidateAddress(
	Address=Address)

Share via

ValidateAddress Service Operation - Customer Management

Request Elements

Request Body Elements

Request Header Elements

Response Elements

Response Body Elements

Response Header Elements

Request SOAP

Response SOAP

Code Syntax

Requirements

Request Url

Request Elements

Request Body Elements

Request Header Elements

Response Elements

Response Body Elements

Response Header Elements

Request JSON

Response JSON

Code Syntax

Feedback

Additional resources