Verification Plus Hygiene 6

Transcription

1 Verification Plus Hygiene 6 WSDL: Product Web Page: Description: Verification with Hygiene combines our state of the art Verification algorithms with Hygiene algorithms to allow our customers to detect and avoid known or potentially dangerous addresses or domains. Note: In this document you will notice that some status codes are labeled as potentially dangerous. This label is a result of the Hygiene component of our processing. Caution should be used when ing to addresses labeled as potentially dangerous. Please see the section below on Hygiene Results for more information. Required License Information: The LicenseInfo parameter in our Web services provides the authentication credentials to allow the user to invoke the web service. If you are currently unregistered with StrikeIron, use your address in the UnregisteredUser field. If you are registered with StrikeIron, use the UserID and Password associated with your StrikeIron account in the UserID and Password fields. Alternatively, you can also use your license key obtained from My StrikeIron with the password blank. LicenseInfo Field: UnregisteredUser Input Address: LicenseInfo Field: RegisteredUser Input UserID: Password: License Subscription Information Output LicenseStatusCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation from the User ID and Password used for input. Valid license codes are, 1, and 2. For example, a valid User ID and Password returns the code with a corresponding LicenseStatus value of Valid license key. LicenseStatus: This field returns the status of the StrikeIron User ID and Password corresponding to the LicenseStatusCode. LicenseActionCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation. GetRemainingHits returns the code 5 with a corresponding LicenseAction value of Get remaining hits. LicenseAction: This field returns the license action taken as a result of invoking this operation from the User ID and Password used corresponding to the LicenseActionCode. RemainingHits: This field returns the number of hits against the StrikeIron license key used when invoking this operation. Amount: This field returns the number of hits used from the StrikeIron User ID provided to invoke this operation. [email protected] [email protected] Password1 Valid license key Decremented hit count 2 Verification with Hygiene Page 1

2 Available Operations: Verify GetReasonCodes GetStatusCodesForMethod GetStatusCodes GetServiceInfo GetRemainingHits Operation: Verify Input Type the address you would like to verify. Required. Timeout: Enter the amount of time, in seconds you would like the service to continue searching for the address. Amount of time must be between 1 and 9 seconds. Required. OptionalSourceId: Optional Id returned with result as SourceIdentifier [email protected] 1 Source1 Operation: Verify Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes) StatusDescription: This field returns the description of the status number. (See GetStatusCodes) 2 Valid Operation: Verify Output (ServiceResult) Reason: Code: Reason code is associated with a Reason Description and is a subset of a Status Number and Description to further describe the response of the request. Reason: Description: Reason Description will describe the Response of the Request further and is a subset of a Status Number and Description. SourceIdentifier: value input in OptionalSourceId parameter This field returns the address you entered. LocalPart: This field returns the local part of the address. DomainPart: This field returns the domain name. IronStandardCertifiedTimestamp: This field returns the date and the time that the address was checked against real-time data DomainKnowledge Key Value pairs of domain information Key: Value: AddressKnowledge Key Value pairs of address information Key: Value: Hygiene Result: result of the Hygiene routine Net Protect the Domain Protected by a third party Net Protected By Third party protecting the domain 21 Mailbox Confirmed Source1 [email protected] johndoe strikeiron.com T13:23:5.437 Disposable true Cached true Safe US true AppRiver Verification with Hygiene Page 2

3 Operation: GetReasonCodes Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays a list of the Reason Codes for the Verify () method that display in the ReasonCode and ReasonDescription fields. (No input required) Operation: GetReasonCodes Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes) StatusDescription: This field returns the description of the status number. (See GetStatusCodes) 2 Found Operation: GetReasonCodes Output (ServiceResult) Reason Code Reason Description 21 Mailbox Confirmed 22 User Account Confirmed 23 Mailbox Confirmed but Full 211 Server Will Accept 212 Unable to Verify At This Time 221 Timeout Too Short 222 Server Not Responding 223 Server Deferred 224 Server Throttled 225 Server Actively Rejected 226 Server Connection Lost 31 Symbol 32 Bad Domain in Syntax 33 Bad LocalPart Syntax 34 Domain Not Found 35 Not a Valid Mail Domain 36 Mail Domain is Non-Responsive 37 Mailbox Rejected 311 Trap Domain 41 is Required 42 Timeout must be greater than Verification with Hygiene Page 3

