認証結果

POST

https://api.forter-secure.com/v2/accounts/authentication-result/{id}

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.

Path Parameters

idstringrequired

Header Parameters

api-versionstringrequired
Example
10.1
Description
Specify the version of the API to target.
Default
10.1
x-forter-siteidstringrequired
Example
a1b2c3d4e5f6
Description
Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.
Default
8b47c6d423ba

Body Parameters

bodyaccountAuthenticationRequestrequired
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.
- accountIdstringrequired
  Description
  Customer's account UID in merchant's site. Should not be the user email.
  Default
  e520-ba9a-367-60b
- additionalAuthenticationMethodobject
  - AdvancedAuthenticationMethod
    - correlationIdstringrequired
      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.
      Default
      HGJ7512345H3DE
    - documentVerificationobject
      - AdditionalVerificationDocuments
        documentDateOfBirthstring<date>
        Description
        Date of birth as appears on the document. Use YYYY-MM-DD format.
        Default
        1991-01-09
        documentExpirationstring<date>
        Description
        Document's exipration date. Use YYYY-MM-DD format.
        Default
        2017-01-15
        documentFirstNamestring
        Description
        First name as appears on the document
        Default
        John
        documentIssuingStatestring
        Description
        Document issuing state or region
        Default
        NY
        documentLastNamestring
        Description
        Last name as appears on the document
        Default
        Smith
        documentNumberstring
        Description
        Official document's number (e.g. passport number, driving license number, etc.)
        Default
        20439190
        documentSourcestring<CAMERA_CAPTURED | UPLOADED_FILE | TYPED | OTHER>required
        Description
        Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)
        Default
        UPLOADED_FILE
        documentStatusstring<SENT_TO_CLIENT | RECEIVED_FROM_CLIENT | ABANDONED_BY_CLIENT | RECEIVED_FROM_CLIENT_FAULTY>
        Description
        Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).
        Default
        SENT_TO_CLIENT
        documentTypestringrequired
        Description
        Type of document (Passport, ID, Driving license)
        Default
        Passport
        documentVerificationServiceAnswerstring
        Description
        Answer received from 3rd party document verification services
        Default
        APPROVED
        documentVerificationServiceNamestring
        Description
        Name of 3rd party document verifcation service
        Default
        IDVerification.com
        documentVerificationServiceResponsePayloadobject
        GeneralPayloadMap
        documentVerifiedboolean
        Description
        True if document was verified as authentic by merchant or 3rd party service
        Default
        true
        eventTimenumber
        Description
        Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00:00 is 1420070400
        Default
        1420070400
        nationalitystring
        Description
        Document holder's nationality
        Default
        US
    - emailVerificationobject
      - Email
        emailstringrequired
        Description
        Email address
        Default
        [email protected]
        emailVerificationobject
        Verification
        sentbooleanrequired
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        Default
        true
        timeSentnumber
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1389567341
        verifiedbooleanrequired
        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)
        Default
        false
    - oneTimePasswordVerificationobject
      - SimplifiedVerification
        timeVerifiednumber
        Description
        Date user was verified in seconds since unix epoch(UTC, Jan 1, 1970)
        Default
        1388560227
        verificationMethodstringrequired
        Description
        Type of one time verification method
        Default
        Google Authenticator
        verifiedbooleanrequired
        Description
        Was the user verified via the chosen verification method
        Default
        false
    - paymentInstrumentVerificationobject
      - PaymentInstrumentVerification
        cameraCapturedboolean
        Description
        The user successfully took a photo of their credit card using an OCR feature of the mobile app
        Default
        false
        creditCardManuallyTypedInboolean
        Description
        The user successfully typed in the full number of the credit card that was saved in the account
        Default
        false
        cvvManuallyTypedInboolean
        Description
        The user successfully typed in the CVV of the credit card that was saved in the account
        Default
        false
        lastFourDigitsstring
        Description
        Last 4 digits of the credit card that was verified
        Default
        4242
        tokenstring
        Description
        Token of the credit card that was verified
        Default
        tkn-77620C360132856A103477D2959967AB
    - phoneVerificationobject
      - Phone
        phonestringrequired
        Description
        Phone number including all country and local access codes
        Default
        15557654321
        smsVerifiedobject
        Verification
        sentbooleanrequired
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        Default
        true
        timeSentnumber
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1389567341
        verifiedbooleanrequired
        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)
        Default
        false
    - verificationOutcomestring<SUCCESS | FAILURE | NONE_ATTEMPTED>required
      Description
      Outcome of verification attempt
      Default
      SUCCESS
