---
title: "Create Kount Inquiry"
method: POST
path: "/kount-inquiries"
tags: ["Kount"]
---

# Create Kount Inquiry

`POST /kount-inquiries`

## Request body

- KountInquiryRequest
  - `idempotencyKey` string, required — A Unique Identifier that is required for handling idempotent requests. Note: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key."
  - `orderId` string, nullable — Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction **Note**: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.
  - `kountAccountId` string, required — 6 digit local identifier used by the merchant to identify the kount inquiry request
  - `kountApiKey` string, required — The API key for the associated with the Kount Merchant ID
  - `originatedFromCallCenter` boolean, required — Refers to Kount's Call center indicator. Flag indicating whether risk inquiry request originates from a call center environment If the customer service agents navigate to a separate order entry page that does not collect iframe data: When sending the kount_inquiry request, set call_center_ind to Y If the customer service agents navigate to the same order entry page as the customer: When sending the kount_inquiry request, set call_center_ind to N If Risk Inquiry Service call does not originate from a call center environment, set call_center_ind to N True for YES, False fo NO
  - `sessionId` string, required — Unique Session ID; must be unique over a 30-day span
  - `websiteId` string, required — Website identifier of where order originated
  - `paymentDetails` union, required — Payment Data
    - KountPaymentId — Payment Id
      - `paymentId` string, required — Unique Identification for the Payment
    - KountValidationId — Validation Id
      - `validationId` string, required — Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.
      - `amount` Money, required — Monetary amount. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
        - `amount` integer, required — Amount
        - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217
    - KountPaymentData — Payment Data
      - `amount` Money, required — Monetary amount. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
        - `amount` integer, required — Amount
        - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217
      - `customerId` string, nullable — Unique Identification for the Customer
      - `customerReference` string, nullable — Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.
      - `lastFour` string, nullable — Last 4 digits of the card.
      - `paymentToken` string, required — Payment token submitted by merchant for order (credit card, payer ID, routing/transit, MICR, and account number). If paymentType is set to NONE then the paymentToken value should be left empty (NULL). If the credit card information is not available and Moneris Tokenization is used to process payment set paymentType = CARD and send the token in the paymentToken field.
      - `paymentType` 'APPLE_PAY' | 'CARD' | 'PAYPAL' | 'CHECK' | 'NONE' | 'GREEN_DOT_MONEY_PACK' | 'BILL_ME_LATER' | 'GIFT_CARD' | 'BPAY' | 'NETELLER' | 'GIROPAY' | 'ELV' | 'MERCADE_PAGO' | 'SINGLE_EURO_PAYMENT_AREA' | 'INTERAC' | 'CARTE_BLEUE' | 'POLI' | 'SKRILL_MONEY_BOOKERS' | 'SOFORT', required — Payment Type submitted by merchant. If the credit card information is not available and Moneris Tokenization is used to process payment set paymentType = CARD and send the token in the paymentToken field.
  - `email` string, email, required — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322
  - `products` KountProductItem[], required — List of product items part of the transaction
    - `itemId` string, required — Item unique identifier.
    - `itemType` string, required — High level description of an item
    - `itemQuantity` integer, nullable — Quantity invoiced for this line item.
    - `itemName` string, nullable — Item Name
    - `itemAmount` object, nullable — Contains the individual item amount that is normally calculated as price multiplied by quantity. The value must be in cents. Therefore $10.59 must be sent as 1059
      - `amount` integer, required — Amount
      - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217
  - `automaticNumberId` string, nullable — Automatic Number Identification (ANI) submitted with order If the ANI cannot be determined, merchant must pass 0123456789 as the ANID NOTE: This field is only valid for phone-to-web requests where customer service agents navigate to a separate order entry page that does not collect iframe data Risk Inquiry Service submissions
  - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided.
    - `unitNumber` string, nullable — Unit number
    - `streetNumber` string, nullable — Street number
    - `streetName` string, nullable — Street name
    - `city` string, nullable — Identifies the city.
    - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code
    - `postalCode` string, nullable — Postal or zip code
    - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
  - `shippingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided.
    - `unitNumber` string, nullable — Unit number
    - `streetNumber` string, nullable — Street number
    - `streetName` string, nullable — Street name
    - `city` string, nullable — Identifies the city.
    - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code
    - `postalCode` string, nullable — Postal or zip code
    - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
  - `dateOfBirth` string, date, nullable — Date of Birth.
  - `timestamp` string, date-time, nullable — This is timestamp associated with the creation of a user in Kount service.
  - `gender` 'MALE' | 'FEMALE' | 'null', nullable — An individual's gender
  - `customerName` string, nullable — Customers full name
  - `financialOrderId` string, nullable — Unique identifier for transactions at Kount
  - `shippingType` 'SAME_DAY' | 'NEXT_DAY' | 'SECOND_DAY' | 'STANDARD' | 'null', nullable — Shipping type. The following nomenclature is expected for shipping types to be passed to Kount. NOTE:These three attributes can be used to pass custom attribute data if you want to correlate some data with the returned response
  - `ipv4` string, ipv4, required — Internet Protocol version 4 (IPv4).
  - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

## Response `201`

Kount Inquiry was successfully approved.

- KountInquiry — Object of Kount response parameters
  - `kountInquiryId` string, required — Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.
  - `orderId` string, nullable, required — Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction **Note**: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.
  - `kountResult` 'APPROVED' | 'DECLINED' | 'UNDER_REVIEW', required — Auto-decision response
  - `fraudScore` integer, nullable — Final risk score returned from Kount system
  - `kountTransactionId` string, required — Kount Transaction ID
  - `browser` string, nullable — Web Browser
  - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'JCB' | 'DISCOVER' | 'INTERAC' | 'UNIONPAY' | 'GIFT_MONERIS' | 'GIFT_DATACANDY' | 'GIFT_GIVEX' | 'null', nullable — Displays the card brand name associated with the card type.
  - `associatedCardCount` integer, nullable — Total number of credit cards associated to persona as seen by Kount
  - `cookiesEnabled` boolean, nullable — A flag to indicate if device placing order has cookies enabled or not
  - `countersTriggered` KountTriggeredCounter[] — Counters triggered during rules evaluation
    - `name` string, required — Counter Name
    - `value` number, double, nullable — The sum of the number of times a counter was triggered.
  - `country` string, iso-3166, nullable — Two-character ISO country code associated with the physical device
  - `deviceFirstSeenAt` string, date, nullable — Date device first seen
  - `deviceLayers` string, nullable — 5 device layers that comprise the device's fingerprint, representing OS, browser, Javascript, cookies and Flash settings
  - `deviceCount` integer, nullable — Total number of unique devices associated to persona as seen by Kount
  - `deviceScreenResolution` string, nullable — Device Screen Resolution
  - `emailCount` integer, nullable — Total number of unique email addresses associated to persona as seen by Kount
  - `errorCount` integer, nullable — Number of errors the Kount request generated
  - `errorCode` string, nullable — Error Code displayed in Risk Inquiry Service response
  - `kountFingerprint` string, nullable — The unique fingerprint of the device placing the order
  - `flashEnabled` boolean, nullable — A flag to indicate if the device placing the order has Flash enabled
  - `riskiestAssociatedCountry` string, iso-3166, nullable — Persona related country with highest probability of fraud Refers to Kount's GEOX field.
  - `userDefinedHomeCountry` string, iso-3166, nullable — User home country the device owner has set in the device's control panel Refers to Kount's HTTP_COUNTRY
  - `proxyAddress` string, ipv4, nullable — IP address of proxy
  - `javascriptEnabled` boolean, nullable — A flag to indicate if the device placing order has JavaScript enabled
  - `deviceDataCollectedByDataCollector` boolean, nullable — Flag indicating whether or not device data was collected by the Data Collector process
  - `knowYourCustomerFlag` boolean, nullable — Know Your Customer Flag
  - `deviceLanguage` string, iso-639, nullable — The two-character ISO language the device owner has set in the device control panel
  - `localTime` string, date-time, nullable — The local time the device owner has set in the device control panel
  - `isMobileDevice` boolean, nullable — Flag to indicate if the device placing the order is a mobile device
  - `usesMobileForwarder` boolean, nullable — If device is mobile, is it using a forwarder to process the carriers service
  - `mobileType` string, nullable — Type of mobile device, e.g., iPhone, Android, Blackberry, iPad, etc.
  - `kountNetwork` 'ANONYMOUS' | 'HIGH_SCHOOL' | 'LIBRARY' | 'NORMAL' | 'OPEN_PROXY' | 'PRISON' | 'SATELLITE' | 'null', nullable — Riskiest network type associated with persona within last 14 days:
  - `mode` 'QUERY' | 'UPDATE' | 'null', nullable — Specifies the Risk Inquiry Service post mode type Risk Inquiry Service Modes Modes are used to specify what type of data is being submitted to Kount. Note that ALL FIELD NAMES for a RIS call must be UPPERCASE. They cannot be other case combinations such as sess, Merc, mOdE. However, the values for fields can be mixed case, such as SESS=UpperMixedCaseSessID95628. - QUERY = Mode Q Initial queries directed from the merchant to Kount that do not originate from a call center environment. - UPDATE = Mode U Update call to Kount, does not cause a reevaluation of the transaction but will update what is displayed in the Agent Web Console. This update call does not count towards the number of RIS transactions purchased. Only certain fields can be updated with MODE=U calls. The PTYP field can only be updated if the initial post to Kount was PTYP=NONE
  - `operatingSystem` string, nullable — Operating system of the device
  - `pcRemoteEnabled` boolean, nullable — Flag indicating whether the device is enabled to use PC remote software
  - `proxyEnabled` boolean, nullable — Flag indicating whether or not a proxy server is detected
  - `piercedAddress` KountPiercedAddress, nullable — Pierced IP Address details.
    - `latitude` number, double, nullable — Latitude of pierced IP address
    - `longitude` number, double, nullable — Longitude of pierced IP address
    - `city` string, nullable — Identifies the city.
    - `region` string, nullable — State/Region of pierced IP address
    - `owner` string, nullable — Owner of pierced IP address or address block
    - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
  - `reasonCode` string, nullable — Reason code associated with rule action
  - `region` string, nullable — Region associated to device location
  - `riskiestAssociatedRegion` string, nullable — Indicates the riskiest geographical location associated with the Persona. Refers to Kount's GEOX.
  - `rulesTriggered` KountTriggeredRule[] — Rules triggered by post to Kount
    - `id` integer — Rule ID associated with merchant-created rules
    - `description` string, nullable — Rule descriptions associated with the Id
  - `sessionId` string, nullable — Unique Session ID; must be unique over a 30-day span
  - `websiteId` string, nullable — Website identifier of where order originated
  - `timezone` string, nullable — The time zone of the device; In the ISO format of +|–hh:mm
  - `deviceUserAgent` string, nullable — Exact content of the HTTP user-agent header. Note, when total length exceeds 2048 characters, truncate the excess portion.
  - `velocity` integer, nullable — Quantity of orders seen from persona within last 14 days
  - `maximumVelocity` integer, nullable — Quantity of orders from persona within the most active 6 hour window in last 14 days; payment_response field must be equal to ‘A’
  - `kountVersion` string, nullable — Specifies version of Kount system being used
  - `deviceVoiceActivated` boolean, nullable — If it is a mobile device, flag indicating whether the device is voice activated
  - `warningCount` integer, nullable — Number of warnings the Kount Inquiry Service has generated
  - `warningCode` string, nullable — Warning code displayed in the Risk Inquiry Service response
  - `warningDetail` string, nullable — Warning details

## Other responses

- `202` — Kount Inquiry accepted and is under review.
- `400` — Bad Request.
- `401` — Not authorized. The user does not have a valid API Key or Access Token.
- `403` — Forbidden. The user does not have permission to access the requested resource.
- `409` — Request could not be completed due to a conflict with resource state or existing idempotency key.
- `422` — The API cannot complete the requested action due to semantic or business validation errors.
- `429` — Too Many Requests
- `500` — Unexpected error.
- `503` — Service Temporarily Unavailable

---

[API](https://skmtc.net/moneris/apis/moneris-api.md) · [All operations](https://skmtc.net/moneris/apis/moneris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneris/moneris-api/revisions/edefcc925b74/schema)