Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Accounts

Login

Send login attempt information to receive an account takeover decision. May also be used to determine whether to extend a user's idle session without prompting user for credentials. The response may also include recommendations for additional authentication (MFA) and a correlation ID to include with the authentication result.

post/v2/accounts/login/{id}

Path parameters

idstring required

Headers

api-versionstring required
Example:10.1

Specify the version of the API to target.

x-forter-siteidstring required
Example:a1b2c3d4e5f6

Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Authorizationstring required
Example:Basic <base64-encoded-api-key:>

Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.

Request body

accountIdstring required

Customer's account UID in merchant's site. Should not be the user email.

channelType'WEB' | 'PHONE' | 'DYNAMIC_PHONE' | 'MOBILE' | 'MOBILE_IN_STORE' | 'IOS' | 'ANDROID' | 'WAP' | 'STORE' | 'MERCHANT_EMPLOYEE' | 'MAIL_ORDER' | 'AUTOMATIC_RENEWAL_OR_INSTALLMENT_PAYMENT' | 'MERCHANT_INITIATED' | 'UNKNOWN' | 'POS' | 'API_ONLY' | 'PERSONAL_POS' | 'PHONE_LINK' | 'AI_AGENT' nullable

The source channel through which the customer conducted the login. Note that some of the enum values are not relevant for this interaction.

eventTimenumber required

The time that the trigger event occurred in MILLISECONDS since unix epoch (Jan 1, 1970)

loginMethodType'PASSWORD' | 'SMS' | 'SOCIAL' | 'EMAIL_LINK_OTP' | 'AUTH_TOKEN_REFRESH' | 'APPLE' | 'MFA_CODE_REFRESH' | 'EMAIL_MAGIC_LINK' | 'PASSKEY' | 'QR' | 'OTHER' required

The authentication method used to login

loginStatus'SUCCESS' | 'FAILED' | 'BLOCKED_BY_MERCHANT' | 'ACCOUNT_DOES_NOT_EXIST' required

The status of the Login attempt

Example request

