---
title: Chargeback Fields
slug: public-apis/chargeback-fields
createdAt: 2026-03-11T15:18:22.142Z
---

{
  "id": "Pojmf_gVO15ovNTc2zZ5G",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://adi.accertify.net/api/identity/v1/chargeback",
    "name": "Chargeback Fields",
    "description": "The chargeback call is intended to inform us when a user denies a charge and their issuer cancels payment.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "chargeback",
          "type": "object",
          "description": "Fields required for all events. Fields you should send with all events if you have them.",
          "schema": [
            {
              "name": "eventSource",
              "kind": "required",
              "type": "string<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>",
              "description": "<p>[REQUIRED] Required. Where or how the event originated.</p>",
              "enum": [
                "agentPhone",
                "agentStore",
                "affiliate",
                "kiosk",
                "mobileApp",
                "other",
                "web"
              ]
            },
            {
              "name": "transactionID",
              "kind": "required",
              "type": "string",
              "description": "<p>[REQUIRED] Required. Transaction ID associated with the payment being disputed.</p>"
            },
            {
              "name": "chargebackAmount",
              "kind": "required",
              "type": "number",
              "description": "<p>[REQUIRED] Required. Amount associated with the dispute.</p>\n<p><strong>Note</strong>: The format should be numbers and decimal point only. No commas or currency symbols.</p>"
            },
            {
              "name": "currencyCode",
              "kind": "required",
              "type": "string",
              "description": "<p>[REQUIRED] Required. Three-character currency code of the transaction amount formatted in the ISO 4217.</p>"
            },
            {
              "name": "ipAddress",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. User's IP Address you captured. Maximum field length = 45 characters.</p>",
              "example": "192.168.41.17"
            },
            {
              "name": "userAgent",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. User Agent of the user's browser and operating system captured by the site owner. Maximum field length = 250 characters.</p>",
              "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0"
            },
            {
              "name": "devicePayload",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. From Accertify Device, the user's device data sent by our Collector script. You will take the devicePayload from the script and add additional server-side properties to it as described in our \"Device Payload via the Interceptas Platform\" section of our Accertify Data Collector Script Implementation document. Maximum field length = 150,000 characters.</p>\n<p><strong>Note</strong>: We recommend this field for high volume, low latency clients. You can send this instead of the  deviceTransactionID.</p>",
              "example": "afklasdjlasdjl3l23j23423klj"
            },
            {
              "name": "deviceTransactionID",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. From Accertify Device, the device Transaction ID from the Collector JS or SDK file captured by the site or application owner. Maximum field length = 100 characters.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>We recommend you send devicePayload instead of deviceTransactionID. We are leaving this here for backward compatibility.</li>\n<li>You do not have to put in logic to account for deviceTransactionID returning blank. This can happen if JavaScript is blocked or if it is an event taken over the phone.</li>\n</ul>",
              "example": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383"
            },
            {
              "name": "ubaID",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. From Accertify UBA, the ID used to reference behavior data already captured by Accertify. Maximum field length = 100 characters.</p>\n<p>This value is retrieved from:</p>\n<ul>\n<li>Browser from the JavaScript function getToken</li>\n<li>iOS/Android from the SDK?function getUbaId()</li>\n</ul>\n<p><strong>Note</strong>: You do not have to put in logic to account for ubaID returning blank.   This can happen if JavaScript is blocked or if it is an event taken over the phone.</p>",
              "example": "3143e969395de649c48c1c9f3e363a3e7ae7"
            },
            {
              "name": "emailAddress",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. User's email address.</p>"
            },
            {
              "name": "ubaEvents",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. From Accertify UBA, a payload of the most recent fields. This is used to make sure we have up to the second information.</p>",
              "example": "lasjdlkfdsljelkrrjwl3kl324j32k432"
            },
            {
              "name": "pageID",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. From Accertify UBA, the unique page ID defined from the Collector script.</p>",
              "example": "lk32j4lk324lkj324"
            },
            {
              "name": "username",
              "kind": "optional",
              "type": "string",
              "description": "<p>[IMPERATIVE] Imperative. User's username if your site allows logging in using username. Maximum field length = 100 characters.</p>",
              "example": "erlichb"
            },
            {
              "name": "authenticationMethod",
              "kind": "optional",
              "type": "string<appAuthenticator | appPush | FIDO | other | password | magicLink | SMS>",
              "description": "<p>[IMPERATIVE] Imperative. How the user authenticated onto your site.</p>",
              "enum": [
                "appAuthenticator",
                "appPush",
                "FIDO",
                "other",
                "password",
                "magicLink",
                "SMS"
              ]
            },
            {
              "name": "latitude",
              "kind": "optional",
              "type": "number",
              "description": "<p>[OPTIONAL] Optional. The HTML 5 or GPS based latitude location of the user in decimal degrees format without letters. Maximum field length = 10 characters.</p>",
              "example": "Numbers with up to 8 decimals, 58.99993333"
            },
            {
              "name": "longitude",
              "kind": "optional",
              "type": "number",
              "description": "<p>[OPTIONAL] Optional. The HTML 5 or GPS based longitude location of the user in decimal degrees format without letters. Maximum field length = 10 characters.</p>",
              "example": "Numbers with up to 8 decimals, 58.99993333"
            },
            {
              "name": "brand",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. The brand submitting the event. Maximum field length = 50 characters.</p>\n<p><strong>Note</strong>: For clients with multiple brands under one corporate entity.</p>",
              "example": "Acme"
            },
            {
              "name": "sessionID",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. From Accertify UBA, the user's Session ID defined by you for the user's web browsing activity. Maximum field length = 250 characters.</p>",
              "example": "961b521892e68f6c4d1c8459dfb530466eed"
            },
            {
              "name": "ubaSessionID",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. From Accertify UBA, the user's Session ID defined by Accertify for the user's web browsing activity. Maximum field length = 50 characters.</p>\n<p><strong>Note</strong>: Ideally you would send this or your sessionID.</p>",
              "example": "961b521892e68f6c4d1c8459dfb530466eed"
            },
            {
              "name": "accountID",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. User's unique identifier you captured.</p>"
            },
            {
              "name": "chargebackReceivedTimestamp",
              "kind": "optional",
              "type": "string<date>",
              "description": "<p>[OPTIONAL] Optional. Timestamp on the dispute formatted in the ISO-8601 Date format.</p>",
              "format": "date"
            },
            {
              "name": "chargebackCaseNumber",
              "kind": "optional",
              "type": "string",
              "description": "<p>[OPTIONAL] Optional. User's case number provided by the bank.</p>\n<p><strong>Note</strong>: One per case. You may see multiple transactions on a chargeback, so that chargeback case number may not show as unique.</p>"
            },
            {
              "name": "chargebackReason",
              "kind": "optional",
              "type": "string<cancel | duplicateProcessing | fraud | merchandiseNotReceived | notAsDescribed | other | paidByOtherMeans | processingErrors | refundNotProcessed>",
              "description": "<p>[OPTIONAL] Optional. User's stated reason for the dispute.</p>\n<p>Options are:</p>\n<ul>\n<li>cancel</li>\n<li>duplicateProcessing</li>\n<li>fraud</li>\n<li>merchandiseNotReceived</li>\n<li>notAsDescribed</li>\n<li>other</li>\n<li>paidByOtherMeans</li>\n<li>processingErrors</li>\n<li>refundNotProcessed</li>\n</ul>",
              "enum": [
                "cancel",
                "duplicateProcessing",
                "fraud",
                "merchandiseNotReceived",
                "notAsDescribed",
                "other",
                "paidByOtherMeans",
                "processingErrors",
                "refundNotProcessed"
              ]
            },
            {
              "name": "chargebackStatus",
              "kind": "optional",
              "type": "string<won | lost | pending | other>",
              "description": "<p>[OPTIONAL] Optional. On update, send in the status to see if the dispute was won.</p>\n<p>Options are:</p>\n<ul>\n<li>won</li>\n<li>lost</li>\n<li>pending</li>\n<li>other</li>\n</ul>",
              "enum": [
                "won",
                "lost",
                "pending",
                "other"
              ]
            },
            {
              "name": "addresses",
              "kind": "optional",
              "type": "array",
              "description": "Array introducing the addresses block.",
              "example": "",
              "itemType": "object",
              "customType": "object[]",
              "schema": [
                {
                  "name": "addressID",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Identifier you define to an address to differentiate orders with multiples. Maximum field length = 20 characters.</p>",
                  "example": "23kj423klj234j"
                },
                {
                  "name": "addressType",
                  "kind": "optional",
                  "type": "string<account | billing | bopis | curbside | departure | destination | fulfillment | listing | lodging | pickup | return | shipping | venue | other>",
                  "description": "<p>Optional. The type of address being collected.</p>\n<p>Options are:</p>\n<ul>\n<li>account</li>\n<li>billing</li>\n<li>bopis</li>\n<li>curbside</li>\n<li>departure</li>\n<li>destination</li>\n<li>fulfillment</li>\n<li>listing</li>\n<li>lodging</li>\n<li>pickup</li>\n<li>return</li>\n<li>shipping</li>\n<li>venue</li>\n<li>other</li>\n</ul>",
                  "enum": [
                    "account",
                    "billing",
                    "bopis",
                    "curbside",
                    "departure",
                    "destination",
                    "fulfillment",
                    "listing",
                    "lodging",
                    "pickup",
                    "return",
                    "shipping",
                    "venue",
                    "other"
                  ]
                },
                {
                  "name": "primaryFlag",
                  "kind": "optional",
                  "type": "boolean",
                  "description": "<p>Optional. Whether the address is marked as user's primary address.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                  "enum": [
                    "true",
                    "false"
                  ]
                },
                {
                  "name": "isAddressOnFile",
                  "kind": "optional",
                  "type": "boolean",
                  "description": "<p>Optional. Whether the address for this action matches the address you have on file for this action.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                  "example": "Whether the shipping address is the same as the shipping address for this account.",
                  "enum": [
                    "true",
                    "false"
                  ]
                },
                {
                  "name": "firstName",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address owners's first name. Maximum field length = 40 characters.</p>",
                  "example": "Jane"
                },
                {
                  "name": "middleName",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address owner's middle name. Maximum field length = 20 characters.</p>",
                  "example": "Marie"
                },
                {
                  "name": "lastName",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address owner's last name. Maximum field length = 40 characters.</p>",
                  "example": "Doe"
                },
                {
                  "name": "emailAddress",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. User's supplied email address. Maximum field length = 100 characters.</p>",
                  "example": "jane.doe123@gmail.com"
                },
                {
                  "name": "phone",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. User's supplied phone number. Maximum field length = 25 characters.</p>\n<p><strong>Note</strong>: Do not include country prefix.</p>",
                  "example": 2128387654
                },
                {
                  "name": "phoneCountryCode",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Country prefix associated with the phone number.</p>\n<p><strong>Note</strong>: Do not include the + symbol.</p>",
                  "example": 123
                },
                {
                  "name": "address1",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address line one of the address that belongs to the account. Maximum field length = 40 characters.</p>",
                  "example": "123 Main Street"
                },
                {
                  "name": "address2",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address line two of the address that belongs to the account. Maximum field length = 40 characters.</p>",
                  "example": "Apartment 456"
                },
                {
                  "name": "city",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address city. Maximum field length = 40 characters.</p>",
                  "example": "Itasca"
                },
                {
                  "name": "region",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. ISO 3166-2 state, province, or region code. Minimum field length = 1 character. Maximum field length = 3 characters.</p>\n<p><strong>Note</strong>: For US and Canada, must be state or province.</p>",
                  "example": "IL"
                },
                {
                  "name": "postCode",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Address postal code. Maximum field length = 20 characters.</p>\n<p><strong>Note</strong>: If you send the 9-digit extended postal code for U.S. addresses, you must include a hyphen to separate the last 4 digits from the first 5.</p>",
                  "example": "60143-0001"
                },
                {
                  "name": "country",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Two-letter ISO code for country formatted in ISO 3166-1.</p>",
                  "example": "US"
                },
                {
                  "name": "companyName",
                  "kind": "optional",
                  "type": "string",
                  "description": "<p>Optional. Company name associated with the address. Maximum field length = 50 characters.</p>",
                  "example": "Accertify, Inc"
                },
                {
                  "name": "locationType",
                  "kind": "optional",
                  "type": "string<business | redirect | residence | siteToStore | other>",
                  "description": "<p>Optional. Address location type.</p>\n<p>Options are:</p>\n<ul>\n<li>business</li>\n<li>redirect</li>\n<li>residence</li>\n<li>siteToStore</li>\n<li>other</li>\n</ul>",
                  "enum": [
                    "business",
                    "redirect",
                    "residence",
                    "siteToStore",
                    "other"
                  ]
                },
                {
                  "name": "addressCreatedDateTime",
                  "kind": "optional",
                  "type": "string<date-time>",
                  "description": "<p>Optional. The date the address was created formatted yyyy-MM-dd'T'HH:mm</p><div></div>.<p></p>",
                  "example": "2020-03-28T17:07:24-07:00",
                  "format": "date-time"
                },
                {
                  "name": "addressUpdatedDateTime",
                  "kind": "optional",
                  "type": "string<date-time>",
                  "description": "<p>Optional. The date the address was updated formatted yyyy-MM-dd'T'HH:mm</p><div></div>.<p></p>",
                  "example": "2021-03-28T17:07:24-07:00",
                  "format": "date-time"
                }
              ]
            }
          ],
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Success response with no recommendation code",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"eventID\":\"GK76NPO=zaeit1di9+DCJEDYUAvu90hLEvc\",\"eventDetails\":{\"deviceDetails\":{\"browserSpoofRisk\":\"noRisk\",\"deviceIDConfidence\":100,\"deviceIDNew\":false,\"browserIsMobile\":false,\"mobileIsRooted\":false,\"deviceIDFirstSeen\":1629754353000,\"browserNewCookie\":false,\"deviceIDTimesSeen\":14,\"mobileApp\":\"false\",\"browserReplayTagStatus\":\"VALID\",\"deviceID\":\"c3e67da3-2eaa-4d40-a7ce-74f8118ba5d9\"},\"connectionDetails\":{\"hostingIndicator\":false,\"isTor\":false,\"hostingIndicatorReal\":false,\"realIPMatch\":\"true\",\"countryCode\":\"US\",\"countryCodeReal\":\"US\",\"isProxy\":false}},\"messages\":{\"warning\":[],\"error\":[],\"info\":[]},\"results\":{\"riskScore\":{\"score\":0,\"degenerateObject\":{\"objectType\":\"ipAddress\",\"objectValue\":\"192.111.111.19\"},\"insights\":[\"emailAliased\"]}},\"status\":true}",
            "description": "Success response with no recommendation code",
            "customType": "successResponseNoRec",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "eventID",
                "kind": "optional",
                "type": "string",
                "description": "Event unique identifier.\n"
              },
              {
                "name": "eventDetails",
                "kind": "optional",
                "type": "object",
                "description": "Details about the device and connection of this event.",
                "example": "",
                "schema": [
                  {
                    "name": "deviceDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "Details about the device used during this event.",
                    "example": "",
                    "schema": [
                      {
                        "name": "browserSpoofRisk",
                        "kind": "optional",
                        "type": "string<noRisk | mediumRisk | highRisk | browsersOnly>",
                        "description": "<p>The likelihood that the browser is spoofed based on the installed font list.</p>\n<p>The values are:</p>\n<ul>\n<li>noRisk</li>\n<li>mediumRisk</li>\n<li>highRisk</li>\n<li>browsersOnly</li>\n</ul>",
                        "enum": [
                          "noRisk",
                          "mediumRisk",
                          "highRisk",
                          "browsersOnly"
                        ]
                      },
                      {
                        "name": "deviceIDConfidence",
                        "kind": "optional",
                        "type": "number",
                        "description": "<p>A percentage indicating the confidence in the global device ID (GDIS), 100% being the highest.</p>"
                      },
                      {
                        "name": "deviceIDNew",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the Global Device Identifier was newly generated for that session.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                        "enum": [
                          "true",
                          "false"
                        ]
                      },
                      {
                        "name": "browserIsMobile",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the browser is instructed to load an m-dot site, indicating a mobile browser.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                        "enum": [
                          "true",
                          "false"
                        ]
                      },
                      {
                        "name": "mobileIsRooted",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the mobile device has root privileges which overcome the limitations that carriers and hardware manufacturers put on some devices.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                        "enum": [
                          "true",
                          "false"
                        ]
                      },
                      {
                        "name": "deviceIDFirstSeen",
                        "kind": "optional",
                        "type": "number",
                        "description": "The global timestamp first seen in Epoch date and time in milliseconds.\n"
                      },
                      {
                        "name": "browserNewCookie",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the cookie for the browser site was newly generated for that session. Browsers only.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                        "enum": [
                          "true",
                          "false"
                        ]
                      },
                      {
                        "name": "deviceIDTimesSeen",
                        "kind": "optional",
                        "type": "number",
                        "description": "Number of times the device has been previously seen globally.\n"
                      },
                      {
                        "name": "mobileApp",
                        "kind": "optional",
                        "type": "string<true | false | null>",
                        "description": "<p>Whether the event was generated via a mobile application.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n<li>null (if unable to determine)</li>\n</ul>",
                        "enum": [
                          "true",
                          "false",
                          "null"
                        ]
                      },
                      {
                        "name": "browserReplayTagStatus",
                        "kind": "optional",
                        "type": "string<valid | invalidReplay | invalidExpired | invalidTampered | missing>",
                        "description": "<p>Whether the data from the transaction was replayed within a time threshold.</p>\n<p>Statuses are:</p>\n<ul>\n<li>valid: The data from the transaction was not replayed and within the time threshold.</li>\n<li>invalidReplay: The data was replayed by a client.</li>\n<li>invalidExpired: The data was received outside of the time threshold.</li>\n<li>invalidTampered: The replay tag was received but was tampered with.</li>\n<li>missing: The replay tag was missing from the request.</li>\n</ul>",
                        "enum": [
                          "valid",
                          "invalidReplay",
                          "invalidExpired",
                          "invalidTampered",
                          "missing"
                        ]
                      },
                      {
                        "name": "deviceID",
                        "kind": "optional",
                        "type": "string",
                        "description": "The Global Device Identifier defined by Accertify.\n"
                      }
                    ]
                  },
                  {
                    "name": "connectionDetails",
                    "kind": "optional",
                    "type": "object",
                    "description": "Details about the connection the user is utilizing\n",
                    "example": "",
                    "schema": [
                      {
                        "name": "realIPMatch",
                        "kind": "optional",
                        "type": "string<true | false | NA>",
                        "description": "<p>Whether the device's Real IP matches the IP Address provided by you.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n<li>NA (if one or both fields are unpopulated).</li>\n</ul>",
                        "enum": [
                          "true",
                          "false",
                          "NA"
                        ]
                      },
                      {
                        "name": "isProxy",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "If the user was using an anonymized connection. Browsers only.\n"
                      },
                      {
                        "name": "isTor",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>If the user's proxy is part of the Tor network, encrypting a user through a regularly changing series of nodes operated by volunteers. Browsers only.</p>"
                      },
                      {
                        "name": "carrierCode",
                        "kind": "optional",
                        "type": "string",
                        "description": "The Internet Service Provider who registered the IP.\n"
                      },
                      {
                        "name": "carrierCodeReal",
                        "kind": "optional",
                        "type": "string",
                        "description": "The carrierCode associated with the Real IP Address.\n"
                      },
                      {
                        "name": "connectionType",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>The way a user is connected to the internet.</p>\n<p><strong>Example</strong>: DSL, Cable, Mobile Wireless, and so forth.</p>\n<p><strong>Note</strong>: The type of connection corresponds to other considerations like IP assignment duration and geolocation granularity.</p>"
                      },
                      {
                        "name": "connectionTypeReal",
                        "kind": "optional",
                        "type": "string",
                        "description": "The connectionType associated with the Real IP Address.\n"
                      },
                      {
                        "name": "hostingIndicator",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the IP Address comes from a hosting facility.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                        "enum": [
                          "true",
                          "false"
                        ]
                      },
                      {
                        "name": "hostingIndicatorReal",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the hostingIndicator is associated with the Real IP Address.</p>\n<p>Options are:</p>\n<ul>\n<li>true</li>\n<li>false</li>\n</ul>",
                        "enum": [
                          "true",
                          "false"
                        ]
                      },
                      {
                        "name": "regOrgCode",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>A sub-hierarchy associated with the carrierCode.</p>\n<p><strong>Example</strong>: If carrierCode is Xfinity Communications, the regOrgCode could be Xfinity Business Services.</p>"
                      },
                      {
                        "name": "regOrgCodeReal",
                        "kind": "optional",
                        "type": "string",
                        "description": "The regOrgCode associated with the Real IP Address.\n"
                      },
                      {
                        "name": "countryCode",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>Two-letter ISO code for country formatted in ISO-3166-1.</p>"
                      },
                      {
                        "name": "countryCodeReal",
                        "kind": "optional",
                        "type": "string",
                        "description": "The countryCode associated with the Real IP Address.\n"
                      },
                      {
                        "name": "routingType",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>How the connection is routed through the Internet. This is a hierarchy above connectionType.</p>\n<p><strong>Example</strong>: Fixed, regional proxy, satellite; a DSL or Cable connectionType would fall under Fixed routing.</p>"
                      },
                      {
                        "name": "routingTypeReal",
                        "kind": "optional",
                        "type": "string",
                        "description": "The routingType associated with the Real IP Address.\n"
                      }
                    ]
                  }
                ]
              },
              {
                "name": "results",
                "kind": "optional",
                "type": "object",
                "description": "Breakdown of the risk assessment for a given event.",
                "example": "",
                "schema": [
                  {
                    "name": "riskScore",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "example": "",
                    "schema": [
                      {
                        "name": "score",
                        "kind": "optional",
                        "type": "number",
                        "description": "The risk Score for this event."
                      },
                      {
                        "name": "degenerateObject",
                        "kind": "optional",
                        "type": "object",
                        "description": "<p>Warning against credential-stuffing attack.</p>",
                        "example": "",
                        "schema": [
                          {
                            "name": "objectType",
                            "kind": "optional",
                            "type": "string",
                            "description": "<p>The attacking field, such as ipAddress.</p>"
                          },
                          {
                            "name": "objectValue",
                            "kind": "optional",
                            "type": "string",
                            "description": "<p>The attacking value of the field, such as 192.111.111.19.</p>\n<p><strong>Note</strong>: You should block these values for 4 hours to turn away attackers.</p>"
                          }
                        ]
                      },
                      {
                        "name": "insights",
                        "kind": "optional",
                        "type": "array",
                        "description": "<p>Specific facts about an event.</p>\n<p><strong>Example</strong>: multipleAccounts means this device has accesed multiple accounts.</p>",
                        "example": "",
                        "itemType": "string",
                        "customType": "string[]",
                        "itemExample": "",
                        "itemDefault": ""
                      }
                    ]
                  },
                  {
                    "name": "listHits",
                    "kind": "optional",
                    "type": "object",
                    "description": "Positively or negatively flagged attributes.",
                    "example": "",
                    "schema": [
                      {
                        "name": "negativeValues",
                        "kind": "optional",
                        "type": "array",
                        "description": "Negatively flagged attributes.",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "itemExample": "",
                        "itemDefault": ""
                      },
                      {
                        "name": "positiveValues",
                        "kind": "optional",
                        "type": "array",
                        "description": "Positively flagged attributes.",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "itemExample": "",
                        "itemDefault": ""
                      }
                    ]
                  }
                ]
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/successResponseNoRec",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Bad Request. Usually indicates a message that cannot be parsed or fails validation.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Bad Request. Usually indicates a message that cannot be parsed or fails validation.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Unauthorized. Invalid credentials.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Unauthorized. Invalid credentials.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "403",
        "description": "Forbidden. Event was stopped by Gatekeeper checks.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Forbidden. Event was stopped by Gatekeeper checks.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "405",
        "description": "Method Not Allowed. Indicates an HTTP request method other than POST.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Method Not Allowed. Indicates an HTTP request method other than POST.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "412",
        "description": "Precondition Failed. Exceeded event rate limit for test API configurations.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Precondition Failed. Exceeded event rate limit for test API configurations.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "429",
        "description": "Too Many Requests. Rate limit exceeded.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Too Many Requests. Rate limit exceeded.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal Server Error.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "example": "{\"messages\":{\"warning\":[],\"error\":[\"card number appears to be plaintext\"],\"info\":[]},\"status\":false}",
            "description": "Internal Server Error.",
            "customType": "errorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "boolean",
                "description": "Event processing is successful or failed."
              },
              {
                "name": "messages",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "error",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "warning",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "info",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/errorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://adi.accertify.net/api/identity/v1/chargeback \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"eventSource\": \"\",\n     \"transactionID\": \"\",\n     \"chargebackAmount\": \"\",\n     \"currencyCode\": \"\"\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"eventSource\": \"\",\n   \"transactionID\": \"\",\n   \"chargebackAmount\": \"\",\n   \"currencyCode\": \"\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://adi.accertify.net/api/identity/v1/chargeback\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://adi.accertify.net/api/identity/v1/chargeback\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"eventSource\": \"\",\n   \"transactionID\": \"\",\n   \"chargebackAmount\": \"\",\n   \"currencyCode\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://adi.accertify.net/api/identity/v1/chargeback\"\n\npayload = json.dumps({\n   \"eventSource\": \"\",\n   \"transactionID\": \"\",\n   \"chargebackAmount\": \"\",\n   \"currencyCode\": \"\"\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Success response with no recommendation code\n{\n  \"status\": false,\n  \"eventID\": \"\",\n  \"eventDetails\": {\n    \"deviceDetails\": {\n      \"browserSpoofRisk\": \"\",\n      \"deviceIDConfidence\": 0,\n      \"deviceIDNew\": false,\n      \"browserIsMobile\": false,\n      \"mobileIsRooted\": false,\n      \"deviceIDFirstSeen\": 0,\n      \"browserNewCookie\": false,\n      \"deviceIDTimesSeen\": 0,\n      \"mobileApp\": \"\",\n      \"browserReplayTagStatus\": \"\",\n      \"deviceID\": \"\"\n    },\n    \"connectionDetails\": {\n      \"realIPMatch\": \"\",\n      \"isProxy\": false,\n      \"isTor\": false,\n      \"carrierCode\": \"\",\n      \"carrierCodeReal\": \"\",\n      \"connectionType\": \"\",\n      \"connectionTypeReal\": \"\",\n      \"hostingIndicator\": false,\n      \"hostingIndicatorReal\": false,\n      \"regOrgCode\": \"\",\n      \"regOrgCodeReal\": \"\",\n      \"countryCode\": \"\",\n      \"countryCodeReal\": \"\",\n      \"routingType\": \"\",\n      \"routingTypeReal\": \"\"\n    }\n  },\n  \"results\": {\n    \"riskScore\": {\n      \"score\": 0,\n      \"degenerateObject\": {\n        \"objectType\": \"\",\n        \"objectValue\": \"\"\n      },\n      \"insights\": [\n        \"\"\n      ]\n    },\n    \"listHits\": {\n      \"negativeValues\": [\n        {}\n      ],\n      \"positiveValues\": [\n        {}\n      ]\n    }\n  },\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Bad Request. Usually indicates a message that cannot be parsed or fails validation.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Unauthorized. Invalid credentials.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-3-403",
          "language": "403",
          "code": "// Forbidden. Event was stopped by Gatekeeper checks.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-4-405",
          "language": "405",
          "code": "// Method Not Allowed. Indicates an HTTP request method other than POST.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-5-412",
          "language": "412",
          "code": "// Precondition Failed. Exceeded event rate limit for test API configurations.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-6-429",
          "language": "429",
          "code": "// Too Many Requests. Rate limit exceeded.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        },
        {
          "id": "response-7-500",
          "language": "500",
          "code": "// Internal Server Error.\n{\n  \"status\": false,\n  \"messages\": {\n    \"error\": [\n      \"\"\n    ],\n    \"warning\": [\n      \"\"\n    ],\n    \"info\": [\n      \"\"\n    ]\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}