--- title: Authentication result slug: reference/authentication-result docTags: createdAt: 2026-08-23T06:01:06.452Z --- { "id": "iAj7lN0Ph4QLS37kWcgy2", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.forter-secure.com/v2/accounts/authentication-result/{id}", "servers": [ { "url": "https://api.forter-secure.com/v2/accounts/authentication-result/{id}" } ], "name": "Authentication result", "description": "

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.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "api-version", "type": "string", "example": "10.3", "description": "Specify the version of the API to target." }, { "kind": "required", "name": "x-forter-siteid", "type": "string", "example": "a1b2c3d4e5f6", "description": "

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

" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "

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.

", "customType": "accountAuthenticationRequest", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "Customer's account UID in merchant's site. Should not be the user email.", "example": "e520-ba9a-367-60b", "maxLength": 50 }, { "name": "additionalAuthenticationMethod", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AdvancedAuthenticationMethod", "description": "", "modelRef": "#/components/schemas/AdvancedAuthenticationMethod", "schema": [ { "name": "correlationId", "kind": "required", "type": "string", "description": "A forter unique identifier that was provided as part of a Forter API response recommending additional authentication measures. Used to correlate between the user action which triggered the recommendation and the authentication attempt result. Required when the additional authentication was triggered by Forter's recommendation.", "example": "HGJ7512345H3DE" }, { "name": "documentVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AdditionalVerificationDocuments", "description": "", "modelRef": "#/components/schemas/AdditionalVerificationDocuments", "schema": [ { "name": "documentDateOfBirth", "kind": "optional", "type": "string", "nullable": true, "description": "

Date of birth as appears on the document. Use YYYY-MM-DD format.

", "example": "1991-01-09", "format": "date" }, { "name": "documentExpiration", "kind": "optional", "type": "string", "nullable": true, "description": "

Document's exipration date. Use YYYY-MM-DD format.

", "example": "2017-01-15", "format": "date" }, { "name": "documentFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "First name as appears on the document", "example": "John", "maxLength": 50 }, { "name": "documentIssuingState", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument issuing state or region", "example": "NY", "maxLength": 25 }, { "name": "documentLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Last name as appears on the document", "example": "Smith", "maxLength": 50 }, { "name": "documentNumber", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Official document's number (e.g. passport number, driving license number, etc.)

", "example": "20439190", "maxLength": 50 }, { "name": "documentSource", "kind": "required", "type": "string", "description": "

Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)

", "example": "UPLOADED_FILE", "enum": [ "CAMERA_CAPTURED", "UPLOADED_FILE", "TYPED", "OTHER" ] }, { "name": "documentStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).

", "example": "SENT_TO_CLIENT", "enum": [ "SENT_TO_CLIENT", "RECEIVED_FROM_CLIENT", "ABANDONED_BY_CLIENT", "RECEIVED_FROM_CLIENT_FAULTY" ], "maxLength": 50 }, { "name": "documentType", "kind": "required", "type": "string", "description": "

Type of document (Passport, ID, Driving license)

", "example": "Passport", "maxLength": 35 }, { "name": "documentVerificationServiceAnswer", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nAnswer received from 3rd party document verification services", "example": "APPROVED", "maxLength": 20 }, { "name": "documentVerificationServiceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nName of 3rd party document verifcation service", "example": "IDVerification.com", "maxLength": 50 }, { "name": "documentVerificationServiceResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "documentVerified", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\nTrue if document was verified as authentic by merchant or 3rd party service", "example": true }, { "name": "eventTime", "kind": "optional", "type": "number", "nullable": true, "description": "

Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00

is 1420070400

", "example": 1420070400 }, { "name": "nationality", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nDocument holder's nationality", "example": "US", "maxLength": 25 } ] } ], "schema": [] }, { "name": "emailVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Email", "description": "", "modelRef": "#/components/schemas/Email", "schema": [ { "name": "email", "kind": "required", "type": "string", "description": "Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "emailVerification", "kind": "required", "type": "object", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site

", "modelRef": "#/components/schemas/Verification", "customType": "Verification", "schema": [ { "name": "sent", "kind": "required", "type": "boolean", "description": "True if verification email was sent to email address or verification SMS was sent to phone number", "example": true }, { "name": "timeSent", "kind": "optional", "type": "number", "nullable": true, "description": "

Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

", "example": false } ] } ] } ], "schema": [] }, { "name": "oneTimePasswordVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "SimplifiedVerification", "description": "", "modelRef": "#/components/schemas/SimplifiedVerification", "schema": [ { "name": "timeVerified", "kind": "optional", "type": "number", "nullable": true, "description": "

Date user was verified in seconds since unix epoch(UTC, Jan 1, 1970)

", "example": 1388560227 }, { "name": "verificationMethod", "kind": "required", "type": "string", "description": "Type of one time verification method", "example": "Google Authenticator", "maxLength": 50 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "Was the user verified via the chosen verification method", "example": false } ] } ], "schema": [] }, { "name": "paymentInstrumentVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentInstrumentVerification", "description": "", "modelRef": "#/components/schemas/PaymentInstrumentVerification", "schema": [ { "name": "cameraCaptured", "kind": "optional", "type": "boolean", "nullable": true, "description": "The user successfully took a photo of their credit card using an OCR feature of the mobile app", "example": false }, { "name": "creditCardManuallyTypedIn", "kind": "optional", "type": "boolean", "nullable": true, "description": "The user successfully typed in the full number of the credit card that was saved in the account", "example": false }, { "name": "cvvManuallyTypedIn", "kind": "optional", "type": "boolean", "nullable": true, "description": "The user successfully typed in the CVV of the credit card that was saved in the account", "example": false }, { "name": "lastFourDigits", "kind": "optional", "type": "string", "nullable": true, "description": "Last 4 digits of the credit card that was verified", "example": "4242", "maxLength": 4, "pattern": "[0-9]{4}" }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "Token of the credit card that was verified", "example": "tkn-77620C360132856A103477D2959967AB", "maxLength": 200 } ] } ], "schema": [] }, { "name": "phoneVerification", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Phone", "description": "", "modelRef": "#/components/schemas/Phone", "schema": [ { "name": "phone", "kind": "required", "type": "string", "description": "Phone number including all country and local access codes", "example": "15557654321", "maxLength": 25 }, { "name": "smsVerified", "kind": "required", "type": "object", "description": "Phone verification details", "modelRef": "#/components/schemas/Verification", "customType": "Verification", "schema": [ { "name": "sent", "kind": "required", "type": "boolean", "description": "True if verification email was sent to email address or verification SMS was sent to phone number", "example": true }, { "name": "timeSent", "kind": "optional", "type": "number", "nullable": true, "description": "

Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

", "example": false } ] } ] } ], "schema": [] }, { "name": "verificationOutcome", "kind": "required", "type": "string", "description": "Outcome of verification attempt", "example": "SUCCESS", "enum": [ "SUCCESS", "FAILURE", "NONE_ATTEMPTED" ] } ] } ], "schema": [] }, { "name": "additionalInformation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "bankTransferVerificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "BankTransfer", "description": "", "modelRef": "#/components/schemas/BankTransfer", "schema": [ { "name": "accountHolderFirstName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder first name", "example": "John", "maxLength": 50 }, { "name": "accountHolderLastName", "kind": "optional", "type": "string", "nullable": true, "description": "Bank account holder last name", "example": "Smith", "maxLength": 50 }, { "name": "achProcessingType", "kind": "optional", "type": "string", "nullable": true, "description": "Type of ACH processing used in the transaction", "example": "SAME_DAY_ACH", "maxLength": 50 }, { "name": "bankAccountIdentifier", "kind": "optional", "type": "string", "nullable": true, "description": "

Bank account unique identifier (IBAN or equivalent)

", "example": "TEST63TEST1212121212", "maxLength": 40 }, { "name": "bankAccountType", "kind": "optional", "type": "string", "nullable": true, "description": "

Type of bank account payment is made from (e.g. savings/checking, etc.)

", "example": "Savings", "maxLength": 50 }, { "name": "bankName", "kind": "optional", "type": "string", "nullable": true, "description": "Name of bank payment is made from", "example": "Citigroup", "maxLength": 50 }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentSuccessStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Response text as received from the service provider", "example": "Payment Successful" }, { "name": "serviceName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment method name", "example": "Direct Debit", "maxLength": 30 } ] } ], "schema": [] }, { "name": "connectionInformation", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ConnectionInformation", "description": "", "modelRef": "#/components/schemas/ConnectionInformation", "schema": [ { "name": "checkoutToolsSessionId", "kind": "optional", "type": "string", "nullable": true, "description": "CheckoutToolsSessionId received from the SDK", "example": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd", "maxLength": 128 }, { "name": "customerIP", "kind": "required", "type": "string", "description": "Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1", "example": "10.0.0.127" }, { "name": "forterMobileUID", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

mobile UID. The device identifier such as IMEI in android or identifier for vendor in iOS. This should match the deviceId sent via the mobile events API (for mobile transactions only)

", "example": "6429751237891", "maxLength": 128 }, { "name": "forterTokenCookie", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nForter token cookie from request headers", "example": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg", "maxLength": 128 }, { "name": "merchantDeviceIdentifier", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nA unique device identifier generated by merchant", "example": "HGJ7512345H3", "maxLength": 100 }, { "name": "merchantProvidedSessionId", "kind": "optional", "type": "string", "nullable": true, "description": "An identifier of the merchant session", "example": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd", "maxLength": 128 }, { "name": "userAgent", "kind": "required", "type": "string", "description": "Customer's User agent", "example": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36", "maxLength": 4096 } ] } ], "schema": [] }, { "name": "eventTime", "kind": "required", "type": "number", "description": "

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

", "example": 1415287568000 }, { "name": "merchantIdentifiers", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "MerchantIdentifiers", "description": "", "modelRef": "#/components/schemas/MerchantIdentifiers", "schema": [ { "name": "merchantDomain", "kind": "optional", "type": "string", "nullable": true, "description": "

Use if merchant operates several sites (such as a regular site and a related discount brand)

", "example": "HandbagsExpressDiscounts.com", "maxLength": 2048 }, { "name": "merchantName", "kind": "optional", "type": "string", "nullable": true, "description": "

Use if merchant operates several sites (such as a regular site and a related discount brand)

", "example": "Handbags Express Discounts", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentAuthorizationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CreditCardVerification", "description": "", "modelRef": "#/components/schemas/CreditCardVerification", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nCard authorization code from payment gateway", "example": "A33244", "maxLength": 255 }, { "name": "authorizationProcessedWith3DS", "kind": "optional", "type": "boolean", "nullable": true, "description": "

3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization

", "example": true }, { "name": "avsFullResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string

", "example": "Y", "maxLength": 50 }, { "name": "avsNameResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Name portion of card's AVS result (when available)

", "example": "M", "maxLength": 30 }, { "name": "avsStreetResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nStreet address portion of card's AVS result", "example": "N", "maxLength": 30 }, { "name": "avsZipResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nZipcode portion of card's AVS result", "example": "M", "maxLength": 30 }, { "name": "cavvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response

", "example": "VYboNwcsB3F9gTIsbaUjvEuLW0o=", "maxLength": 50 }, { "name": "cvvResult", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

CVV result (if no data please send the value U)

", "example": "M", "maxLength": 30 }, { "name": "eciValue", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - ECI value recieved from authorization/authentication response

", "example": "05", "maxLength": 2 }, { "name": "exemptionStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nExemption status as received from the processor", "example": "accepted", "maxLength": 100 }, { "name": "external3dsVendorPayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "issuerResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from issuer", "example": "D23", "maxLength": 50 }, { "name": "issuerResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from issuer", "example": "Stolen card", "maxLength": 255 }, { "name": "liabilityShift", "kind": "optional", "type": "boolean", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer

", "example": true }, { "name": "partyExecuted3DS", "kind": "optional", "type": "string", "nullable": true, "description": "

3DSecure - Party executed the 3DS authentication

", "example": "PSP", "enum": [ "PSP", "FORTER", "BOTH" ] }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse code received from processor", "example": "D23", "maxLength": 50 }, { "name": "processorResponseText", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nResponse text received from processor", "example": "Stolen card", "maxLength": 255 }, { "name": "threeDsInteractionMode", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Indication of the friction that the user experienced

", "example": "FRICTIONLESS", "enum": [ "FRICTIONLESS", "CHALLENGED" ] }, { "name": "threeDsStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Status text received from 3D secure vendor

", "example": "Cardholder authenticated", "maxLength": 100 }, { "name": "threeDsVersion", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

3DSecure - Version used in the transaction

", "example": "2.1.0", "maxLength": 5 } ] } ], "schema": [] }, { "name": "paypalVerificationResults", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Paypal", "description": "", "modelRef": "#/components/schemas/Paypal", "schema": [ { "name": "authorizationId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal authorization ID", "example": "2WC75407LV7300439", "maxLength": 50 }, { "name": "fullPaypalResponsePayload", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "GeneralPayloadMap", "description": "", "modelRef": "#/components/schemas/GeneralPayloadMap", "schema": [] } ], "schema": [] }, { "name": "payerAccountCountry", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

PayPal account country, two-letter ISO 3166-1 alpha-2 country code

", "example": "US", "minLength": 2, "maxLength": 2 }, { "name": "payerAddressStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal payer address status", "example": "CONFIRMED" }, { "name": "payerEmail", "kind": "required", "type": "string", "description": "PayPal payer Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "payerId", "kind": "required", "type": "string", "description": "PayPal payer ID", "example": "FD000A45P", "maxLength": 154 }, { "name": "payerStatus", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal payer status", "example": "VERIFIED" }, { "name": "paymentGatewayData", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentGatewayData", "description": "", "modelRef": "#/components/schemas/PaymentGatewayData", "schema": [ { "name": "gatewayName", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayment gateway name", "example": "Braintree", "maxLength": 50 }, { "name": "gatewayTransactionId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\n

Unique transaction identifier (sent by gateway)

", "example": "fjdsS46sdklFd20", "maxLength": 50 } ] } ], "schema": [] }, { "name": "paymentId", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal payment ID", "example": "PAY-0MB00000KR8073311KZSDEYA", "maxLength": 50 }, { "name": "paymentStatus", "kind": "optional", "type": "string", "nullable": true, "description": "PayPal payment status", "example": "COMPLETED", "maxLength": 50 }, { "name": "protectionEligibility", "kind": "optional", "type": "string", "conditional": true, "nullable": true, "description": "Conditional.\nPayPal protection eligibility", "example": "ELIGIBLE" } ] } ], "schema": [] } ], "modelRef": "#/components/schemas/accountAuthenticationRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Example adaptiveAuthAccountsResponse", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response structure for adaptive auth account requests", "customType": "adaptiveAuthAccountsResponse", "schema": [ { "name": "accountId", "kind": "required", "type": "string", "description": "

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

