Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Accounts

Authentication result

Inform of authentication results after an attempted login or profile access request, using the provided correlation ID. While no decision is provided on this request, it improves the decision model for login and access.

post/v2/accounts/authentication-result/{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.

additionalInformationobject nullable

General payload object

eventTimenumber required

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

Example request

{
  "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"
  },
  "bankTransferVerificationResults": {
    "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"
  },
  "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,
  "merchantIdentifiers": {
    "merchantDomain": "HandbagsExpressDiscounts.com",
    "merchantName": "Handbags Express Discounts"
  },
  "paymentAuthorizationResults": {
    "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"
  },
  "paypalVerificationResults": {
    "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"
  }
}

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
        }
      }
    }
  }
}