Skip to content

Retrieve

Get 3DS authentication
get/v1/three_ds_authentication/{three_ds_authentication_token}

Get 3DS Authentication by token

Path Parameters
three_ds_authentication_tokenstring
formatuuid
Returns
tokenstring

Globally unique identifier for the 3DS authentication. Permitted values: 36-digit version 4 UUID (including hyphens).

formatuuid
account_typeenum
Accepts one of the following: "CREDIT", "DEBIT", "NOT_APPLICABLE"

Type of account/card that is being used for the transaction. Maps to EMV 3DS field acctType.

Hide ParametersShow Parameters
"CREDIT"
"DEBIT"
"NOT_APPLICABLE"
authentication_resultenum
Accepts one of the following: "DECLINE", "SUCCESS", "PENDING_CHALLENGE", "PENDING_DECISION"

Indicates the outcome of the 3DS authentication process.

Hide ParametersShow Parameters
"DECLINE"
"SUCCESS"
"PENDING_CHALLENGE"
"PENDING_DECISION"
card_expiry_checkenum
Accepts one of the following: "MATCH", "MISMATCH", "NOT_PRESENT"

Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date.

Hide ParametersShow Parameters
"MATCH"
"MISMATCH"
"NOT_PRESENT"
card_tokenstring

Globally unique identifier for the card on which the 3DS authentication has occurred. Permitted values: 36-digit version 4 UUID (including hyphens).

formatuuid
cardholderobject

Object containing data about the cardholder provided during the transaction.

Hide ParametersShow Parameters
address_matchboolean
optional

Indicates whether the shipping address and billing address provided by the cardholder are the same. This value - and assessment of whether the addresses match - is provided directly in the 3DS request and is not determined by Lithic. Maps to EMV 3DS field addrMatch.

billing_addressobject
optional

Object containing data on the billing address provided during the transaction.

Hide ParametersShow Parameters
address1string
optional

First line of the street address provided by the cardholder.

address2string
optional

Second line of the street address provided by the cardholder.

address3string
optional

Third line of the street address provided by the cardholder.

citystring
optional

City of the address provided by the cardholder.

countrystring
optional

Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (e.g. USA)

minLength3
maxLength3
postal_codestring
optional

Postal code (e.g., ZIP code) of the address provided by the cardholder

emailstring
optional

Email address that is either provided by the cardholder or is on file with the merchant in a 3RI request. Maps to EMV 3DS field email.

maxLength254
minLength1
namestring
optional

Name of the cardholder. Maps to EMV 3DS field cardholderName.

maxLength36
minLength1
phone_number_homestring
optional

Home phone number provided by the cardholder. Maps to EMV 3DS fields homePhone.cc and homePhone.subscriber.

maxLength18
minLength1
phone_number_mobilestring
optional

Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields mobilePhone.cc and mobilePhone.subscriber.

maxLength18
minLength1
phone_number_workstring
optional

Work phone number provided by the cardholder. Maps to EMV 3DS fields workPhone.cc and workPhone.subscriber.

maxLength18
minLength1
shipping_addressobject
optional

Object containing data on the shipping address provided during the transaction.

Hide ParametersShow Parameters
address1string
optional

First line of the street address provided by the cardholder.

address2string
optional

Second line of the street address provided by the cardholder.

address3string
optional

Third line of the street address provided by the cardholder.

citystring
optional

City of the address provided by the cardholder.

countrystring
optional

Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (e.g. USA)

minLength3
maxLength3
postal_codestring
optional

Postal code (e.g., ZIP code) of the address provided by the cardholder

channelenum
Accepts one of the following: "APP_BASED", "BROWSER", "THREE_DS_REQUESTOR_INITIATED"

Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.

Hide ParametersShow Parameters
"APP_BASED"
"BROWSER"
"THREE_DS_REQUESTOR_INITIATED"
createdstring

Date and time when the authentication was created in Lithic's system. Permitted values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.

formatdate-time
merchantobject

Object containing data about the merchant involved in the e-commerce transaction.

Hide ParametersShow Parameters
idstring

Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field acquirerMerchantId.

countrystring

Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS field merchantCountryCode. Permitted values: ISO 3166-1 alpha-3 country code (e.g., USA).

minLength3
maxLength3
mccstring

Merchant category code assigned to the merchant that describes its business activity type. Maps to EMV 3DS field mcc.

minLength4
maxLength4
namestring

Name of the merchant. Maps to EMV 3DS field merchantName.

risk_indicatorobject

