Universal Enrichment

Get the results of a batch universal enrichment job

Get the results of a batch universal enrichment job.

get/batches/{universalEnrichmentBatchId}/results

Request

  • Base URL
    https://east.sandbox.spade.com
  • URL
    https://east.sandbox.spade.com/batches/{universalEnrichmentBatchId}/results
  • Auth
    API key in header X-Api-Key

Response

Successful operation

Example response

{
  "results": [
    {
      "transactionInfo": {
        "type": "spending",
        "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/"
          }
        ],
        "recurrenceInfo": {
          "intervalDays": 30,
          "nextPaymentExpected": "2024-08-07"
        },
        "display": {
          "name": "Amazon",
          "categoryName": "Online Marketplace",
          "graphic": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
          "graphicSource": "counterparty"
        },
        "transferInfo": {
          "direction": "outgoing",
          "transferMethod": "ach",
          "transferType": "external"
        },
        "atmInfo": {
          "sponsorName": "Fiserv",
          "ownerName": "Wells Fargo"
        },
        "transactionId": "transaction_id_123456789",
        "riskInsights": {
          "cardAcceptanceHistory": "extensive"
        }
      },
      "counterparty": [
        {
          "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
            }
          ],
          "possibleCounterpartyAlternate": {
            "id": "49fd51a1-5a19-3e5d-8d28-eb056ecf8939",
            "similarity": 80
          },
          "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,
          "logo": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
          "phoneNumber": "+18664862360",
          "website": "https://www.amazon.com"
        }
      ],
      "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",
        "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"
        }
      ],
      "statusCode": 200,
      "errors": {
        "userId": [
          "This field is required."
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.