{
  "accountData": {
    "additionalVerificationDocuments": {
      "address": {
        "address1": "235 Montgomery st.",
        "address2": "Ste. 1110",
        "city": "San Francisco",
        "company": "Generic Corp. ltd.",
        "country": "US",
        "region": "CA",
        "savedData": {
          "usedSavedData": true
        },
        "zip": "94104"
      },
      "documentDateOfBirth": "1991-01-09",
      "documentExpiration": "2017-01-15",
      "documentFirstName": "John",
      "documentIssuingState": "NY",
      "documentLastName": "Smith",
      "documentNumber": "20439190",
      "documentSource": "UPLOADED_FILE",
      "documentStatus": "SENT_TO_CLIENT",
      "documentType": "Passport",
      "documentVerificationServiceAnswer": "APPROVED",
      "documentVerificationServiceName": "IDVerification.com",
      "documentVerified": true,
      "eventTime": 1420070400,
      "nationality": "US"
    },
    "addressesInAccount": [
      {
        "address1": "235 Montgomery st.",
        "address2": "Ste. 1110",
        "city": "San Francisco",
        "company": "Generic Corp. ltd.",
        "country": "US",
        "region": "CA",
        "savedData": {
          "usedSavedData": true
        },
        "zip": "94104"
      }
    ],
    "customerEngagement": {
      "communityPostsWritten": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "followersCount": 105,
      "followingCount": 230,
      "invites": [
        {
          "invitationCounterpartyPhone": "+12126667777",
          "sent": 1420955538,
          "type": "SENT"
        }
      ],
      "likedItems": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "messagesReceived": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "messagesSent": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "newsletters": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "profilePicture": true,
      "requestedDemo": true,
      "reviewsWritten": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "savedLocations": [
        {
          "latitude": 32.07332,
          "longitude": 34.79675,
          "source": "MOBILE"
        }
      ],
      "sharedItems": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      },
      "signedUpForPushNotifications": true,
      "signedUpForSMSUpdates": true,
      "wishlist": {
        "inUse": true,
        "itemInListCount": 4,
        "updateTimes": {
          "creationTime": 1448549922,
          "lastModifiedTime": 1448549922,
          "lastUsed": 1448560456,
          "removalTime": 1448895522
        }
      }
    },
    "emailsInAccount": [
      {
        "email": "john_s@test.com",
        "emailVerification": {
          "sent": true,
          "timeSent": 1389567341
        }
      }
    ],
    "paymentMethodsInAccount": [
      {
        "amount": {
          "amountLocalCurrency": "105.55",
          "amountUSD": "99.95",
          "currency": "CAD"
        },
        "androidPay": {
          "bin": "42424242",
          "cardBank": "Chase",
          "cardBrand": "VISA",
          "cardType": "CREDIT",
          "countryOfIssuance": "US",
          "creationTime": 1430997968,
          "expirationMonth": "03",
          "expirationYear": "2018",
          "lastFourDigits": "4242",
          "nameOnCard": "John R. H. Smith",
          "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
          },
          "threeDSecure": {
            "acquirerData": {
              "acquirerBIN": "457173",
              "acquirerCountry": "US",
              "acquirerMerchantId": "5245020244654",
              "acquirerMerchantName": "Simple T-shirt",
              "acquirerName": "Barclays",
              "merchantCategoryCode": 5655,
              "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
              "channel": "THREEDS_RAILS",
              "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
          },
          "token": "tkn-77620C360132856A103477D2959967AB",
          "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "exemptionStatus": "accepted",
            "issuerResponseCode": "D23",
            "issuerResponseText": "Stolen card",
            "liabilityShift": true,
            "partyExecuted3DS": "PSP",
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsInteractionMode": "FRICTIONLESS",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
          }
        },
        "applePay": {
          "bin": "42424242",
          "cardBank": "Chase",
          "cardBrand": "VISA",
          "cardType": "CREDIT",
          "countryOfIssuance": "US",
          "creationTime": 1430997968,
          "expirationMonth": "03",
          "expirationYear": "2018",
          "lastFourDigits": "4242",
          "nameOnCard": "John R. H. Smith",
          "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
          },
          "threeDSecure": {
            "acquirerData": {
              "acquirerBIN": "457173",
              "acquirerCountry": "US",
              "acquirerMerchantId": "5245020244654",
              "acquirerMerchantName": "Simple T-shirt",
              "acquirerName": "Barclays",
              "merchantCategoryCode": 5655,
              "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
              "channel": "THREEDS_RAILS",
              "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
          },
          "token": "tkn-77620C360132856A103477D2959967AB",
          "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "exemptionStatus": "accepted",
            "issuerResponseCode": "D23",
            "issuerResponseText": "Stolen card",
            "liabilityShift": true,
            "partyExecuted3DS": "PSP",
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsInteractionMode": "FRICTIONLESS",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
          }
        },
        "bankTransfer": {
          "accountHolderFirstName": "John",
          "accountHolderLastName": "Smith",
          "achProcessingType": "SAME_DAY_ACH",
          "bankAccountIdentifier": "TEST63TEST1212121212",
          "bankAccountType": "Savings",
          "bankName": "Citigroup",
          "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
          },
          "paymentSuccessStatus": "Payment Successful",
          "serviceName": "Direct Debit"
        },
        "billingDetails": {
          "address": {
            "address1": "235 Montgomery st.",
            "address2": "Ste. 1110",
            "city": "San Francisco",
            "company": "Generic Corp. ltd.",
            "country": "US",
            "region": "CA",
            "savedData": {
              "usedSavedData": true
            },
            "zip": "94104"
          },
          "allAdditionalVerificationDocuments": [
            {
              "address": {
                "address1": "235 Montgomery st.",
                "address2": "Ste. 1110",
                "city": "San Francisco",
                "company": "Generic Corp. ltd.",
                "country": "US",
                "region": "CA",
                "savedData": {
                  "usedSavedData": true
                },
                "zip": "94104"
              },
              "documentDateOfBirth": "1991-01-09",
              "documentExpiration": "2017-01-15",
              "documentFirstName": "John",
              "documentIssuingState": "NY",
              "documentLastName": "Smith",
              "documentNumber": "20439190",
              "documentSource": "UPLOADED_FILE",
              "documentStatus": "SENT_TO_CLIENT",
              "documentType": "Passport",
              "documentVerificationServiceAnswer": "APPROVED",
              "documentVerificationServiceName": "IDVerification.com",
              "documentVerified": true,
              "eventTime": 1420070400,
              "nationality": "US"
            }
          ],
          "employmentInformation": [
            {
              "employerAddress": {
                "address1": "235 Montgomery st.",
                "address2": "Ste. 1110",
                "city": "San Francisco",
                "company": "Generic Corp. ltd.",
                "country": "US",
                "region": "CA",
                "savedData": {
                  "usedSavedData": true
                },
                "zip": "94104"
              },
              "employerCompanySizeRange": "20",
              "employerIndustry": "Retail",
              "employerName": "Forter",
              "employerPhone": "+12126667777",
              "income": {
                "amountLocalCurrency": "105.55",
                "amountUSD": "99.95",
                "currency": "CAD"
              },
              "jobTitle": "Fraud Analyst"
            }
          ],
          "personalDetails": {
            "birthdate": "1987-05-22",
            "email": "john_s@test.com",
            "firstName": "John",
            "fullName": "John Smith",
            "gender": "MALE",
            "lastName": "Smith"
          },
          "phone": [
            {
              "phone": "15557654321",
              "smsVerified": {
                "sent": true,
                "timeSent": 1389567341
              }
            }
          ]
        },
        "cameraCaptured": true,
        "creditCard": {
          "bin": "42424242",
          "cardBank": "Chase",
          "cardBrand": "VISA",
          "cardType": "CREDIT",
          "countryOfIssuance": "US",
          "expirationMonth": "03",
          "expirationYear": "2018",
          "fingerprint": "Xt5EWLLDS7FJjR1c",
          "fullCreditCard": "2424242424242424",
          "lastFourDigits": "4242",
          "nameOnCard": "John R. H. Smith",
          "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
          },
          "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
          },
          "threeDSecure": {
            "acquirerData": {
              "acquirerBIN": "457173",
              "acquirerCountry": "US",
              "acquirerMerchantId": "5245020244654",
              "acquirerMerchantName": "Simple T-shirt",
              "acquirerName": "Barclays",
              "merchantCategoryCode": 5655,
              "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
              "channel": "THREEDS_RAILS",
              "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
          },
          "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "exemptionStatus": "accepted",
            "issuerResponseCode": "D23",
            "issuerResponseText": "Stolen card",
            "liabilityShift": true,
            "partyExecuted3DS": "PSP",
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsInteractionMode": "FRICTIONLESS",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
          }
        },
        "creditLineDetails": {
          "creditLineLimitIncreaseMethod": "AT_PURCHASE",
          "currentCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
          },
          "originalCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
          }
        },
        "cryptoWallet": {
          "cryptoWalletName": "CryptoWallet",
          "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
          "cryptoWalletType": "EXTERNAL"
        },
        "digitalWallet": {
          "digitalWalletName": "ALIPAY",
          "digitalWalletPayerEmail": "john_s@test.com",
          "digitalWalletPayerId": "FD000A45P",
          "digitalWalletpaymentId": "PAY-0MB00000KR8073311KZSDEYA",
          "freeTextDigitalWalletName": "ALIBABA",
          "payerAccountCountry": "US",
          "paymentSuccessStatus": "COMPLETED",
          "underlyingPaymentMethod": {
            "bankTransfer": {
              "accountHolderFirstName": "John",
              "accountHolderLastName": "Smith",
              "achProcessingType": "SAME_DAY_ACH",
              "bankAccountIdentifier": "TEST63TEST1212121212",
              "bankAccountType": "Savings",
              "bankName": "Citigroup",
              "paymentGatewayData": {
                "gatewayName": "Braintree",
                "gatewayTransactionId": "fjdsS46sdklFd20"
              },
              "paymentSuccessStatus": "Payment Successful",
              "serviceName": "Direct Debit"
            },
            "creditCard": {
              "bin": "42424242",
              "cardBank": "Chase",
              "cardBrand": "VISA",
              "cardType": "CREDIT",
              "countryOfIssuance": "US",
              "creationTime": 1430997968,
              "expirationMonth": "03",
              "expirationYear": "2018",
              "lastFourDigits": "4242",
              "nameOnCard": "John R. H. Smith",
              "paymentProcessorData": {
                "processorName": "Chase Paymentech",
                "processorTransactionId": "fjdsS46sdklFd20"
              },
              "threeDSecure": {
                "acquirerData": {
                  "acquirerBIN": "457173",
                  "acquirerCountry": "US",
                  "acquirerMerchantId": "5245020244654",
                  "acquirerMerchantName": "Simple T-shirt",
                  "acquirerName": "Barclays",
                  "merchantCategoryCode": 5655,
                  "merchantCountryCode": 840
                },
                "challengeIndicator": "NO_PREFERENCE",
                "execute3ds": "DYNAMIC_FORTER_DECISION",
                "forcePsd2Exemption": {
                  "channel": "THREEDS_RAILS",
                  "type": "LOW_VALUE"
                },
                "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
              },
              "token": "tkn-77620C360132856A103477D2959967AB",
              "verificationResults": {
                "authorizationCode": "A33244",
                "authorizationProcessedWith3DS": true,
                "avsFullResult": "Y",
                "avsNameResult": "M",
                "avsStreetResult": "N",
                "avsZipResult": "M",
                "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
                "cvvResult": "M",
                "eciValue": "05",
                "exemptionStatus": "accepted",
                "issuerResponseCode": "D23",
                "issuerResponseText": "Stolen card",
                "liabilityShift": true,
                "partyExecuted3DS": "PSP",
                "processorResponseCode": "D23",
                "processorResponseText": "Stolen card",
                "threeDsInteractionMode": "FRICTIONLESS",
                "threeDsStatus": "Cardholder authenticated",
                "threeDsVersion": "2.1.0"
              }
            },
            "underlyingPaymentMethodType": "UNKNOWN"
          }
        },
        "giftCard": {
          "activationTime": 1448549922,
          "creditCurrency": "CAD",
          "creditOrigin": "CS Compensation",
          "merchantPaymentId": "eab12-ba9a-367-60b",
          "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
          }
        },
        "installmentService": {
          "firstName": "John",
          "lastName": "Smith",
          "paymentId": "YTZ8IATEGAWRRVVG",
          "serviceName": "Affirm",
          "serviceResponseCode": "200"
        },
        "loyaltyPoints": {
          "loyaltyPointsCount": 1506,
          "loyaltyPointsSource": "IN_ACCOUNT_PURCHASES",
          "loyaltyPointsValue": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
          },
          "merchantPaymentId": "eab12-ba9a-367-60b"
        },
        "merchantInitiated": {
          "initialOrderId": "2356fdse0rr489"
        },
        "mobileMoney": {
          "mobileMoneyNetwork": "MPESA",
          "paymentAcquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
          },
          "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
          },
          "paymentSuccessStatus": "success",
          "phoneNumber": "15557654321"
        },
        "numberOfInstallments": 12,
        "paymentMethodNickname": "My Work Card",
        "paypal": {
          "authorizationId": "2WC75407LV7300439",
          "payerAccountCountry": "US",
          "payerAddressStatus": "CONFIRMED",
          "payerEmail": "john_s@test.com",
          "payerId": "FD000A45P",
          "payerStatus": "VERIFIED",
          "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
          },
          "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
          "paymentStatus": "COMPLETED",
          "protectionEligibility": "ELIGIBLE"
        },
        "recurringPayment": {
          "currentPaymentNumber": 1,
          "initialPaymentOrderId": "2356fdse0rr483",
          "recurringPaymentExpirationDate": "1988-06-22",
          "recurringPaymentFrequency": "7",
          "totalNumberOfPayments": 12
        },
        "samsungPay": {
          "bin": "42424242",
          "cardBank": "Chase",
          "cardBrand": "VISA",
          "cardType": "CREDIT",
          "countryOfIssuance": "US",
          "creationTime": 1430997968,
          "expirationMonth": "03",
          "expirationYear": "2018",
          "lastFourDigits": "4242",
          "nameOnCard": "John R. H. Smith",
          "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
          },
          "threeDSecure": {
            "acquirerData": {
              "acquirerBIN": "457173",
              "acquirerCountry": "US",
              "acquirerMerchantId": "5245020244654",
              "acquirerMerchantName": "Simple T-shirt",
              "acquirerName": "Barclays",
              "merchantCategoryCode": 5655,
              "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
              "channel": "THREEDS_RAILS",
              "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
          },
          "token": "tkn-77620C360132856A103477D2959967AB",
          "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "exemptionStatus": "accepted",
            "issuerResponseCode": "D23",
            "issuerResponseText": "Stolen card",
            "liabilityShift": true,
            "partyExecuted3DS": "PSP",
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsInteractionMode": "FRICTIONLESS",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
          }
        },
        "savedData": {
          "usedSavedData": true
        },
        "storeCreditUsed": {
          "activationTime": 1448549922,
          "creditCurrency": "CAD",
          "creditOrigin": "CS Compensation",
          "merchantPaymentId": "eab12-ba9a-367-60b",
          "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
          }
        },
        "tokenizedCard": {
          "bin": "42424242",
          "cardBank": "Chase",
          "cardBrand": "VISA",
          "cardType": "CREDIT",
          "countryOfIssuance": "US",
          "creationTime": 1430997968,
          "expirationMonth": "03",
          "expirationYear": "2018",
          "lastFourDigits": "4242",
          "nameOnCard": "John R. H. Smith",
          "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
          },
          "threeDSecure": {
            "acquirerData": {
              "acquirerBIN": "457173",
              "acquirerCountry": "US",
              "acquirerMerchantId": "5245020244654",
              "acquirerMerchantName": "Simple T-shirt",
              "acquirerName": "Barclays",
              "merchantCategoryCode": 5655,
              "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
              "channel": "THREEDS_RAILS",
              "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
          },
          "token": "tkn-77620C360132856A103477D2959967AB",
          "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "exemptionStatus": "accepted",
            "issuerResponseCode": "D23",
            "issuerResponseText": "Stolen card",
            "liabilityShift": true,
            "partyExecuted3DS": "PSP",
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsInteractionMode": "FRICTIONLESS",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
          }
        },
        "venmo": {
          "paymentId": "1KZSDEYA",
          "token": "77620C360132856A103477D2959967AB",
          "userId": "johndoe",
          "userName": "johndoe1987"
        }
      }
    ],
    "personalDetails": {
      "birthdate": "1987-05-22",
      "email": "john_s@test.com",
      "firstName": "John",
      "fullName": "John Smith",
      "gender": "MALE",
      "lastName": "Smith"
    },
    "phonesInAccount": [
      {
        "phone": "15557654321",
        "smsVerified": {
          "sent": true,
          "timeSent": 1389567341
        }
      }
    ],
    "ratingAsBuyer": {
      "score": "4.5",
      "source": "yelp",
      "type": "INTERNAL_PEERS"
    },
    "registrationIP": "203.12.55.12",
    "type": "BUSINESS"
  },
  "accountId": "e520-ba9a-367-60b",
  "additionalAuthenticationMethod": {
    "correlationId": "HGJ7512345H3DE",
    "documentVerification": {
      "address": {
        "address1": "235 Montgomery st.",
        "address2": "Ste. 1110",
        "city": "San Francisco",
        "company": "Generic Corp. ltd.",
        "country": "US",
        "region": "CA",
        "savedData": {
          "usedSavedData": true
        },
        "zip": "94104"
      },
      "documentDateOfBirth": "1991-01-09",
      "documentExpiration": "2017-01-15",
      "documentFirstName": "John",
      "documentIssuingState": "NY",
      "documentLastName": "Smith",
      "documentNumber": "20439190",
      "documentSource": "UPLOADED_FILE",
      "documentStatus": "SENT_TO_CLIENT",
      "documentType": "Passport",
      "documentVerificationServiceAnswer": "APPROVED",
      "documentVerificationServiceName": "IDVerification.com",
      "documentVerified": true,
      "eventTime": 1420070400,
      "nationality": "US"
    },
    "emailVerification": {
      "email": "john_s@test.com",
      "emailVerification": {
        "sent": true,
        "timeSent": 1389567341
      }
    },
    "oneTimePasswordVerification": {
      "timeVerified": 1388560227,
      "verificationMethod": "Google Authenticator"
    },
    "paymentInstrumentVerification": {
      "lastFourDigits": "4242",
      "token": "tkn-77620C360132856A103477D2959967AB"
    },
    "phoneVerification": {
      "phone": "15557654321",
      "smsVerified": {
        "sent": true,
        "timeSent": 1389567341
      }
    },
    "verificationOutcome": "SUCCESS"
  },
  "channelType": "WEB",
  "connectionInformation": {
    "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
    "customerIP": "10.0.0.127",
    "forterMobileUID": "6429751237891",
    "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
    "merchantDeviceIdentifier": "HGJ7512345H3",
    "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
    "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
  },
  "eventTime": 1415287568000,
  "loginMethodType": "PASSWORD",
  "loginStatus": "SUCCESS",
  "merchantIdentifiers": {
    "merchantDomain": "HandbagsExpressDiscounts.com",
    "merchantName": "Handbags Express Discounts"
  },
  "userInput": {
    "customerSignedInUsingSocialNetworkAccount": {
      "otherSocialNetwork": "VK"
    },
    "email": "john_s@test.com",
    "inputType": "EMAIL",
    "phone": "15557654321"
  }
}