4 Operation: GetStatusCodesForMethod Input *MethodName: Input a method name to obtain a list of the Status Codes for that method that display in the StatusNbr and StatusDescription fields. Input options are: CheckForCellPhone, GetStatusCodesForMethod, GetStatusCodes, GetServiceInfo, and GetRemainingHits. Verify Operation: GetStatusCodesForMethod Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes) StatusDescription: This field returns the description of the status number. (See GetStatusCodes) 2 Found Operation: GetStatusCodesForMethod Output (ServiceResult) 2 Valid 21 Domain Confirmed 22 Analytics in Progress 25 Valid. Potentially Dangerous. 26 Domain Confirmed. Potentially Dangerous. 27 Analytics in Progress Potentially Dangerous. 3 Not Valid. 31 Not Verified. 4 Invalid Input. 5 Internal Error. Verification with Hygiene Page 4

5 Operation: GetStatusCodes Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays a list of the Status Codes for the Web service that display in the StatusNbr and StatusDescription fields. (No input required) Operation: GetStatusCodes Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes) StatusDescription: This field returns the description of the status number. (See GetStatusCodes) 2 Found Operation: GetStatusCodes Output (MethodStatusRecord) MethodName: Verify 2 Valid 21 Domain Confirmed 22 Analytics in Progress 25 Valid Potentially Dangerous. 26 Domain Confirmed. Potentially Dangerous. 27 Analytics in Progress Potentially Dangerous. 3 Not Valid. 31 Not Verified. 4 Invalid Input. 5 Internal Error. MethodName: GetReasonCode 2 Found MethodName: GetStatusCodesForMethod 2 Found 3 Not Found 4 Invalid Method Name 5 Internal Error MethodName: GetStatusCodes 2 Found 3 Not Found 5 Internal Error MethodName: GetServiceInfo 2 Found 3 Not Found 5 Internal Error Verification with Hygiene Page 5

6 Operation: GetServiceInfo Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays the last time the Web service source data was updated. (No input required) Operation: GetServiceInfo Output (ServiceStatus) StatusNbr: This field returns a status number related to the operation. StatusDescription: This field returns a description of the status number. 2 Found Operation: GetServiceInfo Output (ServiceInfoRecord) InfoKey: (For future development) InfoValue: (For future development) (none) (none) Operation: GetRemainingHits Input Note: The only input needed for this operation is the LicenseInfo data. (No input required) Operation: GetRemainingHits Output (SubscriptionInfo) LicenseStatusCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation from the User ID and Password used for input. Valid license codes are, 1, and 2. For example, a valid User ID and Password returns the code with a corresponding LicenseStatus value of Valid license key. LicenseStatus: This field returns the status of the StrikeIron User ID and Password corresponding to the LicenseStatusCode. LicenseActionCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation. GetRemainingHits returns the code 5 with a corresponding LicenseAction value of Get remaining hits. LicenseAction: This field returns the license action taken as a result of invoking this operation from the User ID and Password used corresponding to the LicenseActionCode. RemainingHits: This field returns the number of hits against the StrikeIron User ID and Password used when invoking this operation. Amount: This field returns the number of hits used from the StrikeIron User ID provided to invoke this operation. Valid license key Decremented hit count 2 GetRemainingHitsResponse: This field only returns subscription information. Verification with Hygiene Page 6

