Download OpenAPI specification:Download
| clientId required | string (clientId) ^[a-zA-Z0-9]{1,64}$ Kount's unique identifier for a Client |
| useCase required | string (useCase) Enum: "walletinsights" "fraudinsights" "payerinsights" "inputvalidation" This flag determines the response payload. |
| deviceIds | Array of strings (deviceIds) Device identifiers. |
| phoneNumbers | Array of strings (phoneNumbers) Phone numbers for a customer's user (consumer). |
| emailAddresses | Array of strings <email> (emailAddresses) Email addresses for a consumer. |
Array of objects (nameAddresses) Name and Physical Address combinations for a consumer. | |
Array of objects (payments) Payments for a consumer. | |
| lookbackDays | string <uint64> (lookbackDays) Ignore data older than this many days. Undefined or 0 includes all data. |
{- "clientId": "900900",
- "useCase": "walletInsights",
- "deviceIds": [
- "576e8604ab68463cba81da72bbf6d42d",
- "d15e8604ab68463cba81da72bbf6a345"
], - "phoneNumbers": [
- "+12081234567",
- "+12089876543"
], - "emailAddresses": [
- "john.doe@example.com",
- "jane.doe@example.com"
], - "nameAddresses": [
- {
- "fullName": "string",
- "address": {
- "line1": "5813-5849 Quail Meadows Dr",
- "line2": "APT C",
- "city": "Poplar Bluff",
- "region": "CO",
- "postalCode": "63901",
- "plus4": "1234",
- "countryCode": "US"
}
}
], - "payments": [
- {
- "type": "NONE",
- "token": ""
}
], - "lookbackDays": "string"
}{- "bestMatchedIdentity": {
- "fraudInsights": {
- "scores": {
- "maxOmniscore": 0,
- "meanOmniscore": 0,
- "minOmniscore": 0,
- "identityStructureScore": {
- "structureScore": 0,
- "reasonCodes": [
- "string"
]
}, - "identityFraudScore": 0,
- "identityTrustworthinessScore": 0,
- "identityReasonCodes": [
- "string"
]
}, - "attributes": {
- "chargebacks": 0,
- "chargebackRatio": 0,
- "occurrenceMostCommonPaymentType": 0,
- "refunds": 0,
- "refundRatio": 0,
- "declineAuthRatio": 0,
- "declinesAuth": 0,
- "declinesNonAuth": 0,
- "declineNonAuthRatio": 0,
- "occurrence": 0,
- "occurrence30Days": 0,
- "dateFirstSeen": "string",
- "dateLastSeen": "string",
- "distinctMonths": 0,
- "distinctPaymentTypes": 0,
- "distinctBillAddresses": 0,
- "distinctBillCities": 0,
- "distinctBillCountryCodes": 0,
- "distinctBillEmails": 0,
- "distinctBillNames": 0,
- "distinctBillPhones": 0,
- "distinctBillPostalCodes": 0,
- "distinctBillStates": 0,
- "distinctBins": 0,
- "distinctCurrencies": 0,
- "distinctDates": 0,
- "distinctDays": 0,
- "distinctIpAddresses": 0,
- "distinctLatLons": 0,
- "distinctMerchantIds": 0,
- "distinctPaymentTokens": 0,
- "distinctQuarters": 0,
- "distinctShipAddresses": 0,
- "distinctShipCities": 0,
- "distinctShipCountryCodes": 0,
- "distinctShipEmails": 0,
- "distinctShipNames": 0,
- "distinctShipPhones": 0,
- "distinctShipPostalCodes": 0,
- "distinctShipStates": 0,
- "distinctWeeks": 0,
- "distinctYears": 0,
- "occurrenceMostCommonBillAddress": 0,
- "occurrenceMostCommonBillName": 0,
- "occurrenceMostCommonBillEmail": 0,
- "occurrenceMostCommonBillPhone": 0,
- "occurrenceMostCommonBillCity": 0,
- "occurrenceMostCommonBillCountryCode": 0,
- "occurrenceMostCommonBillPostalCode": 0,
- "occurrenceMostCommonBillState": 0,
- "occurrenceMostCommonBin": 0,
- "occurrenceMostCommonCurrency": 0,
- "occurrenceMostCommonIpAddress": 0,
- "occurrenceMostCommonLatLon": 0,
- "occurrenceMostCommonMerchantId": 0,
- "occurrenceMostCommonPaymentToken": 0,
- "occurrenceMostCommonShipAddress": 0,
- "occurrenceMostCommonShipCity": 0,
- "occurrenceMostCommonShipCountryCode": 0,
- "occurrenceMostCommonShipEmail": 0,
- "occurrenceMostCommonShipName": 0,
- "occurrenceMostCommonShipPhone": 0,
- "occurrenceMostCommonShipPostalCode": 0,
- "occurrenceMostCommonShipState": 0,
- "daysSinceFirstSeen": 0,
- "daysSinceLastSeen": 0,
- "occurrenceWeekday": 0,
- "occurrenceWeekend": 0,
- "proportionWeekday": 0,
- "proportionWeekend": 0
}
}, - "payerInsights": {
- "scores": {
- "identityConsistencyScore": 0,
- "identityUsageScore": 0,
- "identityRecurrenceScore": 0
}, - "attributes": {
- "totalDollarAmount": 0,
- "meanMeanCostOfUniqueItemsInCart": 0,
- "meanMeanItemCostOfCart": 0,
- "meanCartSize": 0,
- "meanDollarAmount": 0,
- "meanStdevCostOfUniqueItemsInCart": 0,
- "meanStdevItemCostOfCart": 0,
- "meanUniqueItemsInCart": 0,
- "fewestUniqueItemsInCart": 0,
- "largestMeanCostOfUniqueItemsInCart": 0,
- "largestMeanItemCostOfCart": 0,
- "largestCartSize": 0,
- "largestStdevCostOfUniqueItemsInCart": 0,
- "largestStdevItemCostOfCart": 0,
- "leastExpensiveItemBoughtCost": 0,
- "maxDollarAmount": 0,
- "minDollarAmount": 0,
- "mostCommonCartSize": 0,
- "mostCommonCurrency": "string",
- "distinctDollarAmounts": 0,
- "occurrenceMostCommonDollarAmount": 0,
- "mostCommonDollarAmount": 0,
- "mostCommonUniqueItemsInCart": 0,
- "mostExpensiveItemBoughtCost": 0,
- "mostUniqueItemsInCart": 0,
- "smallestMeanCostOfUniqueItemsInCart": 0,
- "smallestMeanItemCostOfCart": 0,
- "smallestCartSize": 0,
- "smallestStdevCostOfUniqueItemsInCart": 0,
- "smallestStdevItemCostOfCart": 0
}
}, - "walletInsights": {
- "financialDurabilityIndex": {
- "value": 0
}, - "affluenceIndex": {
- "value": 0
}, - "spendingPower": {
- "value": 0
}, - "economicCohorts": {
- "value": "string"
}, - "income360": {
- "value": 0
}
}
}, - "inputValidation": {
- "summary": {
- "numIdentities": 0,
- "numValidatedKeys": 0,
- "numPrimaryKeys": 0
}, - "emailAddresses": [
- {
- "input": "string",
- "standardized": "string",
- "matchedIdentity": 0,
- "validated": true,
- "primary": true
}
], - "phoneNumbers": [
- {
- "input": "string",
- "standardized": "string",
- "matchedIdentity": 0,
- "validated": true,
- "primary": true
}
], - "addresses": [
- {
- "input": {
- "line1": "5813-5849 Quail Meadows Dr",
- "line2": "APT C",
- "city": "Poplar Bluff",
- "region": "CO",
- "postalCode": "63901",
- "plus4": "1234",
- "countryCode": "US"
}, - "standardized": {
- "line1": "5813-5849 Quail Meadows Dr",
- "line2": "APT C",
- "city": "Poplar Bluff",
- "region": "CO",
- "postalCode": "63901",
- "plus4": "1234",
- "countryCode": "US"
}, - "matchedIdentity": 0,
- "validated": true,
- "primary": true
}
], - "names": [
- {
- "input": "string",
- "standardized": "string",
- "matchedIdentity": 0,
- "validated": true,
- "primary": true
}
], - "payments": [
- {
- "input": {
- "type": "NONE",
- "token": ""
}, - "standardized": {
- "type": "NONE",
- "token": ""
}, - "matchedIdentity": 0,
- "validated": true,
- "primary": true
}
], - "deviceIds": [
- {
- "input": "string",
- "standardized": "string",
- "matchedIdentity": 0,
- "validated": true,
- "primary": true
}
]
}
}