Allows you to validate or complete recipient addresses.
Via this component you can perform the following:
- Confirm the validity and completeness of US, Puerto Rico and Canadian recipient addresses.
- Complete incomplete recipient addresses.
- Correct invalid recipient addresses.
- Determine whether an address is business or residential to increase the accuracy of courtesy rate quotes. This applies to US addresses only.
- Find information on the nearest FedEx location(s).
Having correct addresses on the shipping labels will eliminate delivery delays and additional service fees (occurring when a shipment is re-routed).
For address verification, use the ValidateAddress method. This provides street level matches, but it does not currently verify suite or apartment numbers. It checks if the street exists in the city and state/province or postal code entered, and if the street number is within a valid range for the street entered. Upon successful reply, it either provides an exact match or possible alternatives (multiple address results) when an exact match cannot be found based on the input values, or informs you if no possible alternatives can be found.
The following information is the minimum required to check an address:
- Street Address
- City and State/Province or Postal Code
To search for the nearest FedEx location(s), use the FindLocations method. You can search by address or telephone number.
To narrow down the search, you can specify what type of locations are you looking for (such as FedEx Staffed, Self-Service and/or Authorized Ship Center) and any special service those locations offer (such as Saturday service, packaging supplies, packing services, latest Express drop-off, etc.).
If the request completes successfully, FedEx server will return a set of matches that satisfies the search criteria. You will be able to retrieve FedEx location Ids, addresses, available services they offer, operations hours on weekdays and/or weekends.
The set of locations retrieved is limited to a maximum of ten locations returned within a 50-mile radius.
To use this component, you must have a FedEx AccountNumber. You should also have already obtained a DeveloperKey, Password and a MeterNumber uniquely assigned to your account by FedEx after registration for Web Services.
FedEx allows this service to be used in production environment only (i.e., after passing the certification). Customers need to be certified first in order to have the Advanced (such as Address Validation) services activated. After the certification is granted, you will receive the production credentials (DeveloperKey, Password and MeterNumber) uniquely assigned to your AccountNumber by FedEx after being certified for FedEx Web Services. Once they move to production, Address Validation is a feature that has to be activated upon the customer's request.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|Address||Identifies the address to be validated.|
|Company||Name of the company that resides at the address to be validated.|
|Constraints||Specifies the constraints to be used.|
|FedExAccount||Login information for FedEx.|
|Firewall||A set of properties related to firewall access.|
|GeographicCoordinates||Specifies the geographic coordinates by which nearby FedEx locations are to be found.|
|Locations||Collection of location matches in the FedEx server response.|
|Matches||Collection of address candidates that meet the search criteria.|
|Phone||Phone number for which nearby FedEx locations are to be found.|
|Proxy||A set of properties related to proxy access.|
|SearchCriteria||The criteria to be used to find FedEx Locations.|
|SortCriteria||The criteria to be used to sort the results.|
|SSLAcceptServerCert||Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.|
|SSLCert||The certificate to be used during SSL negotiation.|
|SSLServerCert||The server certificate for the last established connection.|
|Timeout||A timeout for the component.|
|TotalLocationsFound||Specifies the total number of locations found.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting .|
|FindLocations||Finds FedEx location(s) based on the input data.|
|Reset||Resets the internal state of the component and all properties to their default values.|
|ValidateAddress||Returns corrected and standardized address information.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Error||Information about errors during data delivery.|
|Notification||Notification returned by the server upon successful request (if applicable).|
|SSLServerAuthentication||Fired after the server presents its certificate to the client.|
|SSLStatus||Shows the progress of the secure connection.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|RawRequest||Contains the complete request sent to the Server.|
|RawResponse||Contains the complete response returned by the Server.|
|XPath||Used to set the XPath within the response from the server.|
|HasXPath||Determines whether a specific element exists in the document.|
|XParent||The parent of the current element.|
|XElement||The name of the current element.|
|XText||The text of the current element.|
|XChildCount||The number of records in the XChild arrays.|
|XChildElement[i]||The name of the indexed child element.|
|XChildText[i]||The text of the indexed child element.|
|XAttrCount||The number of records in the XAttr arrays.|
|XAttrName[i]||The name of the indexed attribute.|
|XAttrValue[i]||The value of the indexed attribute.|
|Warning||Warning message returned by the server.|
|CSPUserKey||CSP end user key.|
|CSPUserPassword||CSP end user password.|
|CSPProductId||Identifies the CSP product.|
|CSPProductVersion||Identifies the CSP product version.|
|UseSOAP||Determines if the FedEx SOAP web services are used instead of the FedEx XML web services.|
|CustomContent||Defines any custom content to print on the label.|
|EstimateDelivery||Determines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.|
|AcceptEncoding||Used to tell the server which types of content encodings the client supports.|
|AllowHTTPCompression||This property enables HTTP compression for receiving data.|
|AllowHTTPFallback||Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.|
|AllowNTLMFallback||Whether to allow fallback from Negotiate to NTLM when authenticating.|
|Append||Whether to append data to LocalFile.|
|Authorization||The Authorization string to be sent to the server.|
|BytesTransferred||Contains the number of bytes transferred in the response data.|
|EncodeURL||If set to true the URL will be encoded by the component.|
|FollowRedirects||Determines what happens when the server issues a redirect.|
|GetOn302Redirect||If set to true the component will perform a GET on the new location.|
|HTTPVersion||The version of HTTP used by the component.|
|HTTP2HeadersWithoutIndexing||HTTP2 headers that should not update the dynamic header table with incremental indexing.|
|IfModifiedSince||A date determining the maximum age of the desired document.|
|KeepAlive||Determines whether the HTTP connection is closed after completion of the request.|
|LogLevel||The level of detail that is logged.|
|MaxHeaders||Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.|
|MaxHTTPCookies||Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.|
|MaxRedirectAttempts||Limits the number of redirects that are followed in a request.|
|NegotiatedHTTPVersion||The negotiated HTTP version.|
|OtherHeaders||Other headers as determined by the user (optional).|
|ProxyAuthorization||The authorization string to be sent to the proxy server.|
|ProxyAuthScheme||The authorization scheme to be used for the proxy.|
|ProxyPassword||A password if authentication is to be used for the proxy.|
|ProxyPort||Port for the proxy server (default 80).|
|ProxyServer||Name or IP address of a proxy server (optional).|
|ProxyUser||A user name if authentication is to be used for the proxy.|
|TransferredData||The contents of the last response from the server.|
|TransferredDataLimit||The maximum number of incoming bytes to be stored by the component.|
|TransferredHeaders||The full set of headers as received from the server.|
|UseChunkedEncoding||Enables or Disables HTTP chunked encoding for transfers.|
|ChunkSize||Specifies the chunk size in bytes when using chunked encoding.|
|UsePlatformHTTPClient||Whether or not to use the platform HTTP client.|
|UserAgent||Information about the user agent (browser).|
|KerberosSPN||The Service Principal Name for the Kerberos Domain Controller.|
|ConnectionTimeout||Sets a separate timeout value for establishing a connection.|
|FirewallAutoDetect||Tells the component whether or not to automatically detect and use firewall system settings, if available.|
|FirewallHost||Name or IP address of firewall (optional).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|FirewallPassword||Password to be used if authentication is to be used when connecting through the firewall.|
|FirewallPort||The TCP port for the FirewallHost;.|
|FirewallType||Determines the type of firewall to connect through.|
|FirewallUser||A user name if authentication is to be used connecting through a firewall.|
|KeepAliveTime||The inactivity time in milliseconds before a TCP keep-alive packet is sent.|
|KeepAliveInterval||The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.|
|Linger||When set to True, connections are terminated gracefully.|
|LingerTime||Time in seconds to have the connection linger.|
|LocalHost||The name of the local host through which connections are initiated or accepted.|
|LocalPort||The port in the local host where the component binds.|
|MaxLineLength||The maximum amount of data to accumulate when no EOL is found.|
|MaxTransferRate||The transfer rate limit in bytes per second.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|LogSSLPackets||Controls whether SSL packets are logged when using the internal security API.|
|ReuseSSLSession||Determines if the SSL session is reused.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|SSLEnabledProtocols||Used to enable/disable the supported security protocols.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|AbsoluteTimeout||Determines whether timeouts are inactivity timeouts or absolute timeouts.|
|FirewallData||Used to send extra data to the firewall.|
|InBufferSize||The size in bytes of the incoming queue of the socket.|
|OutBufferSize||The size in bytes of the outgoing queue of the socket.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|UseBackgroundThread||Whether threads created by the component are background threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|