7 What is Analytics is Process? How do I handle this return code? Analytics in Process (AIP) is returned when a definitive Verification result cannot be reached and we believe further processing could determine a definitive result. When you receive this return code the StrikeIron infrastructure is continuing to attempt to resolve your submission. By calling the interface a second time (after a time delay) a definitive result may be available. One common reason for receiving this return code is that the timeout value you have specified is too short for the specified domain. For example, based on domain knowledge we expect gmail.com domains to take several seconds to reply. If you specified a timeout value less than our experience shows is possible, we will return AIP immediately instead of waiting for your call to time out. Another common reason for receiving this return code is that the target domain is a Grey List server. Grey listing is an attempt to discourage spam. Generally this means that a given server will refuse connections from other servers the first time they try to connect. After some time frame (this is server specific and may span a minute or two to twenty minutes or more) if the same server retries the connection it will be allowed. When you receive AIP our process will continue to attempt to resolve the address thus satisfying a grey list server. Verification with Hygiene Page 7

8 What are the Key Value Pairs and their values? The Key Value Pairs returned as part of the verification result allow us to provide more information for certain addresses / domains. These values are NOT an enumerated type and StrikeIron reserves the right to add additional information. Code that is written to process these Key Value Pairs should accommodate this fact. The following Key Value Pairs are currently being returned: Key Type Key Key Value Description DomainKnowledge Disposable True Domain is known to provide disposable addresses Potentially Vulgar True Domain portion of address is potentially vulgar or offensive AddressKnowledge Possible Correction Domain suggestion The domain suggestion could be used to replace the current domain information in this address. Note that all best practices should be observed prior to using the combination of the suggested domain and the local portion of the address as an actual address. Role-Based True The address is commonly associated with a role instead of a specific user Potentially Vulgar True The local part of this address is potentially vulgar or offensive Possible Disposable True Local part of the address follows known patterns of disposable addresses for the specified domain Cached True This result was returned from the StrikeIron result cache. Note that the IronStandardCertifiedTimeSt Verification with Hygiene Page 8

9 What do the various Hygiene Results mean? Safe US - this address is based in the US and is safe. Safe International - this address is based internationally and is safe. Invalid - this address has been determined to be invalid by the hygiene processing. The hygiene process determines an address / domain to be invalid based on information like a domain being parked. The domain may have resources and indicate that s are valid, but s to this domain are unlikely to be received by a real person. Spam Trap - this address / domain has been determined to be a spam trap or honey pot by the hygiene processing. ing these addresses may result in damage to your reputation. Mole - this address / domain shows historical evidence of being associated with submissions to spam tracking services. Former Trap - this address / domain has been previously identified as a spam trap, but at this time would be considered safe if the process did not consider historical evidence. Seed - seed addresses are third party oversight addresses specifically used for monitoring resources, many times for deliverability monitoring. Also included in this category are any litigious addresses, those who seed their address for the sole purpose of litigation. Habitual complainers, those who have an extremely high rate of spam complaints are included in this category as well. Pattern Match - this status uses typical key words, phrases, or patterns that are used for trap purposes. Also included in this category are role based addresses that typically are not delivered to a specific person such as info, support or sales. Unknown - this address / domain did not result in a specific hygiene result. The most common cause of this return value is a timeout during hygiene processing. Verification with Hygiene Page 9

10 What is Net Protect and what do the various codes mean? A Net Protected domain uses a third party service or appliance to filter and detect spam . The rules for determining what is considered as spam by these networks could vary widely. The following codes identify which service or appliance is monitoring a given network: AppRiver Barracuda Google/Postini-McAfeeASAP.com Ironport NAI-McAfee Outblaze Securence Symantec-BrightMail Symantec- MessageLabs SymantecMail Invalument ZeroSpam.ca RBLSMTPD CommTouch CloudMark Government, Military,.edu,.us Red Condor SaaS MaySoft SpamSentinel SaaS WebSense SaaS Trend Micro SaaS Verification with Hygiene Page 1