Response

Example adaptiveAuthAccountsResponse

accountIdstring required

When applicable, the customer's account UID in merchant's site

correlationIdstring required

A forter unique identifier that should be sent to Forter as part of the AdvancedAuthenticationMethod object to correlate the MFA recommendation given in this response with the relevant additional authentication attempt result

decisionReasonstring required

The main reason behind the Forter decision

forterDecision'APPROVE' | 'DECLINE' | 'VERIFICATION_REQUIRED' | 'NOT_REVIEWED' required

The latest Forter decision regarding the attempted action

merchantPolicyIdstring required

UID of the custom policy created in Forter's Policies tool that resulted in this decision

recommendationstring required

A specific recommendation for an action that might help the customer to complete their transaction/action (e.g. verify phone via SMS, verify via push notification, verify email, perform a 3DS check, etc.)

Example response

{
  "accountId": "e520-ba9a-367-60b",
  "correlationId": "HGJ7512345H3DE",
  "forterDecision": "APPROVE",
  "merchantPolicyId": "0ee8ba28a8654c659addbae9253b707c",
  "verificationMethod": {
    "correlationId": "HGJ7512345H3DE",
    "status": "FRICTIONLESS",
    "statusCode": "100",
    "statusMessage": "Verification code sent",
    "type": "THREE_DS",
    "verificationId": "345H3DEHGJ7512",
    "verificationSpecificData": {
      "ThreeDS": {
        "ACSUrl": "https:/ /acs-us-east-1.nd.nds-sandbox-issuer.com/api/v1/acs/browser_sdk_challenges",
        "ECIValue": "02",
        "acsChallengeMandated": "Y",
        "acsReferenceNumber": "ftr-internal-acs-approval",
        "acsTransID": "6fd30e89-8171-4cc3-b86e-3d59582af2f6",
        "authenticationType": "01",
        "authenticationValue": "tSvPDt3PINNaoL+ERXdg0jVrmWc=",
        "bankLiabilityShift": true,
        "cardEnrolled": "Y",
        "cavvAlgorithm": "3",
        "challengeCancel": "01",
        "challengeStatus": "Y",
        "dsTransID": "38bbf46f-c023-4f4c-ae2c-35fb301632a5",
        "encodedChallengeRequest": "eyJhY3NUcmFuc0lEIjoiMTEyY2RiNWItMGFlYy00MTY5LThjMWYtYWMyN2JlNjAxMjhhIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiZWRhM2MwMzYtZWMyYS00NmZkLTlmYWItNzBlZTgyYjJjNzQ5In0=",
        "exemption": "TRANSACTION_RISK_ANALYSIS",
        "interactionCounter": "01",
        "messageCategory": "01",
        "outOfScopeForPSD2": "ANONYMOUS_PREPAID_CARD",
        "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45",
        "threeDSecureMode": "sca",
        "threeDSecurePreference": "nopref",
        "threeDSecureResult": "590040",
        "transStatus": "Y",
        "transStatusReason": "01",
        "verifyStatus": "Y",
        "version": "2.1.0"
      },
      "email": {
        "email": "john_s@test.com",
        "emailVerification": {
          "sent": true,
          "timeSent": 1389567341
        }
      },
      "phone": {
        "phone": "15557654321",
        "smsVerified": {
          "sent": true,
          "timeSent": 1389567341
        }
      }
    }
  }
}