- additionalInformationobject
  - GeneralPayloadMap
- bankTransferVerificationResultsobject
  - BankTransfer
    - accountHolderFirstNamestring
      Description
      Bank account holder first name
      Default
      John
    - accountHolderLastNamestring
      Description
      Bank account holder last name
      Default
      Smith
    - achProcessingTypestring
      Description
      Type of ACH processing used in the transaction
      Default
      SAME_DAY_ACH
    - bankAccountIdentifierstring
      Description
      Bank account unique identifier (IBAN or equivalent)
      Default
      TEST63TEST1212121212
    - bankAccountTypestring
      Description
      Type of bank account payment is made from (e.g. savings/checking, etc.)
      Default
      Savings
    - bankNamestring
      Description
      Name of bank payment is made from
      Default
      Citigroup
    - paymentGatewayDataobject
      - PaymentGatewayData
        gatewayNamestring
        Description
        Payment gateway name
        Default
        Braintree
        gatewayTransactionIdstring
        Description
        Unique transaction identifier (sent by gateway)
        Default
        fjdsS46sdklFd20
    - paymentSuccessStatusstring
      Description
      Response text as received from the service provider
      Default
      Payment Successful
    - serviceNamestring
      Description
      Payment method name
      Default
      Direct Debit
- connectionInformationobject
  - ConnectionInformation
    - checkoutToolsSessionIdstring
      Description
      CheckoutToolsSessionId received from the SDK
      Default
      HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
    - customerIPstringrequired
      Description
      Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1
      Default
      10.0.0.127
    - forterMobileUIDstring
      Description
      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)
      Default
      6429751237891
    - forterTokenCookiestring
      Description
      Forter token cookie from request headers
      Default
      249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg
    - merchantDeviceIdentifierstring
      Description
      A unique device identifier generated by merchant
      Default
      HGJ7512345H3
    - merchantProvidedSessionIdstring
      Description
      An identifier of the merchant session
      Default
      HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
    - userAgentstringrequired
      Description
      Customer's User agent
      Default
      Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36
- eventTimenumberrequired
  Description
  The time that the trigger event occurred in MILLISECONDS since unix epoch (Jan 1, 1970)
  Default
  1415287568000
- paymentAuthorizationResultsobject
  - CreditCardVerification
    - authorizationCodestring
      Description
      Card authorization code from payment gateway
      Default
      A33244
    - authorizationProcessedWith3DSboolean
      Description
      3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
      Default
      true
    - avsFullResultstring
      Description
      Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
      Default
      Y
    - avsNameResultstring
      Description
      Name portion of card's AVS result (when available)
      Default
      M
    - avsStreetResultstring
      Description
      Street address portion of card's AVS result
      Default
      N
    - avsZipResultstring
      Description
      Zipcode portion of card's AVS result
      Default
      M
    - cavvResultstring
      Description
      3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
      Default
      VYboNwcsB3F9gTIsbaUjvEuLW0o=
    - cvvResultstring
      Description
      CVV result (if no data please send the value U)
      Default
      M
    - eciValuestring
      Description
      3DSecure - ECI value recieved from authorization/authentication response
      Default
      05
    - liabilityShiftboolean
      Description
      3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
      Default
      true
    - processorResponseCodestring
      Description
      Response code received from processor
      Default
      D23
    - processorResponseTextstring
      Description
      Response text received from processor
      Default
      Stolen card
    - threeDsStatusstring
      Description
      3DSecure - Status text received from 3D secure vendor
      Default
      Cardholder authenticated
    - threeDsVersionstring
      Description
      3DSecure - Version used in the transaction
      Default
      2.1.0
- paypalVerificationResultsobject
  - Paypal
    - authorizationIdstring
      Description
      PayPal authorization ID
      Default
      2WC75407LV7300439
    - fullPaypalResponsePayloadobject
      - GeneralPayloadMap
    - payerAccountCountrystring
      Description
      PayPal account country, two-letter ISO 3166-1 alpha-2 country code
      Default
      US
    - payerAddressStatusstring
      Description
      PayPal payer address status
      Default
      CONFIRMED
    - payerEmailstringrequired
      Description
      PayPal payer Email address
      Default
      [email protected]
    - payerIdstringrequired
      Description
      PayPal payer ID
      Default
      FD000A45P
    - payerStatusstring
      Description
      PayPal payer status
      Default
      VERIFIED
    - paymentGatewayDataobject
      - PaymentGatewayData
        gatewayNamestring
        Description
        Payment gateway name
        Default
        Braintree
        gatewayTransactionIdstring
        Description
        Unique transaction identifier (sent by gateway)
        Default
        fjdsS46sdklFd20
    - paymentIdstring
      Description
      PayPal payment ID
      Default
      PAY-0MB00000KR8073311KZSDEYA
    - paymentStatusstring
      Description
      PayPal payment status
      Default
      COMPLETED
    - protectionEligibilitystring
      Description
      PayPal protection eligibility
      Default
      ELIGIBLE