Object containing additional data indicating additional risk factors related to the e-commerce transaction.

Hide ParametersShow Parameters
delivery_email_addressstring
optional

In transactions with electronic delivery, email address to which merchandise is delivered. Maps to EMV 3DS field deliveryEmailAddress.

delivery_time_frameenum
optional
Accepts one of the following: "ELECTRONIC_DELIVERY", "OVERNIGHT_SHIPPING", "SAME_DAY_SHIPPING", "TWO_DAY_OR_MORE_SHIPPING"

The delivery time frame for the merchandise. Maps to EMV 3DS field deliveryTimeframe.

Hide ParametersShow Parameters
"ELECTRONIC_DELIVERY"
"OVERNIGHT_SHIPPING"
"SAME_DAY_SHIPPING"
"TWO_DAY_OR_MORE_SHIPPING"
gift_card_amountnumber
optional

In prepaid or gift card purchase transactions, purchase amount total in major units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field giftCardAmount.

gift_card_countnumber
optional

In prepaid or gift card purchase transactions, count of individual prepaid or gift cards/codes purchased. Maps to EMV 3DS field giftCardCount.

gift_card_currencystring
optional

In prepaid or gift card purchase transactions, currency code of the gift card. Maps to EMV 3DS field giftCardCurr. Permitted values: ISO 4217 three-character currency code (e.g., USD).

minLength3
maxLength3
order_availabilityenum
optional
Accepts one of the following: "FUTURE_AVAILABILITY", "MERCHANDISE_AVAILABLE"

Indicates whether the purchase is for merchandise that is available now or at a future date. Maps to EMV 3DS field preOrderPurchaseInd.

Hide ParametersShow Parameters
"FUTURE_AVAILABILITY"
"MERCHANDISE_AVAILABLE"
pre_order_available_datestring
optional

In pre-order purchase transactions, the expected date that the merchandise will be available. Maps to EMV 3DS field preOrderDate. Permitted values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ

formatdate-time
reorder_itemsenum
optional
Accepts one of the following: "FIRST_TIME_ORDERED", "REORDERED"

Indicates whether the cardholder is reordering previously purchased merchandise. Maps to EMV 3DS field reorderItemsInd.

Hide ParametersShow Parameters
"FIRST_TIME_ORDERED"
"REORDERED"
shipping_methodenum
optional
Accepts one of the following: "DIGITAL_GOODS", "LOCKER_DELIVERY", "OTHER", 6 more

Shipping method that the cardholder chose for the transaction. If purchase includes one or more item, this indicator is used for the physical goods; if the purchase only includes digital goods, this indicator is used to describe the most expensive item purchased. Maps to EMV 3DS field shipIndicator.

Hide ParametersShow Parameters
"DIGITAL_GOODS"
"LOCKER_DELIVERY"
"OTHER"
"PICK_UP_AND_GO_DELIVERY"
"SHIP_TO_BILLING_ADDRESS"
"SHIP_TO_NON_BILLING_ADDRESS"
"SHIP_TO_OTHER_VERIFIED_ADDRESS"
"SHIP_TO_STORE"
"TRAVEL_AND_EVENT_TICKETS"
message_categoryenum
Accepts one of the following: "NON_PAYMENT_AUTHENTICATION", "PAYMENT_AUTHENTICATION"

Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.

Hide ParametersShow Parameters
"NON_PAYMENT_AUTHENTICATION"
"PAYMENT_AUTHENTICATION"
three_ds_requestor_challenge_indicatorenum
Accepts one of the following: "NO_PREFERENCE", "NO_CHALLENGE_REQUESTED", "CHALLENGE_PREFERENCE", 4 more

Indicates whether a challenge is requested for this transaction

  • NO_PREFERENCE - No Preference
  • NO_CHALLENGE_REQUESTED - No Challenge Requested
  • CHALLENGE_PREFERENCE - Challenge requested (3DS Requestor preference)
  • CHALLENGE_MANDATE - Challenge requested (Mandate)
  • NO_CHALLENGE_RISK_ALREADY_ASSESSED - No Challenge requested (Transactional risk analysis is already performed)
  • DATA_SHARE_ONLY - No Challenge requested (Data Share Only)
  • OTHER - Other indicators not captured by above. These are rarely used
Hide ParametersShow Parameters
"NO_PREFERENCE"
"NO_CHALLENGE_REQUESTED"
"CHALLENGE_PREFERENCE"
"CHALLENGE_MANDATE"
"NO_CHALLENGE_RISK_ALREADY_ASSESSED"
"DATA_SHARE_ONLY"
"OTHER"
additional_dataobject
optional

Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).

