Authentication result

POST

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.

Credentials

HTTP Basic basicAuth:

Path Parameters

• id
  string

Header Parameters

• api-version
  string

• x-forter-siteid
  string

Body Parameters

• body
  accountAuthenticationRequest

Description

• accountId
  string

• additionalAuthenticationMethod
  object
  All Of

• AdvancedAuthenticationMethod

  • additionalInformation
    object
    All Of GeneralPayloadMap
  • bankTransferVerificationResults
    object
    All Of BankTransfer
  • connectionInformation
    object
    All Of ConnectionInformation
  • eventTime
    number
  • merchantIdentifiers
    object
    All Of MerchantIdentifiers
  • paymentAuthorizationResults
    object
    All Of CreditCardVerification
  • paypalVerificationResults
    object
    All Of Paypal

Responses

• 200
  Example adaptiveAuthAccountsResponse

• accountId
  string

  • correlationId
    string
  • decisionReason
    string
  • forterDecision
    string<APPROVE | DECLINE | VERIFICATION_REQUIRED | NOT_REVIEWED>
  • merchantPolicyId
    string
  • recommendation
    string
  • verificationMethod
    VerificationMethod

• 400
  Bad Request (Often missing a required parameter)

• 401
  Unauthorized (No valid API key provided)

• 404
  Not Found (The requested item doesn't exist)

• 500
  Server Error (Something went wrong on Forter's end)

Request

Curl

curl --request POST \
  --url https://api.forter-secure.com/v2/accounts/authentication-result/{id} \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'api-version: 10.1' \
  --header 'x-forter-siteid: a1b2c3d4e5f6' \
  --data-raw '{
    "accountId": "e520-ba9a-367-60b",
    "additionalAuthenticationMethod": {
        "correlationId": "HGJ7512345H3DE",
        "documentVerification": {
            "documentSource": "UPLOADED_FILE",
            "documentType": "Passport",
            "documentVerificationServiceResponsePayload": {}
        },
        "emailVerification": {
            "email": "john_s@test.com",
            "emailVerification": {
                "sent": true,
                "verified": false
            }
        },
        "oneTimePasswordVerification": {
            "verificationMethod": "Google Authenticator",
            "verified": false
        },
        "paymentInstrumentVerification": {},
        "phoneVerification": {
            "phone": "15557654321",
            "smsVerified": {
                "sent": true,
                "verified": false
            }
        },
        "verificationOutcome": "SUCCESS"
    },
    "additionalInformation": {},
    "bankTransferVerificationResults": {
        "paymentGatewayData": {}
    },
    "connectionInformation": {
        "customerIP": "10.0.0.127",
        "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": {},
    "paymentAuthorizationResults": {
        "external3dsVendorPayload": {}
    },
    "paypalVerificationResults": {
        "fullPaypalResponsePayload": {},
        "payerEmail": "john_s@test.com",
        "payerId": "FD000A45P",
        "paymentGatewayData": {}
    }
}'

Responses

• 200
  Example adaptiveAuthAccountsResponse

{
  "accountId": "e520-ba9a-367-60b",
  "correlationId": "HGJ7512345H3DE",
  "decisionReason": "",
  "forterDecision": "",
  "merchantPolicyId": "0ee8ba28a8654c659addbae9253b707c",
  "recommendation": "",
  "verificationMethod": {
    "correlationId": "HGJ7512345H3DE",
    "status": "FRICTIONLESS",
    "statusCode": "100",
    "statusMessage": "Verification code sent",
    "type": "THREE_DS",
    "verificationId": "345H3DEHGJ7512",
    "verificationSpecificData": {
      "ThreeDS": {},
      "email": {},
      "phone": {}
    }
  }
}