Responses

200Example adaptiveAuthAccountsResponse

adaptiveAuthAccountsResponse
Description
Response structure for adaptive auth account requests
- accountIdstringrequired
  Description
  When applicable, the customer's account UID in merchant's site
  Default
  e520-ba9a-367-60b
- correlationIdstringrequired
  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
  Default
  HGJ7512345H3DE
- decisionReasonstringrequired
  Description
  The main reason behind the Forter decision
  Default
- forterDecisionstring<APPROVE | DECLINE | VERIFICATION_REQUIRED | NOT_REVIEWED>required
  Description
  The latest Forter decision regarding the attempted action
  Default
  APPROVE
- merchantPolicyIdstringrequired
  Description
  UID of the custom policy created in Forter's Policies tool that resulted in this decision
  Default
  0ee8ba28a8654c659addbae9253b707c
- recommendationstringrequired
  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.)
  Default
- verificationMethodVerificationMethodrequired
  Description
  The specific verification method to be used when verification is required according to "recommendation" field
  - correlationIdstringrequired
    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.
    Default
    HGJ7512345H3DE
  - statusstringrequired
    Description
    Verification status
    Default
    FRICTIONLESS
  - statusCodestringrequired
    Description
    Verification status code
    Default
    100
  - statusMessagestringrequired
    Description
    Text describes the verification status
    Default
    Verification code sent
  - typestring<OTP_SMS | OTP_EMAIL | THREE_DS>required
    Description
    Verification method type
    Default
    THREE_DS
  - verificationIdstringrequired
    Description
    A unique identifier assigned to that specific verification
    Default
    345H3DEHGJ7512
  - verificationSpecificDataVerificationDatarequired
    Description
    Data specific to the verification type performed
    - ThreeDSobject
      - ThreeDSecureResponse
        ACSUrlstringrequired
        Description
        In case of challange, this url is needed to be passed to client side and trigger ftr__.init3DS function
        Default
        https:/ /acs-us-east-1.nd.nds-sandbox-issuer.com/api/v1/acs/browser_sdk_challenges
        ECIValuestringrequired
        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
        Default
        02
        acsChallengeMandatedstringrequired
        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)
        Default
        Y
        acsReferenceNumberstringrequired
        Description
        Unique identifier assigned by the EMVCo Secretariat = required for mobile app implementation
        Default
        ftr-internal-acs-approval
        acsSignedContentstringrequired
        Description
        ACS Signed Content required for mobile app implementation
        Default
        acsTransIDstringrequired
        Description
        Universally Unique transaction identifier assigned by the ACS to identify a single transaction - required for mobile app implementation
        Default
        6fd30e89-8171-4cc3-b86e-3d59582af2f6
        authenticationTypestringrequired
        Description
        Optional authentication type (01 - Static, 02 - Dynamic, 03 - OOB, 04 - Decoupled)
        Default
        01
        authenticationValuestringrequired
        Description
        3DS Authentication value (AV) should be sent to the payment gateway in the authorization call
        Default
        tSvPDt3PINNaoL+ERXdg0jVrmWc=
        bankLiabilityShiftbooleanrequired
        Description
        Indicates whether transaction is supposed to get liability shift from issuer
        Default
        true
        cardEnrolledstringrequired
        Description
        3DS transaction card Enrolled status - should be sent to the payment gateway in the authorization call in some payment gateways
        Default
        Y
        cavvAlgorithmstringrequired
        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
        Default
        3
        challengeCancelstringrequired
        Description
        Indicator informing the ACS and the DS that the authentication has been canceled. Possible values: 01-99
        Default
        01
        challengeStatusstringrequired
        Description
        Ares transStatus value (Possible values: U, N, Y, A, C, D, R, I)
        Default
        Y
        dsTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the DS to identify a single transaction
        Default
        38bbf46f-c023-4f4c-ae2c-35fb301632a5
        encodedChallengeRequeststringrequired
        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
        Default
        eyJhY3NUcmFuc0lEIjoiMTEyY2RiNWItMGFlYy00MTY5LThjMWYtYWMyN2JlNjAxMjhhIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiZWRhM2MwMzYtZWMyYS00NmZkLTlmYWItNzBlZTgyYjJjNzQ5In0=
        exemptionstring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>
        Description
        Exemption that should be used during the authorization process
        Default
        TRANSACTION_RISK_ANALYSIS
        interactionCounterstringrequired
        Description
        Indicates the number of authentication cycles attempted by the Cardholder
        Default
        01
        isFallbackbooleanrequired
        Description
        Indication of whether a 3DS1 challenge was performed as a fallback to 3DS2 error
        Default
        false
        messageCategorystringrequired
        Description
        Identifies the category of the message for a specific use case (01 - PA, 02 - NPA)
        Default
        01
        outOfScopeForPSD2string<ANONYMOUS_PREPAID_CARD | MERCHANT_INITIATED_TRANSACTIONS | ONE_LEG_OUT_EEA | MAIL_ORDER_TELEPHONE_ORDER>
        Description
        This field indicate if transaction is out of scope for PSD2 and exclusion should be requested
        Default
        ANONYMOUS_PREPAID_CARD
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction (in 3DS1 equal to XID)
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDSecureModestringrequired
        Description
        Indicate if the transaction is Frictionless or SCA. Being used by some payment gateways. Possible values: sca, frictionless
        Default
        sca
        threeDSecurePreferencestringrequired
        Description
        The challenge indicator used. Being used by some payment gateways. Possible values: nopref, frictionless, sca, scamandate
        Default
        nopref
        threeDSecureResultstringrequired
        Description
        This field is relevant for 3DS1 and being used by some payment gateways
        Default
        590040
        transStatusstringrequired
        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)
        Default
        Y
        transStatusReasonstringrequired
        Description
        Provides information on why the Transaction Status field has the specified value. Possible values: 01-99
        Default
        01
        verifyStatusstringrequired
        Description
        Cres transStatus value (Possible values: U, N, Y, A, C, D, R, I, null)
        Default
        Y
        versionstringrequired
        Description
        Version. Possible values: 1.0.2, 2.1.0, 2.2.0
        Default
        2.1.0
    - emailobject
      - Email
        emailstringrequired
        Description
        Email address
        Default
        [email protected]
        emailVerificationobject
        Verification
        sentbooleanrequired
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        Default
        true
        timeSentnumber
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1389567341
        verifiedbooleanrequired
        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)
        Default
        false
    - phoneobject
      - Phone
        phonestringrequired
        Description
        Phone number including all country and local access codes
        Default
        15557654321
        smsVerifiedobject
        Verification
        sentbooleanrequired
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        Default
        true
        timeSentnumber
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1389567341
        verifiedbooleanrequired
        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)
        Default
        false