Hide ParametersShow Parameters
network_decisionenum
optional
Accepts one of the following: "LOW_RISK", "NOT_LOW_RISK"

Mastercard only: Indicates whether the network would have considered the authentication request to be low risk or not.

Hide ParametersShow Parameters
"LOW_RISK"
"NOT_LOW_RISK"
network_risk_scorenumber
optional

Mastercard only: Assessment by the network of the authentication risk level, with a higher value indicating a higher amount of risk. Permitted values: Integer between 0-950, in increments of 50.

appobject
optional

Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.

Hide ParametersShow Parameters
device_infostring
optional

Device information gathered from the cardholder's device - JSON name/value pairs that is Base64url encoded. Maps to EMV 3DS field deviceInfo.

ipstring
optional

External IP address used by the app generating the 3DS authentication request. Maps to EMV 3DS field appIp.

authentication_request_typeenum
optional
Accepts one of the following: "ADD_CARD", "BILLING_AGREEMENT", "DELAYED_SHIPMENT", 7 more

Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd.

Hide ParametersShow Parameters
"ADD_CARD"
"BILLING_AGREEMENT"
"DELAYED_SHIPMENT"
"EMV_TOKEN_CARDHOLDER_VERIFICATION"
"INSTALLMENT_TRANSACTION"
"MAINTAIN_CARD"
"PAYMENT_TRANSACTION"
"RECURRING_TRANSACTION"
"SPLIT_PAYMENT"
"SPLIT_SHIPMENT"
browserobject
optional

Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.

Hide ParametersShow Parameters
accept_headerstring
optional

Content of the HTTP accept headers as sent from the cardholder's browser to the 3DS requestor (e.g., merchant or digital wallet).

ipstring
optional

IP address of the browser as returned by the HTTP headers to the 3DS requestor (e.g., merchant or digital wallet). Maps to EMV 3DS field browserIP.

java_enabledboolean
optional

Indicates whether the cardholder's browser has the ability to execute Java. Maps to EMV 3DS field browserJavaEnabled.

javascript_enabledboolean
optional

Indicates whether the cardholder's browser has the ability to execute JavaScript. Maps to EMV 3DS field browserJavascriptEnabled.

languagestring
optional

Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS field browserLanguage.

time_zonestring
optional

Time zone of the cardholder's browser offset in minutes between UTC and the cardholder browser's local time. The offset is positive if the local time is behind UTC and negative if it is ahead. Maps to EMV 3DS field browserTz.

user_agentstring
optional

Content of the HTTP user-agent header. Maps to EMV 3DS field browserUserAgent.

challenge_metadataobject
optional

Metadata about the challenge method and delivery. Only present when a challenge is triggered.

Hide ParametersShow Parameters
method_typeenum
Accepts one of the following: "SMS_OTP", "OUT_OF_BAND"

The type of challenge method used for authentication.

Hide ParametersShow Parameters
"SMS_OTP"
"OUT_OF_BAND"
phone_numberstring
optional

The phone number used for delivering the OTP. Relevant only for SMS_OTP method.

challenge_orchestrated_byenum
optional
Accepts one of the following: "LITHIC", "CUSTOMER", "NO_CHALLENGE"

Entity that orchestrates the challenge. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request).

Hide ParametersShow Parameters
"LITHIC"
"CUSTOMER"
"NO_CHALLENGE"
decision_made_byenum
optional
Accepts one of the following: "LITHIC_RULES", "LITHIC_DEFAULT", "CUSTOMER_RULES", 3 more

Entity that made the authentication decision. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request).

Hide ParametersShow Parameters
"LITHIC_RULES"
"LITHIC_DEFAULT"
"CUSTOMER_RULES"
"CUSTOMER_ENDPOINT"
"NETWORK"
"UNKNOWN"
three_ri_request_typeenum
optional
Accepts one of the following: "ACCOUNT_VERIFICATION", "ADD_CARD", "BILLING_AGREEMENT", 13 more

Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.

