curl --request POST \ --url https://east.sandbox.spade.com/transactions/report \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: <api-key>' \ --data @- <<EOF{ "enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "errorDescription": "Enrichment has an incorrect location. Wrong postal code.", "incorrectLocation": true, "incorrectLocationDescription": "The location's city is incorrect.", "incorrectCategory": false, "incorrectCategoryDescription": "The category returned is incorrect.", "incorrectChannel": false, "incorrectChannelDescription": "The spending channel should have been physical.", "incorrectCounterparty": false, "incorrectCounterpartyDescription": "The counterparty is incorrect.", "incorrectLogo": false, "incorrectLogoDescription": "The logo shown is outdated.", "incorrectWebsite": false, "incorrectWebsiteDescription": "The website redirects to a 404.", "incorrectPhoneNumber": false, "incorrectPhoneNumberDescription": "The phone number is disconnected."}EOF
import requests
url = "https://east.sandbox.spade.com/transactions/report"
payload = {
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errorDescription": "Enrichment has an incorrect location. Wrong postal code.",
"incorrectLocation": True,
"incorrectLocationDescription": "The location's city is incorrect.",
"incorrectCategory": False,
"incorrectCategoryDescription": "The category returned is incorrect.",
"incorrectChannel": False,
"incorrectChannelDescription": "The spending channel should have been physical.",
"incorrectCounterparty": False,
"incorrectCounterpartyDescription": "The counterparty is incorrect.",
"incorrectLogo": False,
"incorrectLogoDescription": "The logo shown is outdated.",
"incorrectWebsite": False,
"incorrectWebsiteDescription": "The website redirects to a 404.",
"incorrectPhoneNumber": False,
"incorrectPhoneNumberDescription": "The phone number is disconnected."
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enrichmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
errorDescription: 'Enrichment has an incorrect location. Wrong postal code.',
incorrectLocation: true,
incorrectLocationDescription: 'The location\'s city is incorrect.',
incorrectCategory: false,
incorrectCategoryDescription: 'The category returned is incorrect.',
incorrectChannel: false,
incorrectChannelDescription: 'The spending channel should have been physical.',
incorrectCounterparty: false,
incorrectCounterpartyDescription: 'The counterparty is incorrect.',
incorrectLogo: false,
incorrectLogoDescription: 'The logo shown is outdated.',
incorrectWebsite: false,
incorrectWebsiteDescription: 'The website redirects to a 404.',
incorrectPhoneNumber: false,
incorrectPhoneNumberDescription: 'The phone number is disconnected.'
})
};
fetch('https://east.sandbox.spade.com/transactions/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://east.sandbox.spade.com/transactions/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'enrichmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'errorDescription' => 'Enrichment has an incorrect location. Wrong postal code.',
'incorrectLocation' => true,
'incorrectLocationDescription' => 'The location\'s city is incorrect.',
'incorrectCategory' => false,
'incorrectCategoryDescription' => 'The category returned is incorrect.',
'incorrectChannel' => false,
'incorrectChannelDescription' => 'The spending channel should have been physical.',
'incorrectCounterparty' => false,
'incorrectCounterpartyDescription' => 'The counterparty is incorrect.',
'incorrectLogo' => false,
'incorrectLogoDescription' => 'The logo shown is outdated.',
'incorrectWebsite' => false,
'incorrectWebsiteDescription' => 'The website redirects to a 404.',
'incorrectPhoneNumber' => false,
'incorrectPhoneNumberDescription' => 'The phone number is disconnected.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://east.sandbox.spade.com/transactions/report"
payload := strings.NewReader("{\n \"enrichmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"errorDescription\": \"Enrichment has an incorrect location. Wrong postal code.\",\n \"incorrectLocation\": true,\n \"incorrectLocationDescription\": \"The location's city is incorrect.\",\n \"incorrectCategory\": false,\n \"incorrectCategoryDescription\": \"The category returned is incorrect.\",\n \"incorrectChannel\": false,\n \"incorrectChannelDescription\": \"The spending channel should have been physical.\",\n \"incorrectCounterparty\": false,\n \"incorrectCounterpartyDescription\": \"The counterparty is incorrect.\",\n \"incorrectLogo\": false,\n \"incorrectLogoDescription\": \"The logo shown is outdated.\",\n \"incorrectWebsite\": false,\n \"incorrectWebsiteDescription\": \"The website redirects to a 404.\",\n \"incorrectPhoneNumber\": false,\n \"incorrectPhoneNumberDescription\": \"The phone number is disconnected.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://east.sandbox.spade.com/transactions/report")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrichmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"errorDescription\": \"Enrichment has an incorrect location. Wrong postal code.\",\n \"incorrectLocation\": true,\n \"incorrectLocationDescription\": \"The location's city is incorrect.\",\n \"incorrectCategory\": false,\n \"incorrectCategoryDescription\": \"The category returned is incorrect.\",\n \"incorrectChannel\": false,\n \"incorrectChannelDescription\": \"The spending channel should have been physical.\",\n \"incorrectCounterparty\": false,\n \"incorrectCounterpartyDescription\": \"The counterparty is incorrect.\",\n \"incorrectLogo\": false,\n \"incorrectLogoDescription\": \"The logo shown is outdated.\",\n \"incorrectWebsite\": false,\n \"incorrectWebsiteDescription\": \"The website redirects to a 404.\",\n \"incorrectPhoneNumber\": false,\n \"incorrectPhoneNumberDescription\": \"The phone number is disconnected.\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://east.sandbox.spade.com/transactions/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrichmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"errorDescription\": \"Enrichment has an incorrect location. Wrong postal code.\",\n \"incorrectLocation\": true,\n \"incorrectLocationDescription\": \"The location's city is incorrect.\",\n \"incorrectCategory\": false,\n \"incorrectCategoryDescription\": \"The category returned is incorrect.\",\n \"incorrectChannel\": false,\n \"incorrectChannelDescription\": \"The spending channel should have been physical.\",\n \"incorrectCounterparty\": false,\n \"incorrectCounterpartyDescription\": \"The counterparty is incorrect.\",\n \"incorrectLogo\": false,\n \"incorrectLogoDescription\": \"The logo shown is outdated.\",\n \"incorrectWebsite\": false,\n \"incorrectWebsiteDescription\": \"The website redirects to a 404.\",\n \"incorrectPhoneNumber\": false,\n \"incorrectPhoneNumberDescription\": \"The phone number is disconnected.\"\n}"
response = http.request(request)
puts response.read_body
Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, incorrectCounterpartyDescription, incorrectLogo, incorrectLogoDescription, incorrectWebsite, incorrectWebsiteDescription, incorrectPhoneNumber, and incorrectPhoneNumberDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.
POST
/
transactions
/
report
Report a card enrichment as incorrect
curl --request POST \ --url https://east.sandbox.spade.com/transactions/report \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: <api-key>' \ --data @- <<EOF{ "enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "errorDescription": "Enrichment has an incorrect location. Wrong postal code.", "incorrectLocation": true, "incorrectLocationDescription": "The location's city is incorrect.", "incorrectCategory": false, "incorrectCategoryDescription": "The category returned is incorrect.", "incorrectChannel": false, "incorrectChannelDescription": "The spending channel should have been physical.", "incorrectCounterparty": false, "incorrectCounterpartyDescription": "The counterparty is incorrect.", "incorrectLogo": false, "incorrectLogoDescription": "The logo shown is outdated.", "incorrectWebsite": false, "incorrectWebsiteDescription": "The website redirects to a 404.", "incorrectPhoneNumber": false, "incorrectPhoneNumberDescription": "The phone number is disconnected."}EOF
import requests
url = "https://east.sandbox.spade.com/transactions/report"
payload = {
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errorDescription": "Enrichment has an incorrect location. Wrong postal code.",
"incorrectLocation": True,
"incorrectLocationDescription": "The location's city is incorrect.",
"incorrectCategory": False,
"incorrectCategoryDescription": "The category returned is incorrect.",
"incorrectChannel": False,
"incorrectChannelDescription": "The spending channel should have been physical.",
"incorrectCounterparty": False,
"incorrectCounterpartyDescription": "The counterparty is incorrect.",
"incorrectLogo": False,
"incorrectLogoDescription": "The logo shown is outdated.",
"incorrectWebsite": False,
"incorrectWebsiteDescription": "The website redirects to a 404.",
"incorrectPhoneNumber": False,
"incorrectPhoneNumberDescription": "The phone number is disconnected."
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enrichmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
errorDescription: 'Enrichment has an incorrect location. Wrong postal code.',
incorrectLocation: true,
incorrectLocationDescription: 'The location\'s city is incorrect.',
incorrectCategory: false,
incorrectCategoryDescription: 'The category returned is incorrect.',
incorrectChannel: false,
incorrectChannelDescription: 'The spending channel should have been physical.',
incorrectCounterparty: false,
incorrectCounterpartyDescription: 'The counterparty is incorrect.',
incorrectLogo: false,
incorrectLogoDescription: 'The logo shown is outdated.',
incorrectWebsite: false,
incorrectWebsiteDescription: 'The website redirects to a 404.',
incorrectPhoneNumber: false,
incorrectPhoneNumberDescription: 'The phone number is disconnected.'
})
};
fetch('https://east.sandbox.spade.com/transactions/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://east.sandbox.spade.com/transactions/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'enrichmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'errorDescription' => 'Enrichment has an incorrect location. Wrong postal code.',
'incorrectLocation' => true,
'incorrectLocationDescription' => 'The location\'s city is incorrect.',
'incorrectCategory' => false,
'incorrectCategoryDescription' => 'The category returned is incorrect.',
'incorrectChannel' => false,
'incorrectChannelDescription' => 'The spending channel should have been physical.',
'incorrectCounterparty' => false,
'incorrectCounterpartyDescription' => 'The counterparty is incorrect.',
'incorrectLogo' => false,
'incorrectLogoDescription' => 'The logo shown is outdated.',
'incorrectWebsite' => false,
'incorrectWebsiteDescription' => 'The website redirects to a 404.',
'incorrectPhoneNumber' => false,
'incorrectPhoneNumberDescription' => 'The phone number is disconnected.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://east.sandbox.spade.com/transactions/report"
payload := strings.NewReader("{\n \"enrichmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"errorDescription\": \"Enrichment has an incorrect location. Wrong postal code.\",\n \"incorrectLocation\": true,\n \"incorrectLocationDescription\": \"The location's city is incorrect.\",\n \"incorrectCategory\": false,\n \"incorrectCategoryDescription\": \"The category returned is incorrect.\",\n \"incorrectChannel\": false,\n \"incorrectChannelDescription\": \"The spending channel should have been physical.\",\n \"incorrectCounterparty\": false,\n \"incorrectCounterpartyDescription\": \"The counterparty is incorrect.\",\n \"incorrectLogo\": false,\n \"incorrectLogoDescription\": \"The logo shown is outdated.\",\n \"incorrectWebsite\": false,\n \"incorrectWebsiteDescription\": \"The website redirects to a 404.\",\n \"incorrectPhoneNumber\": false,\n \"incorrectPhoneNumberDescription\": \"The phone number is disconnected.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://east.sandbox.spade.com/transactions/report")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrichmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"errorDescription\": \"Enrichment has an incorrect location. Wrong postal code.\",\n \"incorrectLocation\": true,\n \"incorrectLocationDescription\": \"The location's city is incorrect.\",\n \"incorrectCategory\": false,\n \"incorrectCategoryDescription\": \"The category returned is incorrect.\",\n \"incorrectChannel\": false,\n \"incorrectChannelDescription\": \"The spending channel should have been physical.\",\n \"incorrectCounterparty\": false,\n \"incorrectCounterpartyDescription\": \"The counterparty is incorrect.\",\n \"incorrectLogo\": false,\n \"incorrectLogoDescription\": \"The logo shown is outdated.\",\n \"incorrectWebsite\": false,\n \"incorrectWebsiteDescription\": \"The website redirects to a 404.\",\n \"incorrectPhoneNumber\": false,\n \"incorrectPhoneNumberDescription\": \"The phone number is disconnected.\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://east.sandbox.spade.com/transactions/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrichmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"errorDescription\": \"Enrichment has an incorrect location. Wrong postal code.\",\n \"incorrectLocation\": true,\n \"incorrectLocationDescription\": \"The location's city is incorrect.\",\n \"incorrectCategory\": false,\n \"incorrectCategoryDescription\": \"The category returned is incorrect.\",\n \"incorrectChannel\": false,\n \"incorrectChannelDescription\": \"The spending channel should have been physical.\",\n \"incorrectCounterparty\": false,\n \"incorrectCounterpartyDescription\": \"The counterparty is incorrect.\",\n \"incorrectLogo\": false,\n \"incorrectLogoDescription\": \"The logo shown is outdated.\",\n \"incorrectWebsite\": false,\n \"incorrectWebsiteDescription\": \"The website redirects to a 404.\",\n \"incorrectPhoneNumber\": false,\n \"incorrectPhoneNumberDescription\": \"The phone number is disconnected.\"\n}"
response = http.request(request)
puts response.read_body
"Enrichment has an incorrect location. Wrong postal code."
incorrectLocation
boolean
Bool indicating if the enrichment has a wrong location.
Example:
true
incorrectLocationDescription
string
Description of incorrect location details in enrichment.
Maximum string length: 1024
Example:
"The location's city is incorrect."
incorrectCategory
boolean
Bool indicating if the enrichment has a wrong Category.
Example:
false
incorrectCategoryDescription
string
Description of incorrect category details in enrichment.
Maximum string length: 1024
Example:
"The category returned is incorrect."
incorrectChannel
boolean
Bool indicating if the enrichment has a wrong Channel.
Example:
false
incorrectChannelDescription
string
Description of incorrect channel details in enrichment.
Maximum string length: 1024
Example:
"The spending channel should have been physical."
incorrectCounterparty
boolean
A boolean indicating if the enrichment has an incorrect merchant name or identity. Use incorrectLogo, incorrectWebsite, or incorrectPhoneNumber instead for issues limited to those specific attributes.
Example:
false
incorrectCounterpartyDescription
string
Description of the incorrect merchant name or identity in the enrichment.
Maximum string length: 1024
Example:
"The counterparty is incorrect."
incorrectLogo
boolean
A boolean indicating if the enrichment has a wrong logo.
Example:
false
incorrectLogoDescription
string
Description of incorrect logo details in enrichment.
Maximum string length: 1024
Example:
"The logo shown is outdated."
incorrectWebsite
boolean
A boolean indicating if the enrichment has a wrong website.
Example:
false
incorrectWebsiteDescription
string
Description of incorrect website details in enrichment.
Maximum string length: 1024
Example:
"The website redirects to a 404."
incorrectPhoneNumber
boolean
A boolean indicating if the enrichment has a wrong phone number.
Example:
false
incorrectPhoneNumberDescription
string
Description of incorrect phone number details in enrichment.
Outcome of a reviewed error report, delivered via the callback configured with Spade. Carries the enrichment response fields at the top level, in the same shape as the original card enrichment response, alongside fields describing the report's outcome.
errorReportId
string<uuid>
required
The error report id, matching the errorReportId returned when the report was submitted.
Example:
"8e21c6a4-2f3d-4b7a-9c1e-5d6f0a9b7c3e"
status
enum<string>
required
Whether the report was accepted with a correction, or rejected.
Available options:
accepted,
rejected
correctedData
object
required
The enrichment response reflecting the outcome: the corrected data when status is accepted, or the original unchanged enrichment when status is rejected (a rejection means the original enrichment was verified correct). Never null.
Show child attributes
transactionInfo
object
Show child attributes
enrichmentId
string<uuid>
Our ID representing the enrichment, not to be confused with your provided transactionId.
counterparty
object[]
An array of counterparties matched to the transaction, ordered by descending match score.
Show child attributes
mobileAppInfo
object | null
The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.
Show child attributes
customAttributes
object
A dictionary containing the custom attributes that were included in the enrichment request (if any).
Set when status is rejected; null when accepted. Treat as a growing enum, not an exhaustive list. When the underlying reason is other, this carries the reviewer's free-text description instead of the literal code other.
Example:
"location_correct_spade_verified"
Response
Your server returns this code if it accepts the callback
Response
Enrichment reported successfully
Response for reporting an enriched transaction.
errorReportId
string<uuid>
Error report id represented as a string UUID.
Example:
"8e21c6a4-2f3d-4b7a-9c1e-5d6f0a9b7c3e"
details
string
Example:
"Enrichment Successfully Reported."
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Introduction","colors":{"primary":"#18280E","light":"#F4FAED","dark":"#18280E"},"logo":{"light":"https://mintcdn.com/spade-90e401c6/9HF3Uca9kExHiocb/images/spade-logo-forest.png?fit=max\u0026auto=format\u0026n=9HF3Uca9kExHiocb\u0026q=85\u0026s=04ad3c1e3f4529c5d6c370e693e44807","dark":"https://mintcdn.com/spade-90e401c6/9HF3Uca9kExHiocb/images/spade-logo-sage1.png?fit=max\u0026auto=format\u0026n=9HF3Uca9kExHiocb\u0026q=85\u0026s=f93791318e444084093f74b94e701ccb"},"favicon":"https://mintcdn.com/spade-90e401c6/9HF3Uca9kExHiocb/images/spade-icon-forest.png?fit=max\u0026auto=format\u0026n=9HF3Uca9kExHiocb\u0026q=85\u0026s=7f5578906c65a61f1d6e07d31e2e7771","background":{"color":{"dark":"#090F05"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spade-90e401c6","hasAudioNarration":false,"actualSubdomain":"spade-90e401c6","customDomains":["docs.spade.com"],"gitSource":{"type":"github","owner":"spade-data","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea6151fbc6161119141877","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Documentation","count":27},{"language":"default","tag":"Category Action Triggers","count":16},{"language":"default","tag":"Category Personalization","count":16},{"language":"default","tag":"Merchant Action Triggers","count":16},{"language":"default","tag":"Enrichment Guides","count":10},{"language":"default","tag":"Card Enrichment","count":10},{"language":"default","tag":"Tooling Guides","count":7},{"language":"default","tag":"More","count":6},{"language":"default","tag":"Feedback and Reporting","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect","slug":"/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect","pageMetadata":{"title":"Report a card enrichment as incorrect","description":"Endpoint to report a card enrichment as incorrect. An `enrichmentId` and an `errorDescription` are required fields to report an enrichment. Optional request fields such as `incorrectLocation`, `incorrectLocationDescription`, `incorrectCategory`, `incorrectCategoryDescription`, `incorrectChannel`, `incorrectChannelDescription`, `incorrectCounterparty`, `incorrectCounterpartyDescription`, `incorrectLogo`, `incorrectLogoDescription`, `incorrectWebsite`, `incorrectWebsiteDescription`, `incorrectPhoneNumber`, and `incorrectPhoneNumberDescription`, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\n","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/report","href":"/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Endpoint to report a card enrichment as incorrect. An \", _jsx(_components.code, {\n children: \"enrichmentId\"\n }), \" and an \", _jsx(_components.code, {\n children: \"errorDescription\"\n }), \" are required fields to report an enrichment. Optional request fields such as \", _jsx(_components.code, {\n children: \"incorrectLocation\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectLocationDescription\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectCategory\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectCategoryDescription\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectChannel\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectChannelDescription\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectCounterparty\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectCounterpartyDescription\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectLogo\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectLogoDescription\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectWebsite\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectWebsiteDescription\"\n }), \", \", _jsx(_components.code, {\n children: \"incorrectPhoneNumber\"\n }), \", and \", _jsx(_components.code, {\n children: \"incorrectPhoneNumberDescription\"\n }), \", can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Report a card enrichment as incorrect","description":"Endpoint to report a card enrichment as incorrect. An `enrichmentId` and an `errorDescription` are required fields to report an enrichment. Optional request fields such as `incorrectLocation`, `incorrectLocationDescription`, `incorrectCategory`, `incorrectCategoryDescription`, `incorrectChannel`, `incorrectChannelDescription`, `incorrectCounterparty`, `incorrectCounterpartyDescription`, `incorrectLogo`, `incorrectLogoDescription`, `incorrectWebsite`, `incorrectWebsiteDescription`, `incorrectPhoneNumber`, and `incorrectPhoneNumberDescription`, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\n","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/report","href":"/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Endpoint to report a card enrichment as incorrect. An `enrichmentId` and an `errorDescription` are required fields to report an enrichment. Optional request fields such as `incorrectLocation`, `incorrectLocationDescription`, `incorrectCategory`, `incorrectCategoryDescription`, `incorrectChannel`, `incorrectChannelDescription`, `incorrectCounterparty`, `incorrectCounterpartyDescription`, `incorrectLogo`, `incorrectLogoDescription`, `incorrectWebsite`, `incorrectWebsiteDescription`, `incorrectPhoneNumber`, and `incorrectPhoneNumberDescription`, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\n","tags":["Feedback and Reporting"],"summary":"Report a card enrichment as incorrect","operationId":"cardReport","requestBody":"bca408ff-7e10-4cf5-9093-7828ec185d90","responses":{"200":"22c5df76-35e2-4efe-80e6-81f381c939c4","400":"72aabf1f-94c5-4987-bb1d-c024a45c632a","403":"137725f2-b2b7-4be3-b343-353462f27190","500":"b4306108-2adb-457a-b465-490effcea413"},"callbacks":{"CorrectedEnrichment":"b520d123-b315-4326-83ef-e0878c5e94af"},"method":"post","type":"path","servers":["c9d2cfa9-0678-4340-a214-cc7cb1b9b638","95df7017-26fe-4d52-9462-83df4bb283e4","4fe8877e-267b-490a-bca6-770866e5257e","b6f28a59-992c-4046-80b3-36d6eb62fc2b"],"security":["10917285-e513-4c82-ae36-297a8d030eca"],"path":"/transactions/report","baseUrlOptions":["https://east.sandbox.spade.com","https://east.api.spade.com","https://west.sandbox.spade.com","https://west.api.spade.com"],"title":"Report a card enrichment as incorrect","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Schema for reporting an enriched transaction.","required":["errorDescription","enrichmentId"],"properties":{"enrichmentId":{"type":"string","format":"uuid","description":"Enrichment id represented as a string UUID.","isRequired":true,"uniqueKey":"enrichmentId","typeLabel":"string\u003cuuid>"},"errorDescription":{"type":"string","description":"Description of incorrect details in enrichment.","maxLength":1024,"examples":["Enrichment has an incorrect location. Wrong postal code."],"isRequired":true,"uniqueKey":"errorDescription","typeLabel":"string"},"incorrectLocation":{"type":"boolean","description":"Bool indicating if the enrichment has a wrong location.","examples":[true],"uniqueKey":"incorrectLocation","typeLabel":"boolean"},"incorrectLocationDescription":{"type":"string","description":"Description of incorrect location details in enrichment.","maxLength":1024,"examples":["The location's city is incorrect."],"uniqueKey":"incorrectLocationDescription","typeLabel":"string"},"incorrectCategory":{"type":"boolean","description":"Bool indicating if the enrichment has a wrong Category.","examples":[false],"uniqueKey":"incorrectCategory","typeLabel":"boolean"},"incorrectCategoryDescription":{"type":"string","description":"Description of incorrect category details in enrichment.","maxLength":1024,"examples":["The category returned is incorrect."],"uniqueKey":"incorrectCategoryDescription","typeLabel":"string"},"incorrectChannel":{"type":"boolean","description":"Bool indicating if the enrichment has a wrong Channel.","examples":[false],"uniqueKey":"incorrectChannel","typeLabel":"boolean"},"incorrectChannelDescription":{"type":"string","description":"Description of incorrect channel details in enrichment.","maxLength":1024,"examples":["The spending channel should have been physical."],"uniqueKey":"incorrectChannelDescription","typeLabel":"string"},"incorrectCounterparty":{"type":"boolean","description":"A boolean indicating if the enrichment has an incorrect merchant name or identity. Use `incorrectLogo`, `incorrectWebsite`, or `incorrectPhoneNumber` instead for issues limited to those specific attributes.\n","examples":[false],"uniqueKey":"incorrectCounterparty","typeLabel":"boolean"},"incorrectCounterpartyDescription":{"type":"string","description":"Description of the incorrect merchant name or identity in the enrichment.","maxLength":1024,"examples":["The counterparty is incorrect."],"uniqueKey":"incorrectCounterpartyDescription","typeLabel":"string"},"incorrectLogo":{"type":"boolean","description":"A boolean indicating if the enrichment has a wrong logo.","examples":[false],"uniqueKey":"incorrectLogo","typeLabel":"boolean"},"incorrectLogoDescription":{"type":"string","description":"Description of incorrect logo details in enrichment.","maxLength":1024,"examples":["The logo shown is outdated."],"uniqueKey":"incorrectLogoDescription","typeLabel":"string"},"incorrectWebsite":{"type":"boolean","description":"A boolean indicating if the enrichment has a wrong website.","examples":[false],"uniqueKey":"incorrectWebsite","typeLabel":"boolean"},"incorrectWebsiteDescription":{"type":"string","description":"Description of incorrect website details in enrichment.","maxLength":1024,"examples":["The website redirects to a 404."],"uniqueKey":"incorrectWebsiteDescription","typeLabel":"string"},"incorrectPhoneNumber":{"type":"boolean","description":"A boolean indicating if the enrichment has a wrong phone number.","examples":[false],"uniqueKey":"incorrectPhoneNumber","typeLabel":"boolean"},"incorrectPhoneNumberDescription":{"type":"string","description":"Description of incorrect phone number details in enrichment.","maxLength":1024,"examples":["The phone number is disconnected."],"uniqueKey":"incorrectPhoneNumberDescription","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"enrichmentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","errorDescription":"Enrichment has an incorrect location. Wrong postal code.","incorrectLocation":true,"incorrectLocationDescription":"The location's city is incorrect.","incorrectCategory":false,"incorrectCategoryDescription":"The category returned is incorrect.","incorrectChannel":false,"incorrectChannelDescription":"The spending channel should have been physical.","incorrectCounterparty":false,"incorrectCounterpartyDescription":"The counterparty is incorrect.","incorrectLogo":false,"incorrectLogoDescription":"The logo shown is outdated.","incorrectWebsite":false,"incorrectWebsiteDescription":"The website redirects to a 404.","incorrectPhoneNumber":false,"incorrectPhoneNumberDescription":"The phone number is disconnected."}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"22c5df76-35e2-4efe-80e6-81f381c939c4":{"description":"Enrichment reported successfully","content":{"application/json":{"schema":{"type":"object","description":"Response for reporting an enriched transaction.","properties":{"errorReportId":{"type":"string","format":"uuid","description":"Error report id represented as a string UUID.","examples":["8e21c6a4-2f3d-4b7a-9c1e-5d6f0a9b7c3e"],"uniqueKey":"errorReportId","typeLabel":"string\u003cuuid>"},"details":{"type":"string","examples":["Enrichment Successfully Reported."],"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorReportId":"8e21c6a4-2f3d-4b7a-9c1e-5d6f0a9b7c3e","details":"Enrichment Successfully Reported."}}},"exampleType":"generated"}},"exampleType":"generated"},"72aabf1f-94c5-4987-bb1d-c024a45c632a":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"invalidField":{"type":"array","items":{"type":"string","examples":["This field is required."],"uniqueKey":"invalidField.items.[INDEX]","typeLabel":"string"},"uniqueKey":"invalidField","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"invalidField":["This field is required."]}}},"exampleType":"generated"}},"exampleType":"generated"},"137725f2-b2b7-4be3-b343-353462f27190":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"details":{"type":"string","examples":["Incorrect authentication credentials."],"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"details":"Incorrect authentication credentials."}}},"exampleType":"generated"}},"exampleType":"generated"},"b4306108-2adb-457a-b465-490effcea413":{"description":"Unexpected Error","content":{"application/json":{"schema":{"type":"object","properties":{"details":{"type":"string","examples":["Internal server error."],"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"details":"Internal server error."}}},"exampleType":"generated"}},"exampleType":"generated"}},"callbacks":[{"callbackName":"CorrectedEnrichment","expression":"https://example.com/your/callback/endpoint","method":"post","resolved":{"operation":{"description":"In order to receive a corrected enrichment, you need to set a callback url with Spade. This url must be in HTTPS protocol and return a 2XX response upon success. To verify a payload is from Spade, you can verify that the token from `X-Webhook-Token` (in the request header) matches the token you receive from Spade.\n","requestBody":"28742316-281b-402f-8f1a-a9e0fa501fcc","responses":{"200":"229ed0de-130a-4c8e-97f4-62445cf9c074","400":"74d8d493-09ab-497b-9cd1-0b35c8de8b1c","403":"c0c53837-f7cd-4ab5-9475-14e119800331","500":"0eeaea4b-c584-49b4-b82f-d74136bf1d21"},"method":"post","type":"path"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Outcome of a reviewed error report, delivered via the callback configured with Spade. Carries the enrichment response fields at the top level, in the same shape as the original card enrichment response, alongside fields describing the report's outcome.\n","required":["errorReportId","status","correctedData"],"properties":{"errorReportId":{"type":"string","format":"uuid","description":"The error report id, matching the `errorReportId` returned when the report was submitted.","examples":["8e21c6a4-2f3d-4b7a-9c1e-5d6f0a9b7c3e"],"isRequired":true,"uniqueKey":"errorReportId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["accepted","rejected"],"description":"Whether the report was accepted with a correction, or rejected.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"correctedData":{"type":"object","description":"The enrichment response reflecting the outcome: the corrected data when `status` is `accepted`, or the original unchanged enrichment when `status` is `rejected` (a rejection means the original enrichment was verified correct). Never `null`.\n","properties":{"transactionInfo":{"type":"object","properties":{"transferInfo":{"oneOf":[{"type":"object","description":"Additional information about transfers. This field is `null` for card transactions.","example":null,"properties":{"direction":{"type":"string","maxLength":12,"enum":["outgoing","incoming"],"description":"The transfer direction.","examples":["outgoing"],"uniqueKey":"correctedData.transactionInfo.transferInfo.oneOf.0.direction","typeLabel":"enum\u003cstring>"},"transferMethod":{"type":"string","maxLength":12,"enum":["ach","cash","check","intrabank","rtp","unknown","wire"],"description":"The transfer method.","examples":["ach"],"uniqueKey":"correctedData.transactionInfo.transferInfo.oneOf.0.transferMethod","typeLabel":"enum\u003cstring>"},"transferType":{"type":"string","maxLength":12,"enum":["external","internal","unknown"],"description":"The transfer type. \"external\" indicates that money is being sent to an external counterparty. \"internal\" indicates that money is being moved between accounts owned by the same entity.","examples":["external"],"uniqueKey":"correctedData.transactionInfo.transferInfo.oneOf.0.transferType","typeLabel":"enum\u003cstring>"},"isAdjustmentOrRefund":{"type":"boolean","description":"Whether the transfer is an adjustment or refund.","examples":[false],"uniqueKey":"correctedData.transactionInfo.transferInfo.oneOf.0.isAdjustmentOrRefund","typeLabel":"boolean"}},"uniqueKey":"correctedData.transactionInfo.transferInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional information about transfers. This field is `null` for card transactions.","example":null,"properties":{"direction":{"type":"string","maxLength":12,"enum":["outgoing","incoming"],"description":"The transfer direction.","examples":["outgoing"]},"transferMethod":{"type":"string","maxLength":12,"enum":["ach","cash","check","intrabank","rtp","unknown","wire"],"description":"The transfer method.","examples":["ach"]},"transferType":{"type":"string","maxLength":12,"enum":["external","internal","unknown"],"description":"The transfer type. \"external\" indicates that money is being sent to an external counterparty. \"internal\" indicates that money is being moved between accounts owned by the same entity.","examples":["external"]},"isAdjustmentOrRefund":{"type":"boolean","description":"Whether the transfer is an adjustment or refund.","examples":[false]}},"uniqueKey":"correctedData.transactionInfo.transferInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.transferInfo","typeLabel":"object | null"},"isAccountVerification":{"oneOf":[{"type":"boolean","description":"Whether the transfer is an account verification. Currently only available for transfers.","example":false,"uniqueKey":"correctedData.transactionInfo.isAccountVerification.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the transfer is an account verification. Currently only available for transfers.","example":false,"uniqueKey":"correctedData.transactionInfo.isAccountVerification.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.isAccountVerification","typeLabel":"boolean | null"},"isPeerToPeer":{"oneOf":[{"type":"boolean","description":"Whether the transaction is a peer-to-peer transaction. Currently only available for transfers.","example":false,"uniqueKey":"correctedData.transactionInfo.isPeerToPeer.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the transaction is a peer-to-peer transaction. Currently only available for transfers.","example":false,"uniqueKey":"correctedData.transactionInfo.isPeerToPeer.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.isPeerToPeer","typeLabel":"boolean | null"},"isDigitalWallet":{"oneOf":[{"type":"boolean","description":"Whether the transaction involves a digital wallet. Currently only available for transfers.","example":false,"uniqueKey":"correctedData.transactionInfo.isDigitalWallet.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the transaction involves a digital wallet. Currently only available for transfers.","example":false,"uniqueKey":"correctedData.transactionInfo.isDigitalWallet.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.isDigitalWallet","typeLabel":"boolean | null"},"type":{"type":"string","description":"The main type of the transaction. For card transactions, the type is always \"spending\".","enum":["account_verification","atm","debt","fee","income","other_money_movement","reimbursement","spending"],"examples":["spending"],"uniqueKey":"correctedData.transactionInfo.type","typeLabel":"enum\u003cstring>"},"subType":{"oneOf":[{"type":"string","description":"The more specific type of the transaction, if applicable. For card transactions, the `subType` is always `null`.","enum":["alimony_or_child_support","atm","bnpl","business","cash_advance","deposit","disbursements","earned_income","government_benefits","insurance","investment","nsf","other","overdraft","payment","payout","rental","retirement","tax_refund","transfer","withdrawal"],"examples":[null],"uniqueKey":"correctedData.transactionInfo.subType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The more specific type of the transaction, if applicable. For card transactions, the `subType` is always `null`.","enum":["alimony_or_child_support","atm","bnpl","business","cash_advance","deposit","disbursements","earned_income","government_benefits","insurance","investment","nsf","other","overdraft","payment","payout","rental","retirement","tax_refund","transfer","withdrawal"],"examples":[null],"uniqueKey":"correctedData.transactionInfo.subType.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.subType","typeLabel":"enum\u003cstring> | null"},"display":{"oneOf":[{"type":"object","description":"An object containing display information for the transaction. The fields in this object are pulled from other parts of the enrichment and surfaced here for convenience.\n","properties":{"name":{"type":"string","maxLength":64,"description":"The best name for display.","examples":["Amazon"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.name","typeLabel":"string"},"categoryName":{"oneOf":[{"type":"string","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.categoryName.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.categoryName.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.categoryName","typeLabel":"string | null"},"graphic":{"oneOf":[{"type":"string","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.graphic.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.graphic.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.graphic","typeLabel":"string\u003curl> | null"},"graphicSource":{"oneOf":[{"type":"string","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.graphicSource.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.graphicSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.display.oneOf.0.graphicSource","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"correctedData.transactionInfo.display.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing display information for the transaction. The fields in this object are pulled from other parts of the enrichment and surfaced here for convenience.\n","properties":{"name":{"type":"string","maxLength":64,"description":"The best name for display.","examples":["Amazon"]},"categoryName":{"oneOf":[{"type":"string","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"]},{"type":"null","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"]}]},"graphic":{"oneOf":[{"type":"string","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"]},{"type":"null","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"]}]},"graphicSource":{"oneOf":[{"type":"string","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"]},{"type":"null","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"]}]}},"uniqueKey":"correctedData.transactionInfo.display.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.display","typeLabel":"object | null"},"thirdParties":{"type":"array","description":"An array of third parties involved in the transaction, when applicable. Entities such as Toast, Square, Uber Eats, Doordash, etc. will appear here.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","examples":["ac48cef2-0d7f-4159-865e-e92b152262bc"],"uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":64,"examples":["Paypal"],"uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["bnpl","delivery_service","marketplace","payment_processor","platform"],"examples":["payment_processor"],"uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"logo":{"oneOf":[{"type":"string","maxLength":128,"format":"url","examples":["https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png"],"description":"Third party logo.","uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].logo.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","maxLength":128,"format":"url","examples":["https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png"],"description":"Third party logo.","uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].logo","typeLabel":"string\u003curl> | null"},"website":{"oneOf":[{"type":"string","maxLength":256,"format":"url","examples":["https://www.paypal.com/"],"description":"Third party website.","uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].website.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","maxLength":256,"format":"url","examples":["https://www.paypal.com/"],"description":"Third party website.","uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].website.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX].website","typeLabel":"string\u003curl> | null"}},"uniqueKey":"correctedData.transactionInfo.thirdParties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"correctedData.transactionInfo.thirdParties","typeLabel":"object[]"},"spendingInfo":{"oneOf":[{"type":"object","description":"Additional information about transactions whose `type` is \"spending\". This field is `null` for other types of transactions.","properties":{"channel":{"type":"object","properties":{"value":{"oneOf":[{"type":"string","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine.","uniqueKey":"correctedData.transactionInfo.spendingInfo.oneOf.0.channel.value.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine.","uniqueKey":"correctedData.transactionInfo.spendingInfo.oneOf.0.channel.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.spendingInfo.oneOf.0.channel.value","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"correctedData.transactionInfo.spendingInfo.oneOf.0.channel","typeLabel":"object"}},"uniqueKey":"correctedData.transactionInfo.spendingInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional information about transactions whose `type` is \"spending\". This field is `null` for other types of transactions.","properties":{"channel":{"type":"object","properties":{"value":{"oneOf":[{"type":"string","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine."},{"type":"null","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine."}]}}}},"uniqueKey":"correctedData.transactionInfo.spendingInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.spendingInfo","typeLabel":"object | null"},"atmInfo":{"oneOf":[{"type":"object","description":"Additional information about ATM transactions. This field is `null` for other types of transactions.","examples":[null],"properties":{"sponsorName":{"type":"string","maxLength":64,"description":"The name of the sponsor of the ATM involved in the transaction.","examples":["Fiserv"],"uniqueKey":"correctedData.transactionInfo.atmInfo.oneOf.0.sponsorName","typeLabel":"string"},"ownerName":{"type":"string","maxLength":64,"description":"The name of the owner of the ATM involved in the transaction.","examples":["Wells Fargo"],"uniqueKey":"correctedData.transactionInfo.atmInfo.oneOf.0.ownerName","typeLabel":"string"}},"uniqueKey":"correctedData.transactionInfo.atmInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional information about ATM transactions. This field is `null` for other types of transactions.","examples":[null],"properties":{"sponsorName":{"type":"string","maxLength":64,"description":"The name of the sponsor of the ATM involved in the transaction.","examples":["Fiserv"]},"ownerName":{"type":"string","maxLength":64,"description":"The name of the owner of the ATM involved in the transaction.","examples":["Wells Fargo"]}},"uniqueKey":"correctedData.transactionInfo.atmInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.atmInfo","typeLabel":"object | null"},"transactionId":{"type":"string","maxLength":512,"description":"Your ID representing this transaction. This ID exactly matches the transactionId you provided in your enrichment request.","examples":["transaction_id_123456789"],"uniqueKey":"correctedData.transactionInfo.transactionId","typeLabel":"string"},"recurrenceInfo":{"oneOf":[{"type":"object","description":"A recurring transaction is a repeated payment pattern to a counterparty, based on periodicty and amount. Premium Spade Signal available depending on your product package.","properties":{"intervalType":{"oneOf":[{"type":"string","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence.","uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.intervalType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence.","uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.intervalType.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.intervalType","typeLabel":"enum\u003cstring> | null"},"intervalDays":{"oneOf":[{"type":"integer","description":"Number of days between recurrences.","examples":[30],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.intervalDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of days between recurrences.","examples":[30],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.intervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.intervalDays","typeLabel":"integer | null"},"nextPaymentExpected":{"oneOf":[{"type":"string","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.nextPaymentExpected.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.nextPaymentExpected.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.nextPaymentExpected","typeLabel":"string\u003cdate> | null"},"recentRecurrences":{"oneOf":[{"type":"array","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}},"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences.oneOf.0.items.[INDEX]","typeLabel":"array"},"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences.oneOf.0","typeLabel":"array[]"},{"type":"null","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}}},"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences","typeLabel":"array[] | null"}},"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"A recurring transaction is a repeated payment pattern to a counterparty, based on periodicty and amount. Premium Spade Signal available depending on your product package.","properties":{"intervalType":{"oneOf":[{"type":"string","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence."},{"type":"null","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence."}]},"intervalDays":{"oneOf":[{"type":"integer","description":"Number of days between recurrences.","examples":[30]},{"type":"null","description":"Number of days between recurrences.","examples":[30]}]},"nextPaymentExpected":{"oneOf":[{"type":"string","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"]},{"type":"null","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"]}]},"recentRecurrences":{"oneOf":[{"type":"array","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}}}},{"type":"null","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}}}}]}},"uniqueKey":"correctedData.transactionInfo.recurrenceInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.recurrenceInfo","typeLabel":"object | null"},"riskInsights":{"oneOf":[{"type":"object","description":"Risk insights provide visibility into the potential risk of a transaction and the merchants involved. Premium Spade Signal available depending on your product package.","properties":{"irregularWebPresenceDetected":{"oneOf":[{"type":"boolean","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.irregularWebPresenceDetected.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.irregularWebPresenceDetected.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.irregularWebPresenceDetected","typeLabel":"boolean | null"},"negativeOnlineSentiment":{"oneOf":[{"type":"boolean","description":"Negative online consumer feedback associated with the counterparty.","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.negativeOnlineSentiment.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Negative online consumer feedback associated with the counterparty.","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.negativeOnlineSentiment.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.negativeOnlineSentiment","typeLabel":"boolean | null"},"highRiskEntity":{"oneOf":[{"type":"boolean","description":"The counterparty is known to engage in fraudulent practices.","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.highRiskEntity.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The counterparty is known to engage in fraudulent practices.","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.highRiskEntity.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.highRiskEntity","typeLabel":"boolean | null"},"riskyIndustry":{"oneOf":[{"type":"boolean","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.riskyIndustry.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.riskyIndustry.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.riskyIndustry","typeLabel":"boolean | null"},"cardAcceptanceHistory":{"oneOf":[{"type":"string","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.cardAcceptanceHistory.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.cardAcceptanceHistory.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0.cardAcceptanceHistory","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.0","typeLabel":"object"},{"type":"null","description":"Risk insights provide visibility into the potential risk of a transaction and the merchants involved. Premium Spade Signal available depending on your product package.","properties":{"irregularWebPresenceDetected":{"oneOf":[{"type":"boolean","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false]},{"type":"null","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false]}]},"negativeOnlineSentiment":{"oneOf":[{"type":"boolean","description":"Negative online consumer feedback associated with the counterparty.","examples":[false]},{"type":"null","description":"Negative online consumer feedback associated with the counterparty.","examples":[false]}]},"highRiskEntity":{"oneOf":[{"type":"boolean","description":"The counterparty is known to engage in fraudulent practices.","examples":[false]},{"type":"null","description":"The counterparty is known to engage in fraudulent practices.","examples":[false]}]},"riskyIndustry":{"oneOf":[{"type":"boolean","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false]},{"type":"null","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false]}]},"cardAcceptanceHistory":{"oneOf":[{"type":"string","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"]},{"type":"null","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"]}]}},"uniqueKey":"correctedData.transactionInfo.riskInsights.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.transactionInfo.riskInsights","typeLabel":"object | null"}},"uniqueKey":"correctedData.transactionInfo","typeLabel":"object"},"enrichmentId":{"type":"string","format":"uuid","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","uniqueKey":"correctedData.enrichmentId","typeLabel":"string\u003cuuid>"},"counterparty":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"A unique identifier for this counterparty, regardless of specific location.","format":"uuid","example":"704bbd58-fb12-4bdb-9aae-2786704ea92a","uniqueKey":"correctedData.counterparty.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"A unique identifier for this counterparty, regardless of specific location.","format":"uuid","example":"704bbd58-fb12-4bdb-9aae-2786704ea92a","uniqueKey":"correctedData.counterparty.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","description":"Counterparty name.","maxLength":64,"example":"Amazon","uniqueKey":"correctedData.counterparty.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Counterparty name.","maxLength":64,"example":"Amazon","uniqueKey":"correctedData.counterparty.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].name","typeLabel":"string | null"},"legalName":{"oneOf":[{"type":"string","description":"Counterparty legal name.","maxLength":128,"example":"Amazon Inc.","uniqueKey":"correctedData.counterparty.items.[INDEX].legalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Counterparty legal name.","maxLength":128,"example":"Amazon Inc.","uniqueKey":"correctedData.counterparty.items.[INDEX].legalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].legalName","typeLabel":"string | null"},"industry":{"type":"array","items":{"type":"object","description":"A node in a tree representing a hierarchical category system","properties":{"id":{"type":"string","maxLength":15,"example":"011-000-000-000","uniqueKey":"correctedData.counterparty.items.[INDEX].industry.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","maxLength":64,"example":"Retail","uniqueKey":"correctedData.counterparty.items.[INDEX].industry.items.[INDEX].name","typeLabel":"string"},"icon":{"oneOf":[{"type":"string","description":"Category icon.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png","uniqueKey":"correctedData.counterparty.items.[INDEX].industry.items.[INDEX].icon.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","description":"Category icon.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png","uniqueKey":"correctedData.counterparty.items.[INDEX].industry.items.[INDEX].icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].industry.items.[INDEX].icon","typeLabel":"string\u003curl> | null"}},"uniqueKey":"correctedData.counterparty.items.[INDEX].industry.items.[INDEX]","typeLabel":"object"},"description":"Array with increasingly specific category information.","uniqueKey":"correctedData.counterparty.items.[INDEX].industry","typeLabel":"object[]"},"matchScore":{"oneOf":[{"type":"number","description":"The matchScore predicts how well a transaction matches a Counterparty in our records. If no Counterparty was found, the matchScore is set to null. Otherwise, scores range between 50.00 and 100.00. We filter out results below this range to make sure that only high quality matches are returned. Generally, the higher the matchScore is the better the match between a transaction and a Counterparty. When multiple Counterparties match a transaction, matches are returned in decreasing order of matchScore. This is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"correctedData.counterparty.items.[INDEX].matchScore.oneOf.0","typeLabel":"number"},{"type":"null","description":"The matchScore predicts how well a transaction matches a Counterparty in our records. If no Counterparty was found, the matchScore is set to null. Otherwise, scores range between 50.00 and 100.00. We filter out results below this range to make sure that only high quality matches are returned. Generally, the higher the matchScore is the better the match between a transaction and a Counterparty. When multiple Counterparties match a transaction, matches are returned in decreasing order of matchScore. This is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"correctedData.counterparty.items.[INDEX].matchScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].matchScore","typeLabel":"number | null"},"location":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"A unique identifier for this location.","format":"uuid","example":"fdf79470-3deb-4638-956a-6859e473b9d8","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"A unique identifier for this location.","format":"uuid","example":"fdf79470-3deb-4638-956a-6859e473b9d8","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"},"address":{"oneOf":[{"type":"string","description":"Street number, name, and any secondary address information.","maxLength":64,"example":"1234 W 5th Ave Suite 100","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number, name, and any secondary address information.","maxLength":64,"example":"1234 W 5th Ave Suite 100","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].address.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].address","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"type":"string","description":"Street number and name.","maxLength":64,"example":"1234 W 5th Ave","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number and name.","maxLength":64,"example":"1234 W 5th Ave","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","description":"Secondary address information.","maxLength":32,"example":"Suite 100","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary address information.","maxLength":32,"example":"Suite 100","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","maxLength":64,"example":"New York","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].city.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"example":"New York","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].city.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].city","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","description":"Region code. Typically a two-letter code for US states, but may vary for international regions.","maxLength":64,"example":"NY","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].region.oneOf.0","typeLabel":"string"},{"type":"null","description":"Region code. Typically a two-letter code for US states, but may vary for international regions.","maxLength":64,"example":"NY","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].region.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].region","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Three letter country code.","maxLength":3,"example":"USA","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Three letter country code.","maxLength":3,"example":"USA","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].country.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].country","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","description":"Location postal code or zip code.","maxLength":12,"example":"10001","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].postalCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Location postal code or zip code.","maxLength":12,"example":"10001","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].postalCode","typeLabel":"string | null"},"latitude":{"oneOf":[{"type":"number","description":"Location latitude.","example":45,"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].latitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"Location latitude.","example":45,"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].latitude","typeLabel":"number | null"},"longitude":{"oneOf":[{"type":"number","description":"Location longitude.","example":120,"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].longitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"Location longitude.","example":120,"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].longitude","typeLabel":"number | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Location phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Location phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].phoneNumber","typeLabel":"string | null"},"matchScore":{"oneOf":[{"type":"number","description":"The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location.\nThis is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].matchScore.oneOf.0","typeLabel":"number"},{"type":"null","description":"The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location.\nThis is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].matchScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX].matchScore","typeLabel":"number | null"}},"uniqueKey":"correctedData.counterparty.items.[INDEX].location.items.[INDEX]","typeLabel":"object"},"description":"Locations of this counterparty that matched the transaction. Currently contains only one location.\n","uniqueKey":"correctedData.counterparty.items.[INDEX].location","typeLabel":"object[]"},"logo":{"oneOf":[{"type":"string","description":"Counterparty logo.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","uniqueKey":"correctedData.counterparty.items.[INDEX].logo.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","description":"Counterparty logo.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","uniqueKey":"correctedData.counterparty.items.[INDEX].logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].logo","typeLabel":"string\u003curl> | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Counterparty phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"correctedData.counterparty.items.[INDEX].phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Counterparty phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"correctedData.counterparty.items.[INDEX].phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].phoneNumber","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","description":"Counterparty website.","format":"url","maxLength":256,"example":"https://www.amazon.com","uniqueKey":"correctedData.counterparty.items.[INDEX].website.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","description":"Counterparty website.","format":"url","maxLength":256,"example":"https://www.amazon.com","uniqueKey":"correctedData.counterparty.items.[INDEX].website.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].website","typeLabel":"string\u003curl> | null"},"possibleCounterpartyAlternate":{"oneOf":[{"type":"object","description":"The possible alternate counterparty object represents a counterparty that may be matched to this transaction in other enrichment requests.\nPremium Spade Field available depending on your product package.\n","properties":{"id":{"type":"string","description":"The ID of the alternate counterparty.\n","format":"uuid","example":"49fd51a1-5a19-3e5d-8d28-eb056ecf8939","uniqueKey":"correctedData.counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"similarity":{"type":"number","description":"The similarity score indicates how closely this alternate counterparty matches the main counterparty. The score is a value between 0.0 and 100.0, where 100.0 is an exact match.\n","example":80,"uniqueKey":"correctedData.counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.0.similarity","typeLabel":"number"}},"uniqueKey":"correctedData.counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.0","typeLabel":"object"},{"type":"null","description":"The possible alternate counterparty object represents a counterparty that may be matched to this transaction in other enrichment requests.\nPremium Spade Field available depending on your product package.\n","properties":{"id":{"type":"string","description":"The ID of the alternate counterparty.\n","format":"uuid","example":"49fd51a1-5a19-3e5d-8d28-eb056ecf8939"},"similarity":{"type":"number","description":"The similarity score indicates how closely this alternate counterparty matches the main counterparty. The score is a value between 0.0 and 100.0, where 100.0 is an exact match.\n","example":80}},"uniqueKey":"correctedData.counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.counterparty.items.[INDEX].possibleCounterpartyAlternate","typeLabel":"object | null"}},"uniqueKey":"correctedData.counterparty.items.[INDEX]","typeLabel":"object"},"description":"An array of counterparties matched to the transaction, ordered by descending match score.","uniqueKey":"correctedData.counterparty","typeLabel":"object[]"},"mobileAppInfo":{"oneOf":[{"description":"The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.\n","type":"object","properties":{"id":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"A unique identifier for this mobile app.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":512,"examples":["Roblox"],"description":"The name of the mobile app.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.name","typeLabel":"string"},"url":{"oneOf":[{"type":"string","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.url.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.mobileAppInfo.oneOf.0.url","typeLabel":"string\u003curl> | null"},"logo":{"oneOf":[{"type":"string","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.logo.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.mobileAppInfo.oneOf.0.logo","typeLabel":"string\u003curl> | null"},"developerName":{"type":"string","maxLength":256,"examples":["Roblox Corporation"],"description":"The name of the developer of the mobile app.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.developerName","typeLabel":"string"},"developerId":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"The ID of the developer of the mobile app.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.developerId","typeLabel":"string\u003cuuid>"},"category":{"type":"string","enum":["Auto and Transportation","Creative and Design","Education and Parenting","Entertainment and Media","Finance and Business","Games","Health and Lifestyle","Shopping and Marketplaces","Social and Communication","Travel and Events","Utility and Tools"],"examples":["Auto and Transportation"],"description":"The category of the mobile app.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.category","typeLabel":"enum\u003cstring>"},"hasGamblingOrRewards":{"type":"boolean","examples":[false],"description":"Whether the mobile app has gambling or cash rewards.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.hasGamblingOrRewards","typeLabel":"boolean"},"hasSimulatedGambling":{"type":"boolean","examples":[false],"description":"Whether the mobile app has simulated gambling.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.hasSimulatedGambling","typeLabel":"boolean"},"ageRating":{"type":"string","enum":["Children","Teen","Adult","Unknown"],"examples":["Teen"],"description":"The age rating of the mobile app.","uniqueKey":"correctedData.mobileAppInfo.oneOf.0.ageRating","typeLabel":"enum\u003cstring>"}},"uniqueKey":"correctedData.mobileAppInfo.oneOf.0","typeLabel":"object"},{"description":"The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.\n","type":"null","properties":{"id":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"A unique identifier for this mobile app."},"name":{"type":"string","maxLength":512,"examples":["Roblox"],"description":"The name of the mobile app."},"url":{"oneOf":[{"type":"string","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store."},{"type":"null","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store."}]},"logo":{"oneOf":[{"type":"string","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo."},{"type":"null","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo."}]},"developerName":{"type":"string","maxLength":256,"examples":["Roblox Corporation"],"description":"The name of the developer of the mobile app."},"developerId":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"The ID of the developer of the mobile app."},"category":{"type":"string","enum":["Auto and Transportation","Creative and Design","Education and Parenting","Entertainment and Media","Finance and Business","Games","Health and Lifestyle","Shopping and Marketplaces","Social and Communication","Travel and Events","Utility and Tools"],"examples":["Auto and Transportation"],"description":"The category of the mobile app."},"hasGamblingOrRewards":{"type":"boolean","examples":[false],"description":"Whether the mobile app has gambling or cash rewards."},"hasSimulatedGambling":{"type":"boolean","examples":[false],"description":"Whether the mobile app has simulated gambling."},"ageRating":{"type":"string","enum":["Children","Teen","Adult","Unknown"],"examples":["Teen"],"description":"The age rating of the mobile app."}},"uniqueKey":"correctedData.mobileAppInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.mobileAppInfo","typeLabel":"object | null"},"customAttributes":{"type":"object","description":"A dictionary containing the custom attributes that were included in the enrichment request (if any).","additionalProperties":{"type":"string","uniqueKey":"correctedData.customAttributes.additionalProperties","typeLabel":"string"},"examples":[{"custom_attribute_1":"value_1","custom_attribute_2":"value_2"}],"uniqueKey":"correctedData.customAttributes","typeLabel":"object"},"actions":{"oneOf":[{"type":"array","description":"An array of triggered actions, or `null` if no triggers matched.\nThis field is only present if your integration has the actions feature enabled.\n\nWhen a transaction matches one or more registered triggers, this array contains the action details including your custom `action` data.\n","items":{"type":"object","description":"A triggered action returned in the enrichment response.","properties":{"id":{"type":"string","maxLength":512,"description":"Your unique identifier for the matched trigger (as provided during registration).","examples":["trigger-12345"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of trigger that matched — `merchant_trigger` for merchant-based triggers, `category_trigger` for category-based triggers.","enum":["merchant_trigger","category_trigger"],"example":"merchant_trigger","examples":["merchant_trigger"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"action":{"type":"object","description":"The custom action data you provided during registration for this trigger.\n\nFor `BLOCK` and `ALLOW_ONLY` action types, an `authRecommendation` field is automatically added:\n- `BLOCK` triggers that match: `authRecommendation` is set to `\"BLOCK\"`.\n- `ALLOW_ONLY` triggers that match: `authRecommendation` is set to `\"ALLOW\"`.\n- `ALLOW_ONLY` triggers at a scope where no `ALLOW_ONLY` trigger matched: `authRecommendation` is set to `\"BLOCK\"`.\n\nOne enrichment can return several actions carrying different `authRecommendation` values. See [Resolving multiple actions](/reference/action-triggers-guide#resolving-multiple-actions).\n","additionalProperties":true,"properties":{"authRecommendation":{"type":"string","description":"Authorization recommendation injected for `BLOCK` and `ALLOW_ONLY` action types. Not present for other action types.","enum":["ALLOW","BLOCK"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].action.authRecommendation","typeLabel":"enum\u003cstring>"}},"examples":[{"type":"REWARD","rewardPercent":5,"offerId":"offer-abc123"},{"type":"BLOCK","reason":"Gambling merchant","authRecommendation":"BLOCK"},{"type":"ALLOW_ONLY","category":"approved-vendors","authRecommendation":"ALLOW"}],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].action","typeLabel":"object"},"scope":{"type":"string","description":"The scope at which this trigger was registered (account, program, user, or card).","enum":["account","program","user","card"],"example":"account","examples":["account"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"source":{"oneOf":[{"type":"string","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].source","typeLabel":"enum\u003cstring> | null"},"categoryId":{"type":"string","description":"The Spade category ID that matched this trigger. Only present when `type` is `category_trigger`.","examples":["b4b0d249-b402-49ac-b744-5027d4574fc5"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].categoryId","typeLabel":"string"},"categoryName":{"type":"string","description":"The name of the Spade category that matched this trigger. Only present when `type` is `category_trigger`.","examples":["Travel"],"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX].categoryName","typeLabel":"string"}},"uniqueKey":"correctedData.actions.oneOf.0.items.[INDEX]","typeLabel":"object"},"examples":[[{"id":"trigger-12345","type":"merchant_trigger","action":{"type":"REWARD","rewardPercent":5},"scope":"account","source":"counterparty"}]],"uniqueKey":"correctedData.actions.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"An array of triggered actions, or `null` if no triggers matched.\nThis field is only present if your integration has the actions feature enabled.\n\nWhen a transaction matches one or more registered triggers, this array contains the action details including your custom `action` data.\n","items":{"type":"object","description":"A triggered action returned in the enrichment response.","properties":{"id":{"type":"string","maxLength":512,"description":"Your unique identifier for the matched trigger (as provided during registration).","examples":["trigger-12345"]},"type":{"type":"string","description":"The type of trigger that matched — `merchant_trigger` for merchant-based triggers, `category_trigger` for category-based triggers.","enum":["merchant_trigger","category_trigger"],"example":"merchant_trigger","examples":["merchant_trigger"]},"action":{"type":"object","description":"The custom action data you provided during registration for this trigger.\n\nFor `BLOCK` and `ALLOW_ONLY` action types, an `authRecommendation` field is automatically added:\n- `BLOCK` triggers that match: `authRecommendation` is set to `\"BLOCK\"`.\n- `ALLOW_ONLY` triggers that match: `authRecommendation` is set to `\"ALLOW\"`.\n- `ALLOW_ONLY` triggers at a scope where no `ALLOW_ONLY` trigger matched: `authRecommendation` is set to `\"BLOCK\"`.\n\nOne enrichment can return several actions carrying different `authRecommendation` values. See [Resolving multiple actions](/reference/action-triggers-guide#resolving-multiple-actions).\n","additionalProperties":true,"properties":{"authRecommendation":{"type":"string","description":"Authorization recommendation injected for `BLOCK` and `ALLOW_ONLY` action types. Not present for other action types.","enum":["ALLOW","BLOCK"]}},"examples":[{"type":"REWARD","rewardPercent":5,"offerId":"offer-abc123"},{"type":"BLOCK","reason":"Gambling merchant","authRecommendation":"BLOCK"},{"type":"ALLOW_ONLY","category":"approved-vendors","authRecommendation":"ALLOW"}]},"scope":{"type":"string","description":"The scope at which this trigger was registered (account, program, user, or card).","enum":["account","program","user","card"],"example":"account","examples":["account"]},"source":{"oneOf":[{"type":"string","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"]},{"type":"null","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"]}]},"categoryId":{"type":"string","description":"The Spade category ID that matched this trigger. Only present when `type` is `category_trigger`.","examples":["b4b0d249-b402-49ac-b744-5027d4574fc5"]},"categoryName":{"type":"string","description":"The name of the Spade category that matched this trigger. Only present when `type` is `category_trigger`.","examples":["Travel"]}}},"examples":[[{"id":"trigger-12345","type":"merchant_trigger","action":{"type":"REWARD","rewardPercent":5},"scope":"account","source":"counterparty"}]],"uniqueKey":"correctedData.actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"correctedData.actions","typeLabel":"object[] | null"}},"isRequired":true,"uniqueKey":"correctedData","typeLabel":"object"},"transactionInfo":{"type":"object","properties":{"transferInfo":{"oneOf":[{"type":"object","description":"Additional information about transfers. This field is `null` for card transactions.","example":null,"properties":{"direction":{"type":"string","maxLength":12,"enum":["outgoing","incoming"],"description":"The transfer direction.","examples":["outgoing"],"uniqueKey":"transactionInfo.transferInfo.oneOf.0.direction","typeLabel":"enum\u003cstring>"},"transferMethod":{"type":"string","maxLength":12,"enum":["ach","cash","check","intrabank","rtp","unknown","wire"],"description":"The transfer method.","examples":["ach"],"uniqueKey":"transactionInfo.transferInfo.oneOf.0.transferMethod","typeLabel":"enum\u003cstring>"},"transferType":{"type":"string","maxLength":12,"enum":["external","internal","unknown"],"description":"The transfer type. \"external\" indicates that money is being sent to an external counterparty. \"internal\" indicates that money is being moved between accounts owned by the same entity.","examples":["external"],"uniqueKey":"transactionInfo.transferInfo.oneOf.0.transferType","typeLabel":"enum\u003cstring>"},"isAdjustmentOrRefund":{"type":"boolean","description":"Whether the transfer is an adjustment or refund.","examples":[false],"uniqueKey":"transactionInfo.transferInfo.oneOf.0.isAdjustmentOrRefund","typeLabel":"boolean"}},"uniqueKey":"transactionInfo.transferInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional information about transfers. This field is `null` for card transactions.","example":null,"properties":{"direction":{"type":"string","maxLength":12,"enum":["outgoing","incoming"],"description":"The transfer direction.","examples":["outgoing"]},"transferMethod":{"type":"string","maxLength":12,"enum":["ach","cash","check","intrabank","rtp","unknown","wire"],"description":"The transfer method.","examples":["ach"]},"transferType":{"type":"string","maxLength":12,"enum":["external","internal","unknown"],"description":"The transfer type. \"external\" indicates that money is being sent to an external counterparty. \"internal\" indicates that money is being moved between accounts owned by the same entity.","examples":["external"]},"isAdjustmentOrRefund":{"type":"boolean","description":"Whether the transfer is an adjustment or refund.","examples":[false]}},"uniqueKey":"transactionInfo.transferInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.transferInfo","typeLabel":"object | null"},"isAccountVerification":{"oneOf":[{"type":"boolean","description":"Whether the transfer is an account verification. Currently only available for transfers.","example":false,"uniqueKey":"transactionInfo.isAccountVerification.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the transfer is an account verification. Currently only available for transfers.","example":false,"uniqueKey":"transactionInfo.isAccountVerification.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.isAccountVerification","typeLabel":"boolean | null"},"isPeerToPeer":{"oneOf":[{"type":"boolean","description":"Whether the transaction is a peer-to-peer transaction. Currently only available for transfers.","example":false,"uniqueKey":"transactionInfo.isPeerToPeer.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the transaction is a peer-to-peer transaction. Currently only available for transfers.","example":false,"uniqueKey":"transactionInfo.isPeerToPeer.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.isPeerToPeer","typeLabel":"boolean | null"},"isDigitalWallet":{"oneOf":[{"type":"boolean","description":"Whether the transaction involves a digital wallet. Currently only available for transfers.","example":false,"uniqueKey":"transactionInfo.isDigitalWallet.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the transaction involves a digital wallet. Currently only available for transfers.","example":false,"uniqueKey":"transactionInfo.isDigitalWallet.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.isDigitalWallet","typeLabel":"boolean | null"},"type":{"type":"string","description":"The main type of the transaction. For card transactions, the type is always \"spending\".","enum":["account_verification","atm","debt","fee","income","other_money_movement","reimbursement","spending"],"examples":["spending"],"uniqueKey":"transactionInfo.type","typeLabel":"enum\u003cstring>"},"subType":{"oneOf":[{"type":"string","description":"The more specific type of the transaction, if applicable. For card transactions, the `subType` is always `null`.","enum":["alimony_or_child_support","atm","bnpl","business","cash_advance","deposit","disbursements","earned_income","government_benefits","insurance","investment","nsf","other","overdraft","payment","payout","rental","retirement","tax_refund","transfer","withdrawal"],"examples":[null],"uniqueKey":"transactionInfo.subType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The more specific type of the transaction, if applicable. For card transactions, the `subType` is always `null`.","enum":["alimony_or_child_support","atm","bnpl","business","cash_advance","deposit","disbursements","earned_income","government_benefits","insurance","investment","nsf","other","overdraft","payment","payout","rental","retirement","tax_refund","transfer","withdrawal"],"examples":[null],"uniqueKey":"transactionInfo.subType.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.subType","typeLabel":"enum\u003cstring> | null"},"display":{"oneOf":[{"type":"object","description":"An object containing display information for the transaction. The fields in this object are pulled from other parts of the enrichment and surfaced here for convenience.\n","properties":{"name":{"type":"string","maxLength":64,"description":"The best name for display.","examples":["Amazon"],"uniqueKey":"transactionInfo.display.oneOf.0.name","typeLabel":"string"},"categoryName":{"oneOf":[{"type":"string","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"],"uniqueKey":"transactionInfo.display.oneOf.0.categoryName.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"],"uniqueKey":"transactionInfo.display.oneOf.0.categoryName.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.display.oneOf.0.categoryName","typeLabel":"string | null"},"graphic":{"oneOf":[{"type":"string","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"],"uniqueKey":"transactionInfo.display.oneOf.0.graphic.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"],"uniqueKey":"transactionInfo.display.oneOf.0.graphic.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.display.oneOf.0.graphic","typeLabel":"string\u003curl> | null"},"graphicSource":{"oneOf":[{"type":"string","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"],"uniqueKey":"transactionInfo.display.oneOf.0.graphicSource.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"],"uniqueKey":"transactionInfo.display.oneOf.0.graphicSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.display.oneOf.0.graphicSource","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"transactionInfo.display.oneOf.0","typeLabel":"object"},{"type":"null","description":"An object containing display information for the transaction. The fields in this object are pulled from other parts of the enrichment and surfaced here for convenience.\n","properties":{"name":{"type":"string","maxLength":64,"description":"The best name for display.","examples":["Amazon"]},"categoryName":{"oneOf":[{"type":"string","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"]},{"type":"null","maxLength":64,"description":"The best category name for display.","examples":["Online Marketplace"]}]},"graphic":{"oneOf":[{"type":"string","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"]},{"type":"null","maxLength":128,"description":"The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.\n","format":"url","examples":["https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"]}]},"graphicSource":{"oneOf":[{"type":"string","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"]},{"type":"null","maxLength":16,"enum":["counterparty","third_party","category"],"description":"The field from which the `graphic` was sourced. This will be either `counterparty`, `third_party`, or `category`.\n","examples":["counterparty"]}]}},"uniqueKey":"transactionInfo.display.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.display","typeLabel":"object | null"},"thirdParties":{"type":"array","description":"An array of third parties involved in the transaction, when applicable. Entities such as Toast, Square, Uber Eats, Doordash, etc. will appear here.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","examples":["ac48cef2-0d7f-4159-865e-e92b152262bc"],"uniqueKey":"transactionInfo.thirdParties.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":64,"examples":["Paypal"],"uniqueKey":"transactionInfo.thirdParties.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["bnpl","delivery_service","marketplace","payment_processor","platform"],"examples":["payment_processor"],"uniqueKey":"transactionInfo.thirdParties.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"logo":{"oneOf":[{"type":"string","maxLength":128,"format":"url","examples":["https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png"],"description":"Third party logo.","uniqueKey":"transactionInfo.thirdParties.items.[INDEX].logo.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","maxLength":128,"format":"url","examples":["https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png"],"description":"Third party logo.","uniqueKey":"transactionInfo.thirdParties.items.[INDEX].logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.thirdParties.items.[INDEX].logo","typeLabel":"string\u003curl> | null"},"website":{"oneOf":[{"type":"string","maxLength":256,"format":"url","examples":["https://www.paypal.com/"],"description":"Third party website.","uniqueKey":"transactionInfo.thirdParties.items.[INDEX].website.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","maxLength":256,"format":"url","examples":["https://www.paypal.com/"],"description":"Third party website.","uniqueKey":"transactionInfo.thirdParties.items.[INDEX].website.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.thirdParties.items.[INDEX].website","typeLabel":"string\u003curl> | null"}},"uniqueKey":"transactionInfo.thirdParties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"transactionInfo.thirdParties","typeLabel":"object[]"},"spendingInfo":{"oneOf":[{"type":"object","description":"Additional information about transactions whose `type` is \"spending\". This field is `null` for other types of transactions.","properties":{"channel":{"type":"object","properties":{"value":{"oneOf":[{"type":"string","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine.","uniqueKey":"transactionInfo.spendingInfo.oneOf.0.channel.value.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine.","uniqueKey":"transactionInfo.spendingInfo.oneOf.0.channel.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.spendingInfo.oneOf.0.channel.value","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"transactionInfo.spendingInfo.oneOf.0.channel","typeLabel":"object"}},"uniqueKey":"transactionInfo.spendingInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional information about transactions whose `type` is \"spending\". This field is `null` for other types of transactions.","properties":{"channel":{"type":"object","properties":{"value":{"oneOf":[{"type":"string","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine."},{"type":"null","enum":["digital","physical",null],"description":"Spending channel value of digital or physical, null if we are unable to determine."}]}}}},"uniqueKey":"transactionInfo.spendingInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.spendingInfo","typeLabel":"object | null"},"atmInfo":{"oneOf":[{"type":"object","description":"Additional information about ATM transactions. This field is `null` for other types of transactions.","examples":[null],"properties":{"sponsorName":{"type":"string","maxLength":64,"description":"The name of the sponsor of the ATM involved in the transaction.","examples":["Fiserv"],"uniqueKey":"transactionInfo.atmInfo.oneOf.0.sponsorName","typeLabel":"string"},"ownerName":{"type":"string","maxLength":64,"description":"The name of the owner of the ATM involved in the transaction.","examples":["Wells Fargo"],"uniqueKey":"transactionInfo.atmInfo.oneOf.0.ownerName","typeLabel":"string"}},"uniqueKey":"transactionInfo.atmInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional information about ATM transactions. This field is `null` for other types of transactions.","examples":[null],"properties":{"sponsorName":{"type":"string","maxLength":64,"description":"The name of the sponsor of the ATM involved in the transaction.","examples":["Fiserv"]},"ownerName":{"type":"string","maxLength":64,"description":"The name of the owner of the ATM involved in the transaction.","examples":["Wells Fargo"]}},"uniqueKey":"transactionInfo.atmInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.atmInfo","typeLabel":"object | null"},"transactionId":{"type":"string","maxLength":512,"description":"Your ID representing this transaction. This ID exactly matches the transactionId you provided in your enrichment request.","examples":["transaction_id_123456789"],"uniqueKey":"transactionInfo.transactionId","typeLabel":"string"},"recurrenceInfo":{"oneOf":[{"type":"object","description":"A recurring transaction is a repeated payment pattern to a counterparty, based on periodicty and amount. Premium Spade Signal available depending on your product package.","properties":{"intervalType":{"oneOf":[{"type":"string","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence.","uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.intervalType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence.","uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.intervalType.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.intervalType","typeLabel":"enum\u003cstring> | null"},"intervalDays":{"oneOf":[{"type":"integer","description":"Number of days between recurrences.","examples":[30],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.intervalDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of days between recurrences.","examples":[30],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.intervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.intervalDays","typeLabel":"integer | null"},"nextPaymentExpected":{"oneOf":[{"type":"string","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.nextPaymentExpected.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.nextPaymentExpected.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.nextPaymentExpected","typeLabel":"string\u003cdate> | null"},"recentRecurrences":{"oneOf":[{"type":"array","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}},"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences.oneOf.0.items.[INDEX]","typeLabel":"array"},"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences.oneOf.0","typeLabel":"array[]"},{"type":"null","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}}},"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0.recentRecurrences","typeLabel":"array[] | null"}},"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"A recurring transaction is a repeated payment pattern to a counterparty, based on periodicty and amount. Premium Spade Signal available depending on your product package.","properties":{"intervalType":{"oneOf":[{"type":"string","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence."},{"type":"null","maxLength":12,"enum":["weekly","biweekly","semi_monthly","monthly","quarterly","annually"],"description":"Recurrence cadence."}]},"intervalDays":{"oneOf":[{"type":"integer","description":"Number of days between recurrences.","examples":[30]},{"type":"null","description":"Number of days between recurrences.","examples":[30]}]},"nextPaymentExpected":{"oneOf":[{"type":"string","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"]},{"type":"null","maxLength":10,"format":"date","description":"Next expected payment date.","examples":["2024-08-07"]}]},"recentRecurrences":{"oneOf":[{"type":"array","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}}}},{"type":"null","description":"Array of recent recurrence objects, null if no recurrence exists.","items":{"type":"array","properties":{"amount":{"type":"number","description":"Amount of the recurrence.","examples":[130]},"enrichmentId":{"type":"string","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","examples":["c1d4064b-9364-43d3-8ee3-500898cda1aa"]},"occurredAt":{"type":"string","format":"date-time","description":"Date and time the transaction occurred. Formatted as an ISO 8601 date time.","examples":["2024-06-06T14:25:11+00:00"]},"transactionId":{"type":"string","description":"Customer-provided identifier for the transaction.","examples":["d6c4dc4e-e0da-4782-b581-95916523d87a"]}}}}]}},"uniqueKey":"transactionInfo.recurrenceInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.recurrenceInfo","typeLabel":"object | null"},"riskInsights":{"oneOf":[{"type":"object","description":"Risk insights provide visibility into the potential risk of a transaction and the merchants involved. Premium Spade Signal available depending on your product package.","properties":{"irregularWebPresenceDetected":{"oneOf":[{"type":"boolean","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.irregularWebPresenceDetected.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.irregularWebPresenceDetected.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.irregularWebPresenceDetected","typeLabel":"boolean | null"},"negativeOnlineSentiment":{"oneOf":[{"type":"boolean","description":"Negative online consumer feedback associated with the counterparty.","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.negativeOnlineSentiment.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Negative online consumer feedback associated with the counterparty.","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.negativeOnlineSentiment.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.negativeOnlineSentiment","typeLabel":"boolean | null"},"highRiskEntity":{"oneOf":[{"type":"boolean","description":"The counterparty is known to engage in fraudulent practices.","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.highRiskEntity.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The counterparty is known to engage in fraudulent practices.","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.highRiskEntity.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.highRiskEntity","typeLabel":"boolean | null"},"riskyIndustry":{"oneOf":[{"type":"boolean","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.riskyIndustry.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.riskyIndustry.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.riskyIndustry","typeLabel":"boolean | null"},"cardAcceptanceHistory":{"oneOf":[{"type":"string","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.cardAcceptanceHistory.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.cardAcceptanceHistory.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.riskInsights.oneOf.0.cardAcceptanceHistory","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"transactionInfo.riskInsights.oneOf.0","typeLabel":"object"},{"type":"null","description":"Risk insights provide visibility into the potential risk of a transaction and the merchants involved. Premium Spade Signal available depending on your product package.","properties":{"irregularWebPresenceDetected":{"oneOf":[{"type":"boolean","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false]},{"type":"null","description":"Has engaged in deceptive online practices or has irregular website structure or content.","examples":[false]}]},"negativeOnlineSentiment":{"oneOf":[{"type":"boolean","description":"Negative online consumer feedback associated with the counterparty.","examples":[false]},{"type":"null","description":"Negative online consumer feedback associated with the counterparty.","examples":[false]}]},"highRiskEntity":{"oneOf":[{"type":"boolean","description":"The counterparty is known to engage in fraudulent practices.","examples":[false]},{"type":"null","description":"The counterparty is known to engage in fraudulent practices.","examples":[false]}]},"riskyIndustry":{"oneOf":[{"type":"boolean","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false]},{"type":"null","description":"Industry is correlated with increased disputes (based on Spade industries).","examples":[false]}]},"cardAcceptanceHistory":{"oneOf":[{"type":"string","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"]},{"type":"null","enum":["extensive","established","stable","limited","very_limited","null"],"description":"Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.","examples":["extensive"]}]}},"uniqueKey":"transactionInfo.riskInsights.oneOf.1","typeLabel":"null"}],"uniqueKey":"transactionInfo.riskInsights","typeLabel":"object | null"}},"uniqueKey":"transactionInfo","typeLabel":"object"},"enrichmentId":{"type":"string","format":"uuid","description":"Our ID representing the enrichment, not to be confused with your provided `transactionId`.","uniqueKey":"enrichmentId","typeLabel":"string\u003cuuid>"},"counterparty":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"A unique identifier for this counterparty, regardless of specific location.","format":"uuid","example":"704bbd58-fb12-4bdb-9aae-2786704ea92a","uniqueKey":"counterparty.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"A unique identifier for this counterparty, regardless of specific location.","format":"uuid","example":"704bbd58-fb12-4bdb-9aae-2786704ea92a","uniqueKey":"counterparty.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","description":"Counterparty name.","maxLength":64,"example":"Amazon","uniqueKey":"counterparty.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Counterparty name.","maxLength":64,"example":"Amazon","uniqueKey":"counterparty.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].name","typeLabel":"string | null"},"legalName":{"oneOf":[{"type":"string","description":"Counterparty legal name.","maxLength":128,"example":"Amazon Inc.","uniqueKey":"counterparty.items.[INDEX].legalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Counterparty legal name.","maxLength":128,"example":"Amazon Inc.","uniqueKey":"counterparty.items.[INDEX].legalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].legalName","typeLabel":"string | null"},"industry":{"type":"array","items":{"type":"object","description":"A node in a tree representing a hierarchical category system","properties":{"id":{"type":"string","maxLength":15,"example":"011-000-000-000","uniqueKey":"counterparty.items.[INDEX].industry.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","maxLength":64,"example":"Retail","uniqueKey":"counterparty.items.[INDEX].industry.items.[INDEX].name","typeLabel":"string"},"icon":{"oneOf":[{"type":"string","description":"Category icon.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png","uniqueKey":"counterparty.items.[INDEX].industry.items.[INDEX].icon.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","description":"Category icon.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png","uniqueKey":"counterparty.items.[INDEX].industry.items.[INDEX].icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].industry.items.[INDEX].icon","typeLabel":"string\u003curl> | null"}},"uniqueKey":"counterparty.items.[INDEX].industry.items.[INDEX]","typeLabel":"object"},"description":"Array with increasingly specific category information.","uniqueKey":"counterparty.items.[INDEX].industry","typeLabel":"object[]"},"matchScore":{"oneOf":[{"type":"number","description":"The matchScore predicts how well a transaction matches a Counterparty in our records. If no Counterparty was found, the matchScore is set to null. Otherwise, scores range between 50.00 and 100.00. We filter out results below this range to make sure that only high quality matches are returned. Generally, the higher the matchScore is the better the match between a transaction and a Counterparty. When multiple Counterparties match a transaction, matches are returned in decreasing order of matchScore. This is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"counterparty.items.[INDEX].matchScore.oneOf.0","typeLabel":"number"},{"type":"null","description":"The matchScore predicts how well a transaction matches a Counterparty in our records. If no Counterparty was found, the matchScore is set to null. Otherwise, scores range between 50.00 and 100.00. We filter out results below this range to make sure that only high quality matches are returned. Generally, the higher the matchScore is the better the match between a transaction and a Counterparty. When multiple Counterparties match a transaction, matches are returned in decreasing order of matchScore. This is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"counterparty.items.[INDEX].matchScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].matchScore","typeLabel":"number | null"},"location":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"A unique identifier for this location.","format":"uuid","example":"fdf79470-3deb-4638-956a-6859e473b9d8","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"A unique identifier for this location.","format":"uuid","example":"fdf79470-3deb-4638-956a-6859e473b9d8","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"},"address":{"oneOf":[{"type":"string","description":"Street number, name, and any secondary address information.","maxLength":64,"example":"1234 W 5th Ave Suite 100","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number, name, and any secondary address information.","maxLength":64,"example":"1234 W 5th Ave Suite 100","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].address.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].address","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"type":"string","description":"Street number and name.","maxLength":64,"example":"1234 W 5th Ave","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number and name.","maxLength":64,"example":"1234 W 5th Ave","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","description":"Secondary address information.","maxLength":32,"example":"Suite 100","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary address information.","maxLength":32,"example":"Suite 100","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","maxLength":64,"example":"New York","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].city.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"example":"New York","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].city.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].city","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","description":"Region code. Typically a two-letter code for US states, but may vary for international regions.","maxLength":64,"example":"NY","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].region.oneOf.0","typeLabel":"string"},{"type":"null","description":"Region code. Typically a two-letter code for US states, but may vary for international regions.","maxLength":64,"example":"NY","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].region.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].region","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Three letter country code.","maxLength":3,"example":"USA","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Three letter country code.","maxLength":3,"example":"USA","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].country.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].country","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","description":"Location postal code or zip code.","maxLength":12,"example":"10001","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].postalCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Location postal code or zip code.","maxLength":12,"example":"10001","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].postalCode","typeLabel":"string | null"},"latitude":{"oneOf":[{"type":"number","description":"Location latitude.","example":45,"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].latitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"Location latitude.","example":45,"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].latitude","typeLabel":"number | null"},"longitude":{"oneOf":[{"type":"number","description":"Location longitude.","example":120,"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].longitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"Location longitude.","example":120,"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].longitude","typeLabel":"number | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Location phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Location phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].phoneNumber","typeLabel":"string | null"},"matchScore":{"oneOf":[{"type":"number","description":"The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location.\nThis is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].matchScore.oneOf.0","typeLabel":"number"},{"type":"null","description":"The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location.\nThis is a premium Spade field available depending on your product package.\n","example":93.5,"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].matchScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX].matchScore","typeLabel":"number | null"}},"uniqueKey":"counterparty.items.[INDEX].location.items.[INDEX]","typeLabel":"object"},"description":"Locations of this counterparty that matched the transaction. Currently contains only one location.\n","uniqueKey":"counterparty.items.[INDEX].location","typeLabel":"object[]"},"logo":{"oneOf":[{"type":"string","description":"Counterparty logo.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","uniqueKey":"counterparty.items.[INDEX].logo.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","description":"Counterparty logo.","format":"url","maxLength":128,"example":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","uniqueKey":"counterparty.items.[INDEX].logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].logo","typeLabel":"string\u003curl> | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Counterparty phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"counterparty.items.[INDEX].phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Counterparty phone number.","maxLength":24,"example":"+18664862360","uniqueKey":"counterparty.items.[INDEX].phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].phoneNumber","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","description":"Counterparty website.","format":"url","maxLength":256,"example":"https://www.amazon.com","uniqueKey":"counterparty.items.[INDEX].website.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","description":"Counterparty website.","format":"url","maxLength":256,"example":"https://www.amazon.com","uniqueKey":"counterparty.items.[INDEX].website.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].website","typeLabel":"string\u003curl> | null"},"possibleCounterpartyAlternate":{"oneOf":[{"type":"object","description":"The possible alternate counterparty object represents a counterparty that may be matched to this transaction in other enrichment requests.\nPremium Spade Field available depending on your product package.\n","properties":{"id":{"type":"string","description":"The ID of the alternate counterparty.\n","format":"uuid","example":"49fd51a1-5a19-3e5d-8d28-eb056ecf8939","uniqueKey":"counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"similarity":{"type":"number","description":"The similarity score indicates how closely this alternate counterparty matches the main counterparty. The score is a value between 0.0 and 100.0, where 100.0 is an exact match.\n","example":80,"uniqueKey":"counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.0.similarity","typeLabel":"number"}},"uniqueKey":"counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.0","typeLabel":"object"},{"type":"null","description":"The possible alternate counterparty object represents a counterparty that may be matched to this transaction in other enrichment requests.\nPremium Spade Field available depending on your product package.\n","properties":{"id":{"type":"string","description":"The ID of the alternate counterparty.\n","format":"uuid","example":"49fd51a1-5a19-3e5d-8d28-eb056ecf8939"},"similarity":{"type":"number","description":"The similarity score indicates how closely this alternate counterparty matches the main counterparty. The score is a value between 0.0 and 100.0, where 100.0 is an exact match.\n","example":80}},"uniqueKey":"counterparty.items.[INDEX].possibleCounterpartyAlternate.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterparty.items.[INDEX].possibleCounterpartyAlternate","typeLabel":"object | null"}},"uniqueKey":"counterparty.items.[INDEX]","typeLabel":"object"},"description":"An array of counterparties matched to the transaction, ordered by descending match score.","uniqueKey":"counterparty","typeLabel":"object[]"},"mobileAppInfo":{"oneOf":[{"description":"The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.\n","type":"object","properties":{"id":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"A unique identifier for this mobile app.","uniqueKey":"mobileAppInfo.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":512,"examples":["Roblox"],"description":"The name of the mobile app.","uniqueKey":"mobileAppInfo.oneOf.0.name","typeLabel":"string"},"url":{"oneOf":[{"type":"string","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store.","uniqueKey":"mobileAppInfo.oneOf.0.url.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store.","uniqueKey":"mobileAppInfo.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobileAppInfo.oneOf.0.url","typeLabel":"string\u003curl> | null"},"logo":{"oneOf":[{"type":"string","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo.","uniqueKey":"mobileAppInfo.oneOf.0.logo.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo.","uniqueKey":"mobileAppInfo.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobileAppInfo.oneOf.0.logo","typeLabel":"string\u003curl> | null"},"developerName":{"type":"string","maxLength":256,"examples":["Roblox Corporation"],"description":"The name of the developer of the mobile app.","uniqueKey":"mobileAppInfo.oneOf.0.developerName","typeLabel":"string"},"developerId":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"The ID of the developer of the mobile app.","uniqueKey":"mobileAppInfo.oneOf.0.developerId","typeLabel":"string\u003cuuid>"},"category":{"type":"string","enum":["Auto and Transportation","Creative and Design","Education and Parenting","Entertainment and Media","Finance and Business","Games","Health and Lifestyle","Shopping and Marketplaces","Social and Communication","Travel and Events","Utility and Tools"],"examples":["Auto and Transportation"],"description":"The category of the mobile app.","uniqueKey":"mobileAppInfo.oneOf.0.category","typeLabel":"enum\u003cstring>"},"hasGamblingOrRewards":{"type":"boolean","examples":[false],"description":"Whether the mobile app has gambling or cash rewards.","uniqueKey":"mobileAppInfo.oneOf.0.hasGamblingOrRewards","typeLabel":"boolean"},"hasSimulatedGambling":{"type":"boolean","examples":[false],"description":"Whether the mobile app has simulated gambling.","uniqueKey":"mobileAppInfo.oneOf.0.hasSimulatedGambling","typeLabel":"boolean"},"ageRating":{"type":"string","enum":["Children","Teen","Adult","Unknown"],"examples":["Teen"],"description":"The age rating of the mobile app.","uniqueKey":"mobileAppInfo.oneOf.0.ageRating","typeLabel":"enum\u003cstring>"}},"uniqueKey":"mobileAppInfo.oneOf.0","typeLabel":"object"},{"description":"The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.\n","type":"null","properties":{"id":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"A unique identifier for this mobile app."},"name":{"type":"string","maxLength":512,"examples":["Roblox"],"description":"The name of the mobile app."},"url":{"oneOf":[{"type":"string","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store."},{"type":"null","format":"url","examples":["https://play.google.com/store/apps/details?id=com.roblox.client"],"description":"The URL of the mobile app in the app store."}]},"logo":{"oneOf":[{"type":"string","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo."},{"type":"null","format":"url","examples":["https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png"],"description":"The URL of the mobile app's logo."}]},"developerName":{"type":"string","maxLength":256,"examples":["Roblox Corporation"],"description":"The name of the developer of the mobile app."},"developerId":{"type":"string","format":"uuid","examples":["704bbd58-fb12-4bdb-9aae-2786704ea92a"],"description":"The ID of the developer of the mobile app."},"category":{"type":"string","enum":["Auto and Transportation","Creative and Design","Education and Parenting","Entertainment and Media","Finance and Business","Games","Health and Lifestyle","Shopping and Marketplaces","Social and Communication","Travel and Events","Utility and Tools"],"examples":["Auto and Transportation"],"description":"The category of the mobile app."},"hasGamblingOrRewards":{"type":"boolean","examples":[false],"description":"Whether the mobile app has gambling or cash rewards."},"hasSimulatedGambling":{"type":"boolean","examples":[false],"description":"Whether the mobile app has simulated gambling."},"ageRating":{"type":"string","enum":["Children","Teen","Adult","Unknown"],"examples":["Teen"],"description":"The age rating of the mobile app."}},"uniqueKey":"mobileAppInfo.oneOf.1","typeLabel":"null"}],"uniqueKey":"mobileAppInfo","typeLabel":"object | null"},"customAttributes":{"type":"object","description":"A dictionary containing the custom attributes that were included in the enrichment request (if any).","additionalProperties":{"type":"string","uniqueKey":"customAttributes.additionalProperties","typeLabel":"string"},"examples":[{"custom_attribute_1":"value_1","custom_attribute_2":"value_2"}],"uniqueKey":"customAttributes","typeLabel":"object"},"actions":{"oneOf":[{"type":"array","description":"An array of triggered actions, or `null` if no triggers matched.\nThis field is only present if your integration has the actions feature enabled.\n\nWhen a transaction matches one or more registered triggers, this array contains the action details including your custom `action` data.\n","items":{"type":"object","description":"A triggered action returned in the enrichment response.","properties":{"id":{"type":"string","maxLength":512,"description":"Your unique identifier for the matched trigger (as provided during registration).","examples":["trigger-12345"],"uniqueKey":"actions.oneOf.0.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of trigger that matched — `merchant_trigger` for merchant-based triggers, `category_trigger` for category-based triggers.","enum":["merchant_trigger","category_trigger"],"example":"merchant_trigger","examples":["merchant_trigger"],"uniqueKey":"actions.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"action":{"type":"object","description":"The custom action data you provided during registration for this trigger.\n\nFor `BLOCK` and `ALLOW_ONLY` action types, an `authRecommendation` field is automatically added:\n- `BLOCK` triggers that match: `authRecommendation` is set to `\"BLOCK\"`.\n- `ALLOW_ONLY` triggers that match: `authRecommendation` is set to `\"ALLOW\"`.\n- `ALLOW_ONLY` triggers at a scope where no `ALLOW_ONLY` trigger matched: `authRecommendation` is set to `\"BLOCK\"`.\n\nOne enrichment can return several actions carrying different `authRecommendation` values. See [Resolving multiple actions](/reference/action-triggers-guide#resolving-multiple-actions).\n","additionalProperties":true,"properties":{"authRecommendation":{"type":"string","description":"Authorization recommendation injected for `BLOCK` and `ALLOW_ONLY` action types. Not present for other action types.","enum":["ALLOW","BLOCK"],"uniqueKey":"actions.oneOf.0.items.[INDEX].action.authRecommendation","typeLabel":"enum\u003cstring>"}},"examples":[{"type":"REWARD","rewardPercent":5,"offerId":"offer-abc123"},{"type":"BLOCK","reason":"Gambling merchant","authRecommendation":"BLOCK"},{"type":"ALLOW_ONLY","category":"approved-vendors","authRecommendation":"ALLOW"}],"uniqueKey":"actions.oneOf.0.items.[INDEX].action","typeLabel":"object"},"scope":{"type":"string","description":"The scope at which this trigger was registered (account, program, user, or card).","enum":["account","program","user","card"],"example":"account","examples":["account"],"uniqueKey":"actions.oneOf.0.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"source":{"oneOf":[{"type":"string","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"],"uniqueKey":"actions.oneOf.0.items.[INDEX].source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"],"uniqueKey":"actions.oneOf.0.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.oneOf.0.items.[INDEX].source","typeLabel":"enum\u003cstring> | null"},"categoryId":{"type":"string","description":"The Spade category ID that matched this trigger. Only present when `type` is `category_trigger`.","examples":["b4b0d249-b402-49ac-b744-5027d4574fc5"],"uniqueKey":"actions.oneOf.0.items.[INDEX].categoryId","typeLabel":"string"},"categoryName":{"type":"string","description":"The name of the Spade category that matched this trigger. Only present when `type` is `category_trigger`.","examples":["Travel"],"uniqueKey":"actions.oneOf.0.items.[INDEX].categoryName","typeLabel":"string"}},"uniqueKey":"actions.oneOf.0.items.[INDEX]","typeLabel":"object"},"examples":[[{"id":"trigger-12345","type":"merchant_trigger","action":{"type":"REWARD","rewardPercent":5},"scope":"account","source":"counterparty"}]],"uniqueKey":"actions.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"An array of triggered actions, or `null` if no triggers matched.\nThis field is only present if your integration has the actions feature enabled.\n\nWhen a transaction matches one or more registered triggers, this array contains the action details including your custom `action` data.\n","items":{"type":"object","description":"A triggered action returned in the enrichment response.","properties":{"id":{"type":"string","maxLength":512,"description":"Your unique identifier for the matched trigger (as provided during registration).","examples":["trigger-12345"]},"type":{"type":"string","description":"The type of trigger that matched — `merchant_trigger` for merchant-based triggers, `category_trigger` for category-based triggers.","enum":["merchant_trigger","category_trigger"],"example":"merchant_trigger","examples":["merchant_trigger"]},"action":{"type":"object","description":"The custom action data you provided during registration for this trigger.\n\nFor `BLOCK` and `ALLOW_ONLY` action types, an `authRecommendation` field is automatically added:\n- `BLOCK` triggers that match: `authRecommendation` is set to `\"BLOCK\"`.\n- `ALLOW_ONLY` triggers that match: `authRecommendation` is set to `\"ALLOW\"`.\n- `ALLOW_ONLY` triggers at a scope where no `ALLOW_ONLY` trigger matched: `authRecommendation` is set to `\"BLOCK\"`.\n\nOne enrichment can return several actions carrying different `authRecommendation` values. See [Resolving multiple actions](/reference/action-triggers-guide#resolving-multiple-actions).\n","additionalProperties":true,"properties":{"authRecommendation":{"type":"string","description":"Authorization recommendation injected for `BLOCK` and `ALLOW_ONLY` action types. Not present for other action types.","enum":["ALLOW","BLOCK"]}},"examples":[{"type":"REWARD","rewardPercent":5,"offerId":"offer-abc123"},{"type":"BLOCK","reason":"Gambling merchant","authRecommendation":"BLOCK"},{"type":"ALLOW_ONLY","category":"approved-vendors","authRecommendation":"ALLOW"}]},"scope":{"type":"string","description":"The scope at which this trigger was registered (account, program, user, or card).","enum":["account","program","user","card"],"example":"account","examples":["account"]},"source":{"oneOf":[{"type":"string","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"]},{"type":"null","description":"Indicates whether the action was triggered by the matched counterparty or third party.\n\nThis field will be set to `null` when an `ALLOW_ONLY` action trigger was set up whose condition the current transaction did not meet. The `authRecommendation` in this case will be `BLOCK`.\n\nThis field is always `null` for category triggers.\n","enum":["counterparty","third_party",null],"example":"counterparty","examples":["counterparty"]}]},"categoryId":{"type":"string","description":"The Spade category ID that matched this trigger. Only present when `type` is `category_trigger`.","examples":["b4b0d249-b402-49ac-b744-5027d4574fc5"]},"categoryName":{"type":"string","description":"The name of the Spade category that matched this trigger. Only present when `type` is `category_trigger`.","examples":["Travel"]}}},"examples":[[{"id":"trigger-12345","type":"merchant_trigger","action":{"type":"REWARD","rewardPercent":5},"scope":"account","source":"counterparty"}]],"uniqueKey":"actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions","typeLabel":"object[] | null"},"reason":{"oneOf":[{"type":"string","description":"Set when `status` is `rejected`; `null` when accepted. Treat as a growing enum, not an exhaustive list. When the underlying reason is `other`, this carries the reviewer's free-text description instead of the literal code `other`.\n","examples":["location_correct_spade_verified"],"uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Set when `status` is `rejected`; `null` when accepted. Treat as a growing enum, not an exhaustive list. When the underlying reason is `other`, this carries the reviewer's free-text description instead of the literal code `other`.\n","examples":["location_correct_spade_verified"],"uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorReportId":"8e21c6a4-2f3d-4b7a-9c1e-5d6f0a9b7c3e","correctedData":{"transactionInfo":{"transferInfo":null,"isAccountVerification":false,"isPeerToPeer":false,"isDigitalWallet":false,"type":"spending","subType":null,"display":{"name":"Amazon","categoryName":"Online Marketplace","graphic":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","graphicSource":"counterparty"},"thirdParties":[{"id":"ac48cef2-0d7f-4159-865e-e92b152262bc","name":"Paypal","type":"payment_processor","logo":"https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png","website":"https://www.paypal.com/"}],"spendingInfo":{"channel":{}},"atmInfo":null,"transactionId":"transaction_id_123456789","recurrenceInfo":{"intervalDays":30,"nextPaymentExpected":"2024-08-07","recentRecurrences":["\u003carray>"]},"riskInsights":{"irregularWebPresenceDetected":false,"negativeOnlineSentiment":false,"highRiskEntity":false,"riskyIndustry":false,"cardAcceptanceHistory":"extensive"}},"enrichmentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","counterparty":[{"id":"704bbd58-fb12-4bdb-9aae-2786704ea92a","name":"Amazon","legalName":"Amazon Inc.","industry":[{"id":"011-000-000-000","name":"Retail","icon":"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"}],"matchScore":93.5,"location":[{"id":"fdf79470-3deb-4638-956a-6859e473b9d8","address":"1234 W 5th Ave Suite 100","addressLine1":"1234 W 5th Ave","addressLine2":"Suite 100","city":"New York","region":"NY","country":"USA","postalCode":"10001","latitude":45,"longitude":120,"phoneNumber":"+18664862360","matchScore":93.5}],"logo":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","phoneNumber":"+18664862360","website":"https://www.amazon.com","possibleCounterpartyAlternate":{"id":"49fd51a1-5a19-3e5d-8d28-eb056ecf8939","similarity":80}}],"mobileAppInfo":{"id":"704bbd58-fb12-4bdb-9aae-2786704ea92a","name":"Roblox","url":"https://play.google.com/store/apps/details?id=com.roblox.client","logo":"https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png","developerName":"Roblox Corporation","developerId":"704bbd58-fb12-4bdb-9aae-2786704ea92a","category":"Auto and Transportation","hasGamblingOrRewards":false,"hasSimulatedGambling":false,"ageRating":"Teen"},"customAttributes":{"custom_attribute_1":"value_1","custom_attribute_2":"value_2"},"actions":[{"id":"trigger-12345","type":"merchant_trigger","action":{"type":"REWARD","rewardPercent":5},"scope":"account","source":"counterparty"}]},"transactionInfo":{"transferInfo":null,"isAccountVerification":false,"isPeerToPeer":false,"isDigitalWallet":false,"type":"spending","subType":null,"display":{"name":"Amazon","categoryName":"Online Marketplace","graphic":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","graphicSource":"counterparty"},"thirdParties":[{"id":"ac48cef2-0d7f-4159-865e-e92b152262bc","name":"Paypal","type":"payment_processor","logo":"https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png","website":"https://www.paypal.com/"}],"spendingInfo":{"channel":{}},"atmInfo":null,"transactionId":"transaction_id_123456789","recurrenceInfo":{"intervalDays":30,"nextPaymentExpected":"2024-08-07","recentRecurrences":["\u003carray>"]},"riskInsights":{"irregularWebPresenceDetected":false,"negativeOnlineSentiment":false,"highRiskEntity":false,"riskyIndustry":false,"cardAcceptanceHistory":"extensive"}},"enrichmentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","counterparty":[{"id":"704bbd58-fb12-4bdb-9aae-2786704ea92a","name":"Amazon","legalName":"Amazon Inc.","industry":[{"id":"011-000-000-000","name":"Retail","icon":"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"}],"matchScore":93.5,"location":[{"id":"fdf79470-3deb-4638-956a-6859e473b9d8","address":"1234 W 5th Ave Suite 100","addressLine1":"1234 W 5th Ave","addressLine2":"Suite 100","city":"New York","region":"NY","country":"USA","postalCode":"10001","latitude":45,"longitude":120,"phoneNumber":"+18664862360","matchScore":93.5}],"logo":"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png","phoneNumber":"+18664862360","website":"https://www.amazon.com","possibleCounterpartyAlternate":{"id":"49fd51a1-5a19-3e5d-8d28-eb056ecf8939","similarity":80}}],"mobileAppInfo":{"id":"704bbd58-fb12-4bdb-9aae-2786704ea92a","name":"Roblox","url":"https://play.google.com/store/apps/details?id=com.roblox.client","logo":"https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png","developerName":"Roblox Corporation","developerId":"704bbd58-fb12-4bdb-9aae-2786704ea92a","category":"Auto and Transportation","hasGamblingOrRewards":false,"hasSimulatedGambling":false,"ageRating":"Teen"},"customAttributes":{"custom_attribute_1":"value_1","custom_attribute_2":"value_2"},"actions":[{"id":"trigger-12345","type":"merchant_trigger","action":{"type":"REWARD","rewardPercent":5},"scope":"account","source":"counterparty"}],"reason":"location_correct_spade_verified"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"229ed0de-130a-4c8e-97f4-62445cf9c074":{"description":"Your server returns this code if it accepts the callback","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"74d8d493-09ab-497b-9cd1-0b35c8de8b1c":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"invalidField":{"type":"array","items":{"type":"string","examples":["This field is required."],"uniqueKey":"invalidField.items.[INDEX]","typeLabel":"string"},"uniqueKey":"invalidField","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"invalidField":["This field is required."]}}},"exampleType":"generated"}},"exampleType":"generated"},"c0c53837-f7cd-4ab5-9475-14e119800331":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"details":{"type":"string","examples":["Incorrect authentication credentials."],"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"details":"Incorrect authentication credentials."}}},"exampleType":"generated"}},"exampleType":"generated"},"0eeaea4b-c584-49b4-b82f-d74136bf1d21":{"description":"Unexpected Error","content":{"application/json":{"schema":{"type":"object","properties":{"details":{"type":"string","examples":["Internal server error."],"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"details":"Internal server error."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{}}}}],"security":{"10917285-e513-4c82-ae36-297a8d030eca":{"ApiKeyAuth":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c9d2cfa9-0678-4340-a214-cc7cb1b9b638":{"url":"https://east.sandbox.spade.com","description":"East coast sandbox environment"},"95df7017-26fe-4d52-9462-83df4bb283e4":{"url":"https://east.api.spade.com","description":"East coast production environment"},"4fe8877e-267b-490a-bca6-770866e5257e":{"url":"https://west.sandbox.spade.com","description":"West coast sandbox environment"},"b6f28a59-992c-4046-80b3-36d6eb62fc2b":{"url":"https://west.api.spade.com","description":"West coast production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-Api-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/spec.yml"},"subdomain":"spade-90e401c6","siteName":"Introduction","title":"Report a card enrichment as incorrect - Introduction","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T20:02:06.880Z","originalFileLocation":"api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, incorrectCounterpartyDescription, incorrectLogo, incorrectLogoDescription, incorrectWebsite, incorrectWebsiteDescription, incorrectPhoneNumber, and incorrectPhoneNumberDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Introduction\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Report a card enrichment as incorrect - Introduction\">\u003cmeta data-mint-head property=\"og:description\" content=\"Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, incorrectCounterpartyDescription, incorrectLogo, incorrectLogoDescription, incorrectWebsite, incorrectWebsiteDescription, incorrectPhoneNumber, and incorrectPhoneNumberDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Introduction\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spade-90e401c6.mintlify.site/_mintlify/api/og/v2?division=Feedback+and+Reporting\u0026amp;title=Report+a+card+enrichment+as+incorrect\u0026amp;description=Endpoint+to+report+a+card+enrichment+as+incorrect.+An+%60enrichmentId%60+and+an+%60errorDescription%60+are+required+fields+to+report+an+enrichment.+Optional+request+fie\u0026amp;theme=39dc43271c14138203a30f85\u0026amp;signature=8e158bfa91ceaeac6ac8fe6a2484362d94faa5962b9126ad6933e9d8dc1c21f4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Report a card enrichment as incorrect - Introduction\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, incorrectCounterpartyDescription, incorrectLogo, incorrectLogoDescription, incorrectWebsite, incorrectWebsiteDescription, incorrectPhoneNumber, and incorrectPhoneNumberDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spade-90e401c6.mintlify.site/_mintlify/api/og/v2?division=Feedback+and+Reporting\u0026amp;title=Report+a+card+enrichment+as+incorrect\u0026amp;description=Endpoint+to+report+a+card+enrichment+as+incorrect.+An+%60enrichmentId%60+and+an+%60errorDescription%60+are+required+fields+to+report+an+enrichment.+Optional+request+fie\u0026amp;theme=39dc43271c14138203a30f85\u0026amp;signature=8e158bfa91ceaeac6ac8fe6a2484362d94faa5962b9126ad6933e9d8dc1c21f4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/spade-90e401c6/CDhz3wAAyPlHxqYQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Introduction\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18280E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spade.com/#organization\",\"name\":\"Introduction\",\"url\":\"https://docs.spade.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spade-90e401c6/9HF3Uca9kExHiocb/images/spade-logo-forest.png?fit=max\u0026auto=format\u0026n=9HF3Uca9kExHiocb\u0026q=85\u0026s=04ad3c1e3f4529c5d6c370e693e44807\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spade.com#website\",\"name\":\"Introduction\",\"url\":\"https://docs.spade.com\",\"publisher\":{\"@id\":\"https://docs.spade.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect#webpage\",\"url\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect\",\"name\":\"Report a card enrichment as incorrect\",\"description\":\"Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, incorrectCounterpartyDescription, incorrectLogo, incorrectLogoDescription, incorrectWebsite, incorrectWebsiteDescription, incorrectPhoneNumber, and incorrectPhoneNumberDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\",\"dateModified\":\"2026-10-14T20:02:06.880Z\",\"isPartOf\":{\"@id\":\"https://docs.spade.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Introduction\",\"item\":\"https://docs.spade.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Report a card enrichment as incorrect\",\"item\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect#apireference\",\"headline\":\"Report a card enrichment as incorrect\",\"name\":\"Report a card enrichment as incorrect\",\"description\":\"Endpoint to report a card enrichment as incorrect. An enrichmentId and an errorDescription are required fields to report an enrichment. Optional request fields such as incorrectLocation, incorrectLocationDescription, incorrectCategory, incorrectCategoryDescription, incorrectChannel, incorrectChannelDescription, incorrectCounterparty, incorrectCounterpartyDescription, incorrectLogo, incorrectLogoDescription, incorrectWebsite, incorrectWebsiteDescription, incorrectPhoneNumber, and incorrectPhoneNumberDescription, can be set to indicate what needs to be addressed in the enrichment. Once a report has been addressed, you will receive a corrected enrichment via a callback url you set with Spade. See the callback section to learn more on how we send back a corrected enrichment.\",\"url\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spade.com/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect#webpage\"},\"dateModified\":\"2026-10-14T20:02:06.880Z\",\"publisher\":{\"@id\":\"https://docs.spade.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spade.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Introduction\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Introduction\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect.md","siteName":"Introduction","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/reference/introduction"}]},{"tab":"API Reference","groups":[{"group":"Card Enrichment","pages":[{"title":"Enrich a card transaction","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/cards/enrich","href":"/api-reference/card-enrichment/enrich-a-card-transaction"},{"title":"Enrich a card transaction with an unparsed de43","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/cards/enrich/parse","href":"/api-reference/card-enrichment/enrich-a-card-transaction-with-an-unparsed-de43"},{"title":"Enrich a batch of card transactions","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /batches/transactions/cards/enrich","href":"/api-reference/card-enrichment/enrich-a-batch-of-card-transactions"},{"title":"Get metadata for the batch card enrichment endpoint","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml options /batches/transactions/cards/enrich","href":"/api-reference/card-enrichment/get-metadata-for-the-batch-card-enrichment-endpoint"},{"title":"Enrich a batch of card transactions with DE43 data","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /batches/transactions/cards/enrich/parse","href":"/api-reference/card-enrichment/enrich-a-batch-of-card-transactions-with-de43-data"},{"title":"Get metadata for the batch card parse enrichment endpoint","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml options /batches/transactions/cards/enrich/parse","href":"/api-reference/card-enrichment/get-metadata-for-the-batch-card-parse-enrichment-endpoint"},{"title":"Get the results of a batch card enrichment job","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /batches/{cardEnrichmentBatchId}/results","href":"/api-reference/card-enrichment/get-the-results-of-a-batch-card-enrichment-job"},{"title":"Get the status of a batch card enrichment job","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /batches/{cardEnrichmentBatchId}","href":"/api-reference/card-enrichment/get-the-status-of-a-batch-card-enrichment-job"},{"title":"Enrich a card transaction","deprecated":true,"version":null,"openapi":"/api-reference/spec.yml post /transactions/enrich","href":"/api-reference/card-enrichment/enrich-a-card-transaction-1"},{"title":"Enrich a card transaction with an unparsed de43","deprecated":true,"version":null,"openapi":"/api-reference/spec.yml post /transactions/enrich/parse","href":"/api-reference/card-enrichment/enrich-a-card-transaction-with-an-unparsed-de43-1"}]},{"group":"Transfer Enrichment","pages":[{"title":"Enrich a transfer transaction","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/transfers/enrich","href":"/api-reference/transfer-enrichment/enrich-a-transfer-transaction"},{"title":"Enrich a batch of transfers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /batches/transactions/transfers/enrich","href":"/api-reference/transfer-enrichment/enrich-a-batch-of-transfers"},{"title":"Get metadata for the batch transfer enrichment endpoint","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml options /batches/transactions/transfers/enrich","href":"/api-reference/transfer-enrichment/get-metadata-for-the-batch-transfer-enrichment-endpoint"},{"title":"Get the results of a batch transfer enrichment job","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /batches/{transferEnrichmentBatchId}/results","href":"/api-reference/transfer-enrichment/get-the-results-of-a-batch-transfer-enrichment-job"},{"title":"Get the status of a batch transfer enrichment job","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /batches/{transferEnrichmentBatchId}","href":"/api-reference/transfer-enrichment/get-the-status-of-a-batch-transfer-enrichment-job"}]},{"group":"Universal Enrichment","pages":[{"title":"Enrich a universal transaction","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/universal/enrich","href":"/api-reference/universal-enrichment/enrich-a-universal-transaction"},{"title":"Enrich a batch of universal transactions","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /batches/transactions/universal/enrich","href":"/api-reference/universal-enrichment/enrich-a-batch-of-universal-transactions"},{"title":"Get metadata for the batch universal enrichment endpoint","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml options /batches/transactions/universal/enrich","href":"/api-reference/universal-enrichment/get-metadata-for-the-batch-universal-enrichment-endpoint"},{"title":"Get the results of a batch universal enrichment job","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /batches/{universalEnrichmentBatchId}/results","href":"/api-reference/universal-enrichment/get-the-results-of-a-batch-universal-enrichment-job"},{"title":"Get the status of a batch universal enrichment job","description":"Get the status of a batch universal enrichment job.\n","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /batches/{universalEnrichmentBatchId}","href":"/api-reference/universal-enrichment/get-the-status-of-a-batch-universal-enrichment-job"}]},{"group":"Feedback and Reporting","pages":[{"title":"Report a card enrichment as incorrect","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /transactions/report","href":"/api-reference/feedback-and-reporting/report-a-card-enrichment-as-incorrect"},{"title":"Report that a chargeback occurred","description":"An endpoint for reporting that a chargeback process has occurred on a transaction. The `state` and `chargebackNotes` properties can be used to provide information about the chargeback. The `isFraud`, `fraudType`, and `fraudNotes` are used to provide information about fraud or suspected fraud related to this chargeback. Note that this transaction must previously have been enriched to report the chargeback.\n","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /enrichments/{enrichmentId}/chargeback","href":"/api-reference/feedback-and-reporting/report-that-a-chargeback-occurred"},{"title":"Report that a card decline occurred","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /enrichments/{enrichmentId}/decline","href":"/api-reference/feedback-and-reporting/report-that-a-card-decline-occurred"},{"title":"Report that a refund occurred","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /enrichments/{enrichmentId}/refund","href":"/api-reference/feedback-and-reporting/report-that-a-refund-occurred"},{"title":"Report fraud on a transaction","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /enrichments/{enrichmentId}/fraud","href":"/api-reference/feedback-and-reporting/report-fraud-on-a-transaction"}]},{"group":"Merchant Search","pages":[{"title":"Search for merchants","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /corporations","href":"/api-reference/merchant-search/search-for-merchants"}]},{"group":"Merchant Action Triggers","pages":[{"title":"Get account-level trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /merchant-action-triggers","href":"/api-reference/merchant-action-triggers/get-account-level-trigger-status"},{"title":"Register merchant triggers at account scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /merchant-action-triggers","href":"/api-reference/merchant-action-triggers/register-merchant-triggers-at-account-scope"},{"title":"Clear account-level triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /merchant-action-triggers","href":"/api-reference/merchant-action-triggers/clear-account-level-triggers"},{"title":"Incremental trigger operations at account scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /merchant-action-triggers","href":"/api-reference/merchant-action-triggers/incremental-trigger-operations-at-account-scope"},{"title":"Get program-level trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /programs/{programId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/get-program-level-trigger-status"},{"title":"Register merchant triggers at program scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /programs/{programId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/register-merchant-triggers-at-program-scope"},{"title":"Clear program-level triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /programs/{programId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/clear-program-level-triggers"},{"title":"Incremental trigger operations at program scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /programs/{programId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/incremental-trigger-operations-at-program-scope"},{"title":"Get user-level trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /users/{userId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/get-user-level-trigger-status"},{"title":"Register merchant triggers at user scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /users/{userId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/register-merchant-triggers-at-user-scope"},{"title":"Clear user-level triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/clear-user-level-triggers"},{"title":"Incremental trigger operations at user scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /users/{userId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/incremental-trigger-operations-at-user-scope"},{"title":"Get card-level trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /users/{userId}/cards/{cardId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/get-card-level-trigger-status"},{"title":"Register merchant triggers at card scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /users/{userId}/cards/{cardId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/register-merchant-triggers-at-card-scope"},{"title":"Clear card-level triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/cards/{cardId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/clear-card-level-triggers"},{"title":"Incremental trigger operations at card scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /users/{userId}/cards/{cardId}/merchant-action-triggers","href":"/api-reference/merchant-action-triggers/incremental-trigger-operations-at-card-scope"}]},{"group":"Category Action Triggers","pages":[{"title":"Get account-level category trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /category-action-triggers","href":"/api-reference/category-action-triggers/get-account-level-category-trigger-status"},{"title":"Register category triggers at account scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /category-action-triggers","href":"/api-reference/category-action-triggers/register-category-triggers-at-account-scope"},{"title":"Clear account-level category triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /category-action-triggers","href":"/api-reference/category-action-triggers/clear-account-level-category-triggers"},{"title":"Incremental category trigger operations at account scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /category-action-triggers","href":"/api-reference/category-action-triggers/incremental-category-trigger-operations-at-account-scope"},{"title":"Get program-level category trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /programs/{programId}/category-action-triggers","href":"/api-reference/category-action-triggers/get-program-level-category-trigger-status"},{"title":"Register category triggers at program scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /programs/{programId}/category-action-triggers","href":"/api-reference/category-action-triggers/register-category-triggers-at-program-scope"},{"title":"Clear program-level category triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /programs/{programId}/category-action-triggers","href":"/api-reference/category-action-triggers/clear-program-level-category-triggers"},{"title":"Incremental category trigger operations at program scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /programs/{programId}/category-action-triggers","href":"/api-reference/category-action-triggers/incremental-category-trigger-operations-at-program-scope"},{"title":"Get user-level category trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /users/{userId}/category-action-triggers","href":"/api-reference/category-action-triggers/get-user-level-category-trigger-status"},{"title":"Register category triggers at user scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /users/{userId}/category-action-triggers","href":"/api-reference/category-action-triggers/register-category-triggers-at-user-scope"},{"title":"Clear user-level category triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/category-action-triggers","href":"/api-reference/category-action-triggers/clear-user-level-category-triggers"},{"title":"Incremental category trigger operations at user scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /users/{userId}/category-action-triggers","href":"/api-reference/category-action-triggers/incremental-category-trigger-operations-at-user-scope"},{"title":"Get card-level category trigger status","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /users/{userId}/cards/{cardId}/category-action-triggers","href":"/api-reference/category-action-triggers/get-card-level-category-trigger-status"},{"title":"Register category triggers at card scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /users/{userId}/cards/{cardId}/category-action-triggers","href":"/api-reference/category-action-triggers/register-category-triggers-at-card-scope"},{"title":"Clear card-level category triggers","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/cards/{cardId}/category-action-triggers","href":"/api-reference/category-action-triggers/clear-card-level-category-triggers"},{"title":"Incremental category trigger operations at card scope","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml patch /users/{userId}/cards/{cardId}/category-action-triggers","href":"/api-reference/category-action-triggers/incremental-category-trigger-operations-at-card-scope"}]},{"group":"Category Personalization","pages":[{"title":"Get all default and custom integration-level categories","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /categories","href":"/api-reference/category-personalization/get-all-default-and-custom-integration-level-categories"},{"title":"Create a custom integration-level category","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /categories","href":"/api-reference/category-personalization/create-a-custom-integration-level-category"},{"title":"Delete all custom integration-level categories","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /categories","href":"/api-reference/category-personalization/delete-all-custom-integration-level-categories"},{"title":"Delete a custom integration-level category","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /categories/{id}","href":"/api-reference/category-personalization/delete-a-custom-integration-level-category"},{"title":"Get all integration-level counterparty category personalizations","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /counterparty-category-personalizations","href":"/api-reference/category-personalization/get-all-integration-level-counterparty-category-personalizations"},{"title":"Create an integration-level counterparty category personalization","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /counterparty-category-personalizations","href":"/api-reference/category-personalization/create-an-integration-level-counterparty-category-personalization"},{"title":"Delete all integration-level counterparty category personalizations","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /counterparty-category-personalizations","href":"/api-reference/category-personalization/delete-all-integration-level-counterparty-category-personalizations"},{"title":"Delete a counterparty category personalization","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /counterparty-category-personalizations/{counterpartyId}","href":"/api-reference/category-personalization/delete-a-counterparty-category-personalization"},{"title":"Get categories","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /users/{userId}/categories","href":"/api-reference/category-personalization/get-categories"},{"title":"Create a custom user-level category","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml post /users/{userId}/categories","href":"/api-reference/category-personalization/create-a-custom-user-level-category"},{"title":"Delete all custom user-level categories","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/categories","href":"/api-reference/category-personalization/delete-all-custom-user-level-categories"},{"title":"Delete a custom user-level category","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/categories/{id}","href":"/api-reference/category-personalization/delete-a-custom-user-level-category"},{"title":"Get all user-level counterparty category personalizations","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml get /users/{userId}/counterparty-category-personalizations","href":"/api-reference/category-personalization/get-all-user-level-counterparty-category-personalizations"},{"title":"Create a user-level counterparty category personalization","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml put /users/{userId}/counterparty-category-personalizations","href":"/api-reference/category-personalization/create-a-user-level-counterparty-category-personalization"},{"title":"Delete all user-level counterparty category personalizations","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/counterparty-category-personalizations","href":"/api-reference/category-personalization/delete-all-user-level-counterparty-category-personalizations"},{"title":"Delete a user-level counterparty category personalization","deprecated":null,"version":null,"openapi":"/api-reference/spec.yml delete /users/{userId}/counterparty-category-personalizations/{counterpartyId}","href":"/api-reference/category-personalization/delete-a-user-level-counterparty-category-personalization"}]},{"group":"API Reference","pages":[]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Report a card enrichment as incorrect - Introduction","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","Page-DDHbuAIY.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}