Data Dictionary for Smile Shield
| Fields | Description |
|---|---|
| result.riskScore.value | Payment default risk score. Higher values indicate a greater likelihood of payment default. |
| result.riskScore.range.min | Minimum possible value for the risk score. Always 1. |
| result.riskScore.range.max | Maximum possible value for the risk score. Always 999. |
| result.riskScore.interpretation | Indicates scoring direction. Value: higher_is_riskier. |
| result.riskScore.reasonCodes[n].rank | Ordinal position of this reason code (1 = most influential). |
| result.riskScore.reasonCodes[n].code | Five-digit code. Codes beginning 00 increased risk; codes beginning 10 reduced risk. |
| result.riskScore.reasonCodes[n].description | Human-readable description of the reason code. |
| result.riskScore.reasonCodes[n].effect | Whether this code increased or reduced the risk score. Values: increased_risk | reduced_risk. |
| result.digitalIdentity.overallScore | Overall confidence score across all attribute pair scores. Higher = greater confidence = lower risk. |
| result.digitalIdentity.confidenceLevel | Textual confidence band: Very High Confidence | High Confidence | Moderate Confidence | Low Confidence | Very Low Confidence | null. |
| result.digitalIdentity.pairScores.emailToFullName | Confidence that email address and full name are associated. |
| result.digitalIdentity.pairScores.emailToLastName | Confidence that email address and last name are associated. |
| result.digitalIdentity.pairScores.emailToPhone | Confidence that email address and phone number are associated. |
| result.digitalIdentity.pairScores.emailToBillingAddress | Confidence that email address and billing address are associated. |
| result.digitalIdentity.pairScores.emailToIp | Confidence that email address and IP address are associated. |
| result.digitalIdentity.pairScores.emailToShippingAddress | Confidence that email address and shipping address are associated. |
| result.digitalIdentity.pairScores.ipToFullName | Confidence that IP address and full name are associated. |
| result.digitalIdentity.pairScores.ipToLastName | Confidence that IP address and last name are associated. |
| result.digitalIdentity.pairScores.ipToPhone | Confidence that IP address and phone number are associated. |
| result.digitalIdentity.pairScores.ipToBillingAddress | Confidence that IP address and billing address are associated. |
| result.digitalIdentity.pairScores.ipToShippingAddress | Confidence that IP address and shipping address are associated. |
| result.digitalIdentity.pairScores.phoneToFullName | Confidence that phone number and full name are associated. |
| result.digitalIdentity.pairScores.phoneToLastName | Confidence that phone number and last name are associated. |
| result.digitalIdentity.pairScores.phoneToBillingAddress | Confidence that phone number and billing address are associated. |
| result.digitalIdentity.pairScores.phoneToShippingAddress | Confidence that phone number and shipping address are associated. |
| result.digitalIdentity.pairScores.billingAddressToFullName | Confidence that billing address and full name are associated. |
| result.digitalIdentity.pairScores.billingAddressToLastName | Confidence that billing address and last name are associated. |
| result.digitalIdentity.pairScores.shippingAddressToBillingAddress | Confidence that shipping and billing addresses are associated. |
| result.digitalIdentity.pairScores.shippingAddressToFullName | Confidence that shipping address and full name are associated. |
| result.digitalIdentity.pairScores.shippingAddressToLastName | Confidence that shipping address and last name are associated. |
| result.phoneIntelligence.countryCode | International dialling country code (excludes +). Determined by Smile Shield from the submitted phoneNumber. |
| result.phoneIntelligence.geo | ISO 3166-1 alpha-2 country code for the phone number's country, as determined by Smile Shield. |
| result.phoneIntelligence.type | Type of phone number as determined by Smile Shield. Values: MOBILE | FIXED_LINE | FIXED_LINE_OR_MOBILE | VOIP | TOLL_FREE | PAGER | PERSONAL_NUMBER | VOICE_MAIL | |
| result.phoneIntelligence.isPossible | Whether the submitted phone number is structurally possible, as determined by Smile Shield. |
| result.phoneIntelligence.isValid | Whether the submitted phone number is valid and dialable, as determined by Smile Shield. |
| result.emailIntelligence.exists | Whether the queried email address exists. 1=Yes | 2=No | 3=Not Anymore | 4=Not Sure. |
| result.emailIntelligence.firstSeenDate | Oldest date found for records associated with this email address. |
| result.emailIntelligence.firstSeenDays | Number of days since this email address was first seen in the intelligence network. |
| result.emailIntelligence.ownerName | Name of the person associated with this email address, if known. |
| result.emailIntelligence.ownerNameMatch | Whether the email owner name matches the provided applicant name. 1=Full Match | 2=Partial | 3=No Match | 4=Owner Unknown | null=missing values. |
| result.emailIntelligence.velocity7Days | Number of times this email address was seen in the intelligence network in the last 7 days. |
| result.emailIntelligence.previouslySeenWithIp | Whether this email has been previously seen with the applicant's IP address. |
| result.emailIntelligence.previouslySeenWithName | Whether this email has been previously seen with the applicant's full name. |
| result.emailIntelligence.previouslySeenWithPhone | Whether this email has been previously seen with the applicant's phone number. |
| result.emailIntelligence.multipleDevicesForEmail | Whether multiple distinct devices have been seen with this email address. |
| result.emailIntelligence.multipleNamesForEmail | Whether multiple distinct full names have been seen with this email address. |
| result.emailIntelligence.multiplePhonesForEmail | Whether multiple distinct phone numbers have been seen with this email address. |
| result.emailIntelligence.fraudType | Type of fraud last flagged for this email address in the contributory intelligence network. Null if never flagged. |
| result.emailIntelligence.nonEarlyPaymentDefaultFraudFlag | Whether this email has been associated with non-payment-default fraud in the contributory network. |
| result.domainIntelligence.name | Domain name of the email address. |
| result.domainIntelligence.exists | Whether the email domain exists. 1=Yes | 2=No | 3=Not Anymore | 4=Not Sure. |
| result.domainIntelligence.company | Company that owns the email domain. May be REDACTED FOR PRIVACY. |
| result.domainIntelligence.country | Country in which the domain is registered. |
| result.domainIntelligence.createdDate | Date the domain was created or first seen. ISO 8601 UTC format. |
| result.domainIntelligence.ageDays | Number of days since the domain was created. |
| result.domainIntelligence.categoryCode | Category type code for the domain's associated company. Null if unavailable. |
| result.deviceIntelligence.deviceId | Smile Shield persistent device identifier using cookies and local storage. |
| result.deviceIntelligence.deviceIdConfidence | Probability of device match. Value of 100 when matched or newly generated. |
| result.deviceIntelligence.firstSeenDate | Date this device was first encountered in the intelligence network. |
| result.deviceIntelligence.firstSeenDays | Number of days since this device was first seen in the network. |
| result.deviceIntelligence.lastEventDate | Date of the last event or transaction associated with this device. |
| result.deviceIntelligence.lastUpdatedDate | Date on which the device record was last updated. |
| result.deviceIntelligence.matchResult | Device match result. Values: success | new_device | not_enough_attribs. |
| result.deviceIntelligence.result | Result of the device ID search. Values: success | not found. |
| result.deviceIntelligence.riskScore | Risk score for this device, between +100 (low risk) and -100 (high risk). |
| result.deviceIntelligence.worstRiskScore | Lowest risk score ever reached by this device. |
| result.deviceIntelligence.newLocation | Whether the device IP was geolocated to a different location than last seen. |
| result.deviceIntelligence.velocity30Days | Number of times this device has been seen in the last 30 days, capped at 120. |
| result.deviceIntelligence.proxyDetected | Whether the device was detected as using a proxy server. |
| result.deviceIntelligence.seenWithBlocklistedIp | Whether this device and IP have been seen in a consortium block list. |
| result.deviceIntelligence.multipleEmailsForDevice | Whether multiple distinct emails have been seen with this device. |
| result.deviceIntelligence.fuzzy.deviceId | Smile Shield cookieless device identifier based on device attributes alone. |
| result.deviceIntelligence.fuzzy.deviceIdConfidence | Probability that the fuzzy device ID represents the same device. |
| result.deviceIntelligence.fuzzy.firstSeenDate | Date the fuzzy device was first encountered. |
| result.deviceIntelligence.fuzzy.lastEventDate | Date of last event for the fuzzy device. |
| result.deviceIntelligence.fuzzy.lastUpdatedDate | Date the fuzzy device record was last updated. |
| result.deviceIntelligence.fuzzy.matchResult | Fuzzy device match result. Values: success | new_device | not_enough_attribs. |
| result.deviceIntelligence.fuzzy.result | Result of the fuzzy device lookup. Values: success | not found. |
| result.deviceIntelligence.fuzzy.riskScore | Risk score for the fuzzy device entity. |
| result.deviceIntelligence.fuzzy.worstRiskScore | Lowest risk score ever reached by the fuzzy device. |
| result.networkIntelligence.trueIp.address | True client IP address as detected by Smile Shield. |
| result.networkIntelligence.trueIp.city | City of the true IP address. |
| result.networkIntelligence.trueIp.region | Region of the true IP address. |
| result.networkIntelligence.trueIp.postalCode | Postal code of the true IP address. |
| result.networkIntelligence.trueIp.country | Country of the true IP address. |
| result.networkIntelligence.trueIp.latitude | Latitude of the true IP geolocation. |
| result.networkIntelligence.trueIp.longitude | Longitude of the true IP geolocation. |
| result.networkIntelligence.trueIp.isp | Internet Service Provider of the true IP address. |
| result.networkIntelligence.trueIp.organization | Organization associated with the true IP address. |
| result.networkIntelligence.trueIp.connectionType | Internet connection type (e.g. dsl, cable, mobile wireless). |
| result.networkIntelligence.trueIp.lineSpeed | Connection speed: high | medium | low. |
| result.networkIntelligence.trueIp.routingType | How the connection is routed through the internet. |
| result.networkIntelligence.trueIp.isHome | Whether the IP is judged to be a home-based connection. |
| result.networkIntelligence.trueIp.firstSeenDate | Date this IP was first seen in the network. |
| result.networkIntelligence.trueIp.lastEventDate | Date of last event for this IP address. |
| result.networkIntelligence.trueIp.lastUpdatedDate | Date this IP record was last updated. |
| result.networkIntelligence.trueIp.riskScore | Risk score for this IP, between +100 (low risk) and -100 (high risk). |
| result.networkIntelligence.trueIp.worstRiskScore | Lowest risk score ever reached by this IP address. |
| result.networkIntelligence.trueIp.result | Result of the IP lookup. Values: success | not found. |
| result.networkIntelligence.trueIp.sourcePort | Source port of the true IP connection. |
| result.networkIntelligence.inputIp.address | IP address as submitted in the API request. |
| result.networkIntelligence.inputIp.city | City of the input IP. |
| result.networkIntelligence.inputIp.region | Region of the input IP. |
| result.networkIntelligence.inputIp.postalCode | Postal code of the input IP. |
| result.networkIntelligence.inputIp.country | Country of the input IP (ISO 3166-1 alpha-2). |
| result.networkIntelligence.inputIp.latitude | Latitude of the input IP geolocation. |
| result.networkIntelligence.inputIp.longitude | Longitude of the input IP geolocation. |
| result.networkIntelligence.inputIp.isp | ISP of the input IP address. |
| result.networkIntelligence.inputIp.organization | Organization of the input IP address. |
| result.networkIntelligence.inputIp.connectionType | Connection type of the input IP. |
| result.networkIntelligence.inputIp.lineSpeed | Connection speed of the input IP. |
| result.networkIntelligence.inputIp.routingType | Routing type of the input IP. |
| result.networkIntelligence.inputIp.isHome | Whether the input IP is a home-based connection. |
| result.networkIntelligence.inputIp.firstSeenDate | Date the input IP was first seen in the network. |
| result.networkIntelligence.inputIp.lastEventDate | Date of last event for the input IP. |
| result.networkIntelligence.inputIp.lastUpdatedDate | Date the input IP record was last updated. |
| result.networkIntelligence.inputIp.riskScore | Risk score for the input IP. |
| result.networkIntelligence.inputIp.worstRiskScore | Worst risk score for the input IP. |
| result.networkIntelligence.inputIp.result | Result of the input IP lookup. |
| result.networkIntelligence.callerIp.address | IP address of the calling application that made the API request. |
| result.networkIntelligence.callerIp.country | Country of the calling application IP address. |
| result.networkIntelligence.geoDiscrepancy | Whether the true IP geolocation differs from the input IP geolocation. |
| result.networkIntelligence.multipleEmailsForIp | Whether multiple distinct emails have been seen with the applicant IP address. |
| result.networkIntelligence.multipleEmailsForPhone | Whether multiple distinct emails have been seen with the applicant phone number. |
| result.sessionBehavior.timeOnPageMs | Time in milliseconds the applicant spent on the page with profiling tags. |
| result.sessionBehavior.unknownSession | Whether the device used to make the application could not be profiled. |
| result.policyEngine.version | Version of the Smile Shield policy engine that processed the request. |
| result.policyEngine.score | Calculated policy score (sum of rule risk weights). |
| result.policyEngine.reviewStatus | Review status mapped from policy score. Default: pass. |
| result.policyEngine.riskRating | Risk rating mapped from policy score. Default: neutral. |
| result.policyEngine.rules[n].ruleId | Unique identifier of the policy rule that triggered. |
| result.policyEngine.rules[n].reasonCode | Reason code label for the triggered rule. Value: Smile Shield. |
| result.policyEngine.rules[n].score | Score contribution of this rule. |
| Expires At (epoch ms) | Epoch milliseconds timestamp when this Smile Shield record expires. |