Payments
Insights

The Card Insights API allows you to perform address verification (AVS), name verification (ANI), CVV, email, and phone verification checks. You can also check the card's push and pull transaction capabilities and retrieve the Payment Account Reference (PAR).

Provide exactly one credential per request: either a card or a networkToken.

post/insights/cards

Request

Request body

extensionsstring[]

The extensions to the card insight request.

emailstring

The cardholder's email address that the email verification is for. Required if the email extension is requested.

phonestring

The cardholder's phone number, in ISD format (00 followed by the country calling code and the national number), that the phone verification is for. Required if the phone extension is requested.

externalCustomerReferencestring

An optional reference of your choice, such as a correlation ID, that is attached to the request. The reference will be visible in your logs. Must be between 1 and 255 characters.

Example request

{
  "card": {
    "number": "4111111111111111",
    "expiry": {
      "month": "12",
      "year": "29"
    },
    "cvv": "123"
  },
  "networkToken": {
    "number": "4111111111111111",
    "cryptogram": "AgAAAAAABk4DdZzBRckAAAAA",
    "expiry": {
      "month": "12",
      "year": "29"
    },
    "transactionIdentifier": "1234567890",
    "brand": "visa",
    "funding": "credit",
    "eci": "05"
  },
  "cardholder": {
    "firstName": "John",
    "lastName": "Doe",
    "middleName": "Michael",
    "suffix": "Jr",
    "ownerType": "primary"
  },
  "email": "john.doe@example.com",
  "phone": "0016505551234",
  "address": {
    "postalCode": "10001",
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "New York",
    "state": "ny",
    "country": "us"
  },
  "externalCustomerReference": "00-4bf92f3577b34da6a3ce929d3e0e4736-00f067aa0ba902b7-01"
}

Response

Returns the Card Insight object

idstring required

The unique identifier for the Card Insight

fingerprintstring

A unique, cryptographically secure identifier for the card number. Useful for deduplication.

feesunknown
paymentAccountReferencestring

The unique identifier of the Payment Account associated with this card.

createdAtinteger required

Unix timestamp of when the card insight was created

Example response

{
  "id": "card_insight_1234567890",
  "fingerprint": "WUlcOAgQcTN1GEUaoaKrLH1wL2PZrjsUS7byUGZyUEA",
  "bin": {
    "brand": "visa",
    "funding": "credit",
    "segment": "consumer",
    "country": "us",
    "currency": "usd",
    "issuer": "Gringotts Wizarding Bank and Trust Company",
    "productName": "Visa Credit",
    "fastFunds": {
      "domestic": true,
      "crossBorder": true
    },
    "matchPrecision": 8,
    "threeDS": {
      "supportedVersions": {
        "accessControlServer": [
          "2.2.0"
        ],
        "directoryServer": [
          "2.2.0",
          "2.3.1"
        ]
      },
      "acsInfoIndicators": [
        {
          "code": "acs-auth-available",
          "indicator": "01",
          "description": "Authentication Available at ACS"
        }
      ]
    },
    "type": "card"
  },
  "capabilities": {
    "push": {
      "enabled": true,
      "network": "visa",
      "type": "credit",
      "availability": "immediate",
      "regulated": true,
      "currency": {
        "alphaCode": "usd",
        "numericCode": "840"
      },
      "country": {
        "alphaCode": "us",
        "numericCode": "840"
      }
    },
    "pull": {
      "enabled": true,
      "network": "visa",
      "type": "credit",
      "regulated": true,
      "currency": {
        "alphaCode": "usd",
        "numericCode": "840"
      },
      "country": {
        "alphaCode": "us",
        "numericCode": "840"
      }
    }
  },
  "fees": null,
  "cvv": {
    "code": "match",
    "value": "M"
  },
  "email": {
    "value": "1",
    "code": "match"
  },
  "phone": {
    "value": "1",
    "code": "match"
  },
  "address": {
    "networkIdentifier": "1234567890",
    "networkResponseCode": {
      "code": null,
      "value": "85"
    },
    "result": {
      "value": "Y",
      "address": "match",
      "zip": "match"
    }
  },
  "cardholder": {
    "result": {
      "value": "M",
      "code": "match-performed"
    },
    "fullName": {
      "value": "M",
      "code": "match"
    },
    "firstName": {
      "value": "M",
      "code": "match"
    },
    "lastName": {
      "value": "M",
      "code": "match"
    }
  },
  "paymentAccountReference": "V0010011111111111111111111111",
  "createdAt": 169297262323
}

Changes

    • breaking

      added to the / request property allOf list

    • breaking

      the / request property type changed from object to no type

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to null for status

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new U enum value to the // response property for the response status

    • warning

      added the new U enum value to the // response property for the response status

    • warning

      added the new U enum value to the // response property for the response status

    • warning

      added the new unsupported enum value to the // response property for the response status

    • warning

      added the new unsupported enum value to the // response property for the response status

    • warning

      added the new unsupported enum value to the // response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the new email enum value to the request property /

    • info

      added the new paymentAccountReference enum value to the request property /

    • info

      added the new phone enum value to the request property /

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      response property fees deprecated

    • info

      endpoint added