400Bad Request (Often missing a required parameter)

401Unauthorized (No valid API key provided)

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

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

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: 8b47c6d423ba' \
     --header 'authorization: Basic <base64-encoded-api-key:>' \
     --data-raw '{
     "accountId": "e520-ba9a-367-60b",
     "additionalAuthenticationMethod": {
     "correlationId": "HGJ7512345H3DE",
     "documentVerification": {
     "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",
     "documentVerificationServiceResponsePayload": {},
     "documentVerified": true,
     "eventTime": 1420070400,
     "nationality": "US"
     },
     "emailVerification": {
     "email": "[email protected]",
     "emailVerification": {
     "sent": true,
     "timeSent": 1389567341,
     "verified": false
     }
     },
     "oneTimePasswordVerification": {
     "timeVerified": 1388560227,
     "verificationMethod": "Google Authenticator",
     "verified": false
     },
     "paymentInstrumentVerification": {
     "lastFourDigits": "4242",
     "token": "tkn-77620C360132856A103477D2959967AB"
     },
     "phoneVerification": {
     "phone": "15557654321",
     "smsVerified": {
     "sent": true,
     "timeSent": 1389567341,
     "verified": false
     }
     },
     "verificationOutcome": "SUCCESS"
     },
     "additionalInformation": {},
     "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,
     "paymentAuthorizationResults": {
     "authorizationCode": "A33244",
     "authorizationProcessedWith3DS": true,
     "avsFullResult": "Y",
     "avsNameResult": "M",
     "avsStreetResult": "N",
     "avsZipResult": "M",
     "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
     "cvvResult": "M",
     "eciValue": "05",
     "liabilityShift": true,
     "processorResponseCode": "D23",
     "processorResponseText": "Stolen card",
     "threeDsStatus": "Cardholder authenticated",
     "threeDsVersion": "2.1.0"
     },
     "paypalVerificationResults": {
     "authorizationId": "2WC75407LV7300439",
     "fullPaypalResponsePayload": {},
     "payerAccountCountry": "US",
     "payerAddressStatus": "CONFIRMED",
     "payerEmail": "[email protected]",
     "payerId": "FD000A45P",
     "payerStatus": "VERIFIED",
     "paymentGatewayData": {
     "gatewayName": "Braintree",
     "gatewayTransactionId": "fjdsS46sdklFd20"
     },
     "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
     "paymentStatus": "COMPLETED",
     "protectionEligibility": "ELIGIBLE"
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.1");
myHeaders.append("x-forter-siteid", "8b47c6d423ba");
myHeaders.append("authorization", "Basic <base64-encoded-api-key:>");

var raw = JSON.stringify({
   "accountId": "e520-ba9a-367-60b",
   "additionalAuthenticationMethod": {
      "correlationId": "HGJ7512345H3DE",
      "documentVerification": {
         "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",
         "documentVerificationServiceResponsePayload": {},
         "documentVerified": true,
         "eventTime": 1420070400,
         "nationality": "US"
      },
      "emailVerification": {
         "email": "[email protected]",
         "emailVerification": {
            "sent": true,
            "timeSent": 1389567341,
            "verified": false
         }
      },
      "oneTimePasswordVerification": {
         "timeVerified": 1388560227,
         "verificationMethod": "Google Authenticator",
         "verified": false
      },
      "paymentInstrumentVerification": {
         "lastFourDigits": "4242",
         "token": "tkn-77620C360132856A103477D2959967AB"
      },
      "phoneVerification": {
         "phone": "15557654321",
         "smsVerified": {
            "sent": true,
            "timeSent": 1389567341,
            "verified": false
         }
      },
      "verificationOutcome": "SUCCESS"
   },
   "additionalInformation": {},
   "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,
   "paymentAuthorizationResults": {
      "authorizationCode": "A33244",
      "authorizationProcessedWith3DS": true,
      "avsFullResult": "Y",
      "avsNameResult": "M",
      "avsStreetResult": "N",
      "avsZipResult": "M",
      "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
      "cvvResult": "M",
      "eciValue": "05",
      "liabilityShift": true,
      "processorResponseCode": "D23",
      "processorResponseText": "Stolen card",
      "threeDsStatus": "Cardholder authenticated",
      "threeDsVersion": "2.1.0"
   },
   "paypalVerificationResults": {
      "authorizationId": "2WC75407LV7300439",
      "fullPaypalResponsePayload": {},
      "payerAccountCountry": "US",
      "payerAddressStatus": "CONFIRMED",
      "payerEmail": "[email protected]",
      "payerId": "FD000A45P",
      "payerStatus": "VERIFIED",
      "paymentGatewayData": {
         "gatewayName": "Braintree",
         "gatewayTransactionId": "fjdsS46sdklFd20"
      },
      "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
      "paymentStatus": "COMPLETED",
      "protectionEligibility": "ELIGIBLE"
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.forter-secure.com/v2/accounts/authentication-result/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.forter-secure.com/v2/accounts/authentication-result/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["api-version"] = "10.1"
request["x-forter-siteid"] = "8b47c6d423ba"
request["authorization"] = "Basic <base64-encoded-api-key:>"
request.body = JSON.dump({
   "accountId": "e520-ba9a-367-60b",
   "additionalAuthenticationMethod": {
      "correlationId": "HGJ7512345H3DE",
      "documentVerification": {
         "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",
         "documentVerificationServiceResponsePayload": {},
         "documentVerified": true,
         "eventTime": 1420070400,
         "nationality": "US"
      },
      "emailVerification": {
         "email": "[email protected]",
         "emailVerification": {
            "sent": true,
            "timeSent": 1389567341,
            "verified": false
         }
      },
      "oneTimePasswordVerification": {
         "timeVerified": 1388560227,
         "verificationMethod": "Google Authenticator",
         "verified": false
      },
      "paymentInstrumentVerification": {
         "lastFourDigits": "4242",
         "token": "tkn-77620C360132856A103477D2959967AB"
      },
      "phoneVerification": {
         "phone": "15557654321",
         "smsVerified": {
            "sent": true,
            "timeSent": 1389567341,
            "verified": false
         }
      },
      "verificationOutcome": "SUCCESS"
   },
   "additionalInformation": {},
   "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,
   "paymentAuthorizationResults": {
      "authorizationCode": "A33244",
      "authorizationProcessedWith3DS": true,
      "avsFullResult": "Y",
      "avsNameResult": "M",
      "avsStreetResult": "N",
      "avsZipResult": "M",
      "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
      "cvvResult": "M",
      "eciValue": "05",
      "liabilityShift": true,
      "processorResponseCode": "D23",
      "processorResponseText": "Stolen card",
      "threeDsStatus": "Cardholder authenticated",
      "threeDsVersion": "2.1.0"
   },
   "paypalVerificationResults": {
      "authorizationId": "2WC75407LV7300439",
      "fullPaypalResponsePayload": {},
      "payerAccountCountry": "US",
      "payerAddressStatus": "CONFIRMED",
      "payerEmail": "[email protected]",
      "payerId": "FD000A45P",
      "payerStatus": "VERIFIED",
      "paymentGatewayData": {
         "gatewayName": "Braintree",
         "gatewayTransactionId": "fjdsS46sdklFd20"
      },
      "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
      "paymentStatus": "COMPLETED",
      "protectionEligibility": "ELIGIBLE"
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.forter-secure.com/v2/accounts/authentication-result/{id}"

payload = json.dumps({
   "accountId": "e520-ba9a-367-60b",
   "additionalAuthenticationMethod": {
      "correlationId": "HGJ7512345H3DE",
      "documentVerification": {
         "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",
         "documentVerificationServiceResponsePayload": {},
         "documentVerified": True,
         "eventTime": 1420070400,
         "nationality": "US"
      },
      "emailVerification": {
         "email": "[email protected]",
         "emailVerification": {
            "sent": True,
            "timeSent": 1389567341,
            "verified": False
         }
      },
      "oneTimePasswordVerification": {
         "timeVerified": 1388560227,
         "verificationMethod": "Google Authenticator",
         "verified": False
      },
      "paymentInstrumentVerification": {
         "lastFourDigits": "4242",
         "token": "tkn-77620C360132856A103477D2959967AB"
      },
      "phoneVerification": {
         "phone": "15557654321",
         "smsVerified": {
            "sent": True,
            "timeSent": 1389567341,
            "verified": False
         }
      },
      "verificationOutcome": "SUCCESS"
   },
   "additionalInformation": {},
   "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,
   "paymentAuthorizationResults": {
      "authorizationCode": "A33244",
      "authorizationProcessedWith3DS": True,
      "avsFullResult": "Y",
      "avsNameResult": "M",
      "avsStreetResult": "N",
      "avsZipResult": "M",
      "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
      "cvvResult": "M",
      "eciValue": "05",
      "liabilityShift": True,
      "processorResponseCode": "D23",
      "processorResponseText": "Stolen card",
      "threeDsStatus": "Cardholder authenticated",
      "threeDsVersion": "2.1.0"
   },
   "paypalVerificationResults": {
      "authorizationId": "2WC75407LV7300439",
      "fullPaypalResponsePayload": {},
      "payerAccountCountry": "US",
      "payerAddressStatus": "CONFIRMED",
      "payerEmail": "[email protected]",
      "payerId": "FD000A45P",
      "payerStatus": "VERIFIED",
      "paymentGatewayData": {
         "gatewayName": "Braintree",
         "gatewayTransactionId": "fjdsS46sdklFd20"
      },
      "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
      "paymentStatus": "COMPLETED",
      "protectionEligibility": "ELIGIBLE"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.1',
   'x-forter-siteid': '8b47c6d423ba',
   'authorization': 'Basic <base64-encoded-api-key:>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Example adaptiveAuthAccountsResponse
{
  "accountId": "",
  "correlationId": "",
  "decisionReason": "",
  "forterDecision": "",
  "merchantPolicyId": "",
  "recommendation": "",
  "verificationMethod": {
    "correlationId": "",
    "status": "",
    "statusCode": "",
    "statusMessage": "",
    "type": "",
    "verificationId": "",
    "verificationSpecificData": {
      "ThreeDS": {},
      "email": {},
      "phone": {}
    }
  }
}

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)

提供された相関IDを使用して、ログインまたはプロフィールアクセス要求の試行後の認証結果を通知します。この要求に対する決定は提供されていませんが、ログインおよびアクセスのための決定モデルを改善します。