", "example": "e520-ba9a-367-60b" }, { "name": "correlationId", "kind": "required", "type": "string", "description": "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", "example": "HGJ7512345H3DE" }, { "name": "decisionReason", "kind": "required", "type": "string", "description": "The main reason behind the Forter decision", "example": "", "maxLength": 1000 }, { "name": "forterDecision", "kind": "required", "type": "string", "description": "The latest Forter decision regarding the attempted action", "enum": [ "APPROVE", "DECLINE", "VERIFICATION_REQUIRED", "NOT_REVIEWED" ] }, { "name": "merchantPolicyId", "kind": "required", "type": "string", "description": "UID of the custom policy created in Forter's Policies tool that resulted in this decision", "example": "0ee8ba28a8654c659addbae9253b707c" }, { "name": "recommendation", "kind": "required", "type": "string", "description": "

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": "", "maxLength": 1000 }, { "name": "verificationMethod", "kind": "required", "type": "object", "description": "The specific verification method to be used when verification is required according to \"recommendation\" field", "modelRef": "#/components/schemas/VerificationMethod", "customType": "VerificationMethod", "schema": [ { "name": "correlationId", "kind": "required", "type": "string", "description": "A forter unique identifier that was provided as part of a Forter API response recommending additional authentication measures. Used to correlate between the user action which triggered the recommendation and the authentication attempt result. Required when the additional authentication was triggered by Forter's recommendation.", "example": "HGJ7512345H3DE" }, { "name": "status", "kind": "required", "type": "string", "description": "Verification status", "example": "FRICTIONLESS", "maxLength": 50 }, { "name": "statusCode", "kind": "required", "type": "string", "description": "Verification status code", "example": "100", "maxLength": 50 }, { "name": "statusMessage", "kind": "required", "type": "string", "description": "Text describes the verification status", "example": "Verification code sent", "maxLength": 50 }, { "name": "type", "kind": "required", "type": "string", "description": "Verification method type", "example": "THREE_DS", "enum": [ "OTP_SMS", "OTP_EMAIL", "THREE_DS" ], "maxLength": 50 }, { "name": "verificationId", "kind": "required", "type": "string", "description": "A unique identifier assigned to that specific verification", "example": "345H3DEHGJ7512" }, { "name": "verificationSpecificData", "kind": "required", "type": "object", "description": "Data specific to the verification type performed", "modelRef": "#/components/schemas/VerificationData", "customType": "VerificationData", "schema": [ { "name": "ThreeDS", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureResponse", "description": "", "modelRef": "#/components/schemas/ThreeDSecureResponse", "schema": [ { "name": "ACSUrl", "kind": "required", "type": "string", "description": "

In case of challange, this url is needed to be passed to client side and trigger ftr__.init3DS function

", "example": "https:/ /acs-us-east-1.nd.nds-sandbox-issuer.com/api/v1/acs/browser_sdk_challenges", "maxLength": 2048 }, { "name": "ECIValue", "kind": "required", "type": "string", "description": "

Electronic Commerce Indicator (ECI) is a value that is returned from the Directory Server (Visa, MasterCard, etc) to indicate the authentication results of your customer's credit card payment on 3D Secure. ECI only available when the challenge is not needed or after challenge had been completed. Possible values: 00, 01, 02, 04, 05, 06, 07

", "example": "02", "maxLength": 300 }, { "name": "acsChallengeMandated", "kind": "required", "type": "string", "description": "

Indication of whether a challenge is required for the transaction to be authorised due to local/regional mandates or other variable (Y - Challenge is mandated, N - Challenge is not mandated)

", "example": "Y", "maxLength": 1 }, { "name": "acsReferenceNumber", "kind": "required", "type": "string", "description": "

Unique identifier assigned by the EMVCo Secretariat = required for mobile app implementation

", "example": "ftr-internal-acs-approval", "maxLength": 32 }, { "name": "acsSignedContent", "kind": "required", "type": "string", "description": "ACS Signed Content required for mobile app implementation", "example": "", "maxLength": 1000 }, { "name": "acsTransID", "kind": "required", "type": "string", "description": "

Universally Unique transaction identifier assigned by the ACS to identify a single transaction - required for mobile app implementation

", "example": "6fd30e89-8171-4cc3-b86e-3d59582af2f6", "maxLength": 36 }, { "name": "authenticationType", "kind": "required", "type": "string", "description": "

Optional authentication type (01 - Static, 02 - Dynamic, 03 - OOB, 04 - Decoupled)

", "example": "01", "maxLength": 2 }, { "name": "authenticationValue", "kind": "required", "type": "string", "description": "

3DS Authentication value (AV) should be sent to the payment gateway in the authorization call

", "example": "tSvPDt3PINNaoL+ERXdg0jVrmWc=", "maxLength": 28 }, { "name": "bankLiabilityShift", "kind": "required", "type": "boolean", "description": "Indicates whether transaction is supposed to get liability shift from issuer", "example": true, "maxLength": 1 }, { "name": "cardEnrolled", "kind": "required", "type": "string", "description": "

3DS transaction card Enrolled status - should be sent to the payment gateway in the authorization call in some payment gateways

", "example": "Y", "maxLength": 1 }, { "name": "cavvAlgorithm", "kind": "required", "type": "string", "description": "

3DS Authentication value algorithm - should be sent to the payment gateway in the authorization call in some payment gateways. Possible values (3DS1 only): 0, 1, 2, 3, 4, 7

", "example": "3", "maxLength": 1 }, { "name": "challengeCancel", "kind": "required", "type": "string", "description": "

Indicator informing the ACS and the DS that the authentication has been canceled. Possible values: 01-99

", "example": "01", "maxLength": 2 }, { "name": "challengeStatus", "kind": "required", "type": "string", "description": "

Ares transStatus value (Possible values: U, N, Y, A, C, D, R, I)

", "example": "Y", "maxLength": 1 }, { "name": "dsTransID", "kind": "required", "type": "string", "description": "Universally unique transaction identifier assigned by the DS to identify a single transaction", "example": "38bbf46f-c023-4f4c-ae2c-35fb301632a5", "maxLength": 100 }, { "name": "encodedChallengeRequest", "kind": "required", "type": "string", "description": "

This value will only be available when challenge is needed, in the challenge flow - this must be passed to browser in order to trigger the challenge

", "example": "eyJhY3NUcmFuc0lEIjoiMTEyY2RiNWItMGFlYy00MTY5LThjMWYtYWMyN2JlNjAxMjhhIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiZWRhM2MwMzYtZWMyYS00NmZkLTlmYWItNzBlZTgyYjJjNzQ5In0=" }, { "name": "exemption", "kind": "optional", "type": "string", "nullable": true, "description": "Exemption that should be used during the authorization process", "example": "TRANSACTION_RISK_ANALYSIS", "enum": [ "LOW_VALUE", "TRANSACTION_RISK_ANALYSIS", "SECURE_CORPORATE", "TRUSTED_BENEFICIARY" ] }, { "name": "interactionCounter", "kind": "required", "type": "string", "description": "Indicates the number of authentication cycles attempted by the Cardholder", "example": "01", "maxLength": 2 }, { "name": "isFallback", "kind": "required", "type": "boolean", "description": "Indication of whether a 3DS1 challenge was performed as a fallback to 3DS2 error", "example": false, "maxLength": 5 }, { "name": "messageCategory", "kind": "required", "type": "string", "description": "

Identifies the category of the message for a specific use case (01 - PA, 02 - NPA)

", "example": "01", "maxLength": 2 }, { "name": "outOfScopeForPSD2", "kind": "optional", "type": "string", "nullable": true, "description": "This field indicate if transaction is out of scope for PSD2 and exclusion should be requested", "example": "ANONYMOUS_PREPAID_CARD", "enum": [ "ANONYMOUS_PREPAID_CARD", "MERCHANT_INITIATED_TRANSACTIONS", "ONE_LEG_OUT_EEA", "MAIL_ORDER_TELEPHONE_ORDER" ] }, { "name": "threeDSServerTransID", "kind": "required", "type": "string", "description": "

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction (in 3DS1 equal to XID)

", "example": "26d648a9-da8a-4f8b-a76d-094801d2fd45", "maxLength": 100 }, { "name": "threeDSecureMode", "kind": "required", "type": "string", "description": "

Indicate if the transaction is Frictionless or SCA. Being used by some payment gateways. Possible values: sca, frictionless

", "example": "sca", "maxLength": 15 }, { "name": "threeDSecurePreference", "kind": "required", "type": "string", "description": "

The challenge indicator used. Being used by some payment gateways. Possible values: nopref, frictionless, sca, scamandate

", "example": "nopref", "maxLength": 15 }, { "name": "threeDSecureResult", "kind": "required", "type": "string", "description": "This field is relevant for 3DS1 and being used by some payment gateways", "example": "590040", "maxLength": 6 }, { "name": "transStatus", "kind": "required", "type": "string", "description": "

3DS transStatus value - Indicates whether a transaction qualifies as an authenticated transaction or account verification. should be sent to the payment gateway in the authorization call (Possible values: U, N, Y, A, C, D, R, I)

", "example": "Y", "maxLength": 1 }, { "name": "transStatusReason", "kind": "required", "type": "string", "description": "

Provides information on why the Transaction Status field has the specified value. Possible values: 01-99

", "example": "01", "maxLength": 2 }, { "name": "verifyStatus", "kind": "required", "type": "string", "description": "

Cres transStatus value (Possible values: U, N, Y, A, C, D, R, I, null)

", "example": "Y", "maxLength": 1 }, { "name": "version", "kind": "required", "type": "string", "description": "

Version. Possible values: 1.0.2, 2.1.0, 2.2.0

", "example": "2.1.0", "maxLength": 50 } ] } ], "schema": [] }, { "name": "email", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Email", "description": "", "modelRef": "#/components/schemas/Email", "schema": [ { "name": "email", "kind": "required", "type": "string", "description": "Email address", "example": "john_s@test.com", "maxLength": 256 }, { "name": "emailVerification", "kind": "required", "type": "object", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site

", "modelRef": "#/components/schemas/Verification", "customType": "Verification", "schema": [ { "name": "sent", "kind": "required", "type": "boolean", "description": "True if verification email was sent to email address or verification SMS was sent to phone number", "example": true }, { "name": "timeSent", "kind": "optional", "type": "number", "nullable": true, "description": "

Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

", "example": false } ] } ] } ], "schema": [] }, { "name": "phone", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Phone", "description": "", "modelRef": "#/components/schemas/Phone", "schema": [ { "name": "phone", "kind": "required", "type": "string", "description": "Phone number including all country and local access codes", "example": "15557654321", "maxLength": 25 }, { "name": "smsVerified", "kind": "required", "type": "object", "description": "Phone verification details", "modelRef": "#/components/schemas/Verification", "customType": "Verification", "schema": [ { "name": "sent", "kind": "required", "type": "boolean", "description": "True if verification email was sent to email address or verification SMS was sent to phone number", "example": true }, { "name": "timeSent", "kind": "optional", "type": "number", "nullable": true, "description": "

Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)

", "example": 1389567341 }, { "name": "verified", "kind": "required", "type": "boolean", "description": "

True if customer received email verification message to this address and clicked-through back to merchant's site, or received SMS message and enterd code in merchant's site (two-factor authentication)

", "example": false } ] } ] } ], "schema": [] } ] } ] } ], "modelRef": "#/components/schemas/adaptiveAuthAccountsResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request (Often missing a required parameter)

", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "

Unauthorized (No valid API key provided)

", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "

Not Found (The requested item doesn't exist)

", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "

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

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "GC9UYB_koFZb3d-Ozlcjr", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.forter-secure.com/v2/accounts/authentication-result/{id} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'api-version: 10.3' \\\n --header 'x-forter-siteid: a1b2c3d4e5f6' \\\n --data-raw '{\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": false\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\n \"additionalInformation\": {},\n \"bankTransferVerificationResults\": {\n \"paymentGatewayData\": {}\n },\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"eventTime\": 1415287568000,\n \"merchantIdentifiers\": {},\n \"paymentAuthorizationResults\": {\n \"external3dsVendorPayload\": {}\n },\n \"paypalVerificationResults\": {\n \"fullPaypalResponsePayload\": {},\n \"payerEmail\": \"john_s@test.com\",\n \"payerId\": \"FD000A45P\",\n \"paymentGatewayData\": {}\n }\n }'" }, { "id": "FIGo5oL-nDsv1HUhtwa2N", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"api-version\", \"10.3\");\nmyHeaders.append(\"x-forter-siteid\", \"a1b2c3d4e5f6\");\n\nvar raw = JSON.stringify({\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": false\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\n \"additionalInformation\": {},\n \"bankTransferVerificationResults\": {\n \"paymentGatewayData\": {}\n },\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"eventTime\": 1415287568000,\n \"merchantIdentifiers\": {},\n \"paymentAuthorizationResults\": {\n \"external3dsVendorPayload\": {}\n },\n \"paypalVerificationResults\": {\n \"fullPaypalResponsePayload\": {},\n \"payerEmail\": \"john_s@test.com\",\n \"payerId\": \"FD000A45P\",\n \"paymentGatewayData\": {}\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.forter-secure.com/v2/accounts/authentication-result/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "RApezyt_z2lGEOlVPP-NU", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.forter-secure.com/v2/accounts/authentication-result/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"api-version\"] = \"10.3\"\nrequest[\"x-forter-siteid\"] = \"a1b2c3d4e5f6\"\nrequest.body = JSON.dump({\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": false\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": true,\n \"verified\": false\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\n \"additionalInformation\": {},\n \"bankTransferVerificationResults\": {\n \"paymentGatewayData\": {}\n },\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"eventTime\": 1415287568000,\n \"merchantIdentifiers\": {},\n \"paymentAuthorizationResults\": {\n \"external3dsVendorPayload\": {}\n },\n \"paypalVerificationResults\": {\n \"fullPaypalResponsePayload\": {},\n \"payerEmail\": \"john_s@test.com\",\n \"payerId\": \"FD000A45P\",\n \"paymentGatewayData\": {}\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "KD3VZ-k_bMM82NTEqIqP8", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.forter-secure.com/v2/accounts/authentication-result/{id}\"\n\npayload = json.dumps({\n \"accountId\": \"e520-ba9a-367-60b\",\n \"additionalAuthenticationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"documentVerification\": {\n \"documentSource\": \"UPLOADED_FILE\",\n \"documentType\": \"Passport\",\n \"documentVerificationServiceResponsePayload\": {}\n },\n \"emailVerification\": {\n \"email\": \"john_s@test.com\",\n \"emailVerification\": {\n \"sent\": True,\n \"verified\": False\n }\n },\n \"oneTimePasswordVerification\": {\n \"verificationMethod\": \"Google Authenticator\",\n \"verified\": False\n },\n \"paymentInstrumentVerification\": {},\n \"phoneVerification\": {\n \"phone\": \"15557654321\",\n \"smsVerified\": {\n \"sent\": True,\n \"verified\": False\n }\n },\n \"verificationOutcome\": \"SUCCESS\"\n },\n \"additionalInformation\": {},\n \"bankTransferVerificationResults\": {\n \"paymentGatewayData\": {}\n },\n \"connectionInformation\": {\n \"customerIP\": \"10.0.0.127\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36\"\n },\n \"eventTime\": 1415287568000,\n \"merchantIdentifiers\": {},\n \"paymentAuthorizationResults\": {\n \"external3dsVendorPayload\": {}\n },\n \"paypalVerificationResults\": {\n \"fullPaypalResponsePayload\": {},\n \"payerEmail\": \"john_s@test.com\",\n \"payerId\": \"FD000A45P\",\n \"paymentGatewayData\": {}\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'api-version': '10.3',\n 'x-forter-siteid': 'a1b2c3d4e5f6'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "GC9UYB_koFZb3d-Ozlcjr" }, "results": { "languages": [ { "id": "ifWpw03sfIs5JhXtYQAup", "language": "200", "code": "// Example adaptiveAuthAccountsResponse\n{\n \"accountId\": \"e520-ba9a-367-60b\",\n \"correlationId\": \"HGJ7512345H3DE\",\n \"decisionReason\": \"\",\n \"forterDecision\": \"\",\n \"merchantPolicyId\": \"0ee8ba28a8654c659addbae9253b707c\",\n \"recommendation\": \"\",\n \"verificationMethod\": {\n \"correlationId\": \"HGJ7512345H3DE\",\n \"status\": \"FRICTIONLESS\",\n \"statusCode\": \"100\",\n \"statusMessage\": \"Verification code sent\",\n \"type\": \"THREE_DS\",\n \"verificationId\": \"345H3DEHGJ7512\",\n \"verificationSpecificData\": {\n \"ThreeDS\": {},\n \"email\": {},\n \"phone\": {}\n }\n }\n}" }, { "id": "hZztqEbVm27n0niPgqetc", "language": "400", "code": "// Bad Request (Often missing a required parameter)\n" }, { "id": "2uoz0UnMfDCmdSjgp562S", "language": "401", "code": "// Unauthorized (No valid API key provided)\n" }, { "id": "3ka48VvlaqzKbhkWKV-9k", "language": "404", "code": "// Not Found (The requested item doesn't exist)\n" }, { "id": "wwJxilhu8oHUFVRhp8y23", "language": "500", "code": "// Server Error (Something went wrong on Forter's end)\n" } ], "selectedLanguageId": "ifWpw03sfIs5JhXtYQAup" } }, "children": [ { "text": "" } ] }