Skip to main content
POST
Report a card enrichment as incorrect

Authorizations

X-Api-Key
string
header
required

Body

application/json

Schema for reporting an enriched transaction.

enrichmentId
string<uuid>
required

Enrichment id represented as a string UUID.

errorDescription
string
required

Description of incorrect details in enrichment.

Maximum string length: 1024
Example:

"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."

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.

Maximum string length: 1024
Example:

"The phone number is disconnected."

Callbacks

POST
https://example.com/your/callback/endpointCorrectedEnrichment

Body

application/json

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.

transactionInfo
object
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.

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.

customAttributes
object

A dictionary containing the custom attributes that were included in the enrichment request (if any).

Example:
actions
object[] | null

An array of triggered actions, or null if no triggers matched. This field is only present if your integration has the actions feature enabled.

When a transaction matches one or more registered triggers, this array contains the action details including your custom action data. Multiple matches are possible when triggers are registered at different scopes (account, program, user, card).

Example:
reason
string | null

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."