Hide ParametersShow Parameters
"ACCOUNT_VERIFICATION"
"ADD_CARD"
"BILLING_AGREEMENT"
"CARD_SECURITY_CODE_STATUS_CHECK"
"DELAYED_SHIPMENT"
"DEVICE_BINDING_STATUS_CHECK"
"INSTALLMENT_TRANSACTION"
"MAIL_ORDER"
"MAINTAIN_CARD_INFO"
"OTHER_PAYMENT"
"RECURRING_TRANSACTION"
"SPLIT_PAYMENT"
"SPLIT_SHIPMENT"
"TELEPHONE_ORDER"
"TOP_UP"
"TRUST_LIST_STATUS_CHECK"
transactionobject
optional

Object containing data about the e-commerce transaction for which the merchant is requesting authentication.

Hide ParametersShow Parameters
amountnumber

Amount of the purchase in minor units of currency with all punctuation removed. Maps to EMV 3DS field purchaseAmount.

cardholder_amountnumber

Approximate amount of the purchase in minor units of cardholder currency. Derived from amount using a daily conversion rate.

currencystring

Currency of the purchase. Maps to EMV 3DS field purchaseCurrency. Permitted values: ISO 4217 three-character currency code (e.g., USD).

minLength3
maxLength3
currency_exponentnumber

Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV 3DS field purchaseExponent.

date_timestring

Date and time when the authentication was generated by the merchant/acquirer's 3DS server. Maps to EMV 3DS field purchaseDate. Permitted values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.

formatdate-time
typeenum
Accepts one of the following: "ACCOUNT_FUNDING", "CHECK_ACCEPTANCE", "GOODS_SERVICE_PURCHASE", 2 more

Type of the transaction for which a 3DS authentication request is occurring. Maps to EMV 3DS field transType.

Hide ParametersShow Parameters
"ACCOUNT_FUNDING"
"CHECK_ACCEPTANCE"
"GOODS_SERVICE_PURCHASE"
"PREPAID_ACTIVATION_AND_LOAD"
"QUASI_CASH_TRANSACTION"
Request example Request
curl https://api.lithic.com/v1/three_ds_authentication/$THREE_DS_AUTHENTICATION_TOKEN \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_type": "CREDIT",
  "authentication_result": "DECLINE",
  "card_expiry_check": "MATCH",
  "card_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "cardholder": {
    "address_match": true,
    "billing_address": {
      "address1": "address1",
      "address2": "address2",
      "address3": "address3",
      "city": "city",
      "country": "xxx",
      "postal_code": "postal_code"
    },
    "email": "x",
    "name": "x",
    "phone_number_home": "x",
    "phone_number_mobile": "x",
    "phone_number_work": "x",
    "shipping_address": {
      "address1": "address1",
      "address2": "address2",
      "address3": "address3",
      "city": "city",
      "country": "xxx",
      "postal_code": "postal_code"
    }
  },
  "channel": "APP_BASED",
  "created": "2019-12-27T18:11:19.117Z",
  "merchant": {
    "id": "id",
    "country": "xxx",
    "mcc": "xxxx",
    "name": "name",
    "risk_indicator": {
      "delivery_email_address": "delivery_email_address",
      "delivery_time_frame": "ELECTRONIC_DELIVERY",
      "gift_card_amount": 0,
      "gift_card_count": 0,
      "gift_card_currency": "xxx",
      "order_availability": "FUTURE_AVAILABILITY",
      "pre_order_available_date": "2019-12-27T18:11:19.117Z",
      "reorder_items": "FIRST_TIME_ORDERED",
      "shipping_method": "DIGITAL_GOODS"
    }
  },
  "message_category": "NON_PAYMENT_AUTHENTICATION",
  "three_ds_requestor_challenge_indicator": "NO_PREFERENCE",
  "additional_data": {
    "network_decision": "LOW_RISK",
    "network_risk_score": 0
  },
  "app": {
    "device_info": "device_info",
    "ip": "ip"
  },
  "authentication_request_type": "ADD_CARD",
  "browser": {
    "accept_header": "accept_header",
    "ip": "ip",
    "java_enabled": true,
    "javascript_enabled": true,
    "language": "language",
    "time_zone": "time_zone",
    "user_agent": "user_agent"
  },
  "challenge_metadata": {
    "method_type": "SMS_OTP",
    "phone_number": "phone_number"
  },
  "challenge_orchestrated_by": "LITHIC",
  "decision_made_by": "LITHIC_RULES",
  "three_ri_request_type": "ACCOUNT_VERIFICATION",
  "transaction": {
    "amount": 0,
    "cardholder_amount": 0,
    "currency": "xxx",
    "currency_exponent": 0,
    "date_time": "2019-12-27T18:11:19.117Z",
    "type": "ACCOUNT_FUNDING"
  }
}