プロフィールアクセス

POST

https://api.forter-secure.com/v2/accounts/profile-access/{id}

Send information on an attempt to access or edit a customer profile to receive a fraud decision. Used for account takeover at profile touchpoint, card testing, and digital key use cases. The response may also include recommendations for additional authentication (MFA) and a correlation ID to include with the authentication result.

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

bodyaccountAccessRequestRequestrequired
Description
Send information on an attempt to access or edit a customer profile to receive a fraud decision. Used for account takeover at profile touchpoint, card testing, and digital key use cases. The response may also include recommendations for additional authentication (MFA) and a correlation ID to include with the authentication result.
- accessRequestTypestring<VIEW_PERSONAL_PREFERENCES | UPDATE_PASSWORD | UPDATE_PAYMENT | UPDATE_PHONE | UPDATE_EMAIL | UPDATE_ADDRESS | REDEEM_ACCOUNT_ASSETS | SHARE_CREDENTIALS | DIGITAL_KEY_ACCESS | DIGITAL_CHECK_IN>
  Description
  The type of restricted access the user is asking for
  Default
  UPDATE_PASSWORD
- accountIdstringrequired
  Description
  Customer's account UID in merchant's site. If the compensation request is from a guest account then this field should be populated with the original order id ending with the suffix '_GUEST'
  Default
  e520-ba9a-367-60b
- accountOwnerobject
  - AccountOwner
    - accountIdstring
      Description
      Customer's account UID in merchant's site (leave empty if guest)
      Default
      e520-ba9a-367-60b
    - birthdatestring<date>
      Description
      Date of birth. Use YYYY-MM-DD format.
      Default
      1987-05-22
    - creatednumber
      Description
      Account creation date in seconds since unix epoch (UTC, Jan 1, 1970)
      Default
      1415273168
    - emailstringrequired
      Description
      Account holder's primary Email address
      Default
      [email protected]
    - firstNamestringrequired
      Description
      Account holder's first name
      Default
      John
    - fullNamestring
      Description
      Account holder's fullName
      Default
      Smith
    - genderstring<MALE | FEMALE | CHOSE_NOT_TO_SPECIFY | NONE>
      Description
      Gender
      Default
      MALE
    - lastNamestringrequired
      Description
      Account holder's last name
      Default
      Smith
    - loyaltyProgramsInAccountLoyaltyProgram[]
      Description
      Details of all rewards/loyalty/frequent flyer programs customer saved in the account
      - accountNumberstring
        Description
        Customer's rewards/loyalty/frequent flyer account number
        Default
        VC1568OP
      - loyaltyPointsValueobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
      - programNamestring
        Description
        Name of program
        Default
        StarAlliance
      - programPointsnumber
        Description
        Customer's rewards/loyalty/frequent flyer miles/point/stars
        Default
        0
      - tierstring
        Description
        Program tier name
        Default
        Blue
    - socialNetworkDataSocialNetwork[]
      Description
      Social network data
      - networkNamestring<FACEBOOK | GOOGLE | TWITTER | REDDIT | PINTEREST | WECHAT | QQ | TWITCH | APPLE | DRIBBBLE | GITHUB | LINKEDIN | MAKER_STUDIOS | STACK_EXCHANGE | VIMEO | STEAM | OTHER | KAKAO | NAVER | GRAB | JKOPAY | LINE>required
        Description
        Social network name
        Default
        FACEBOOK
      - profileIdstringrequired
        Description
        Unique social profile identifier
        Default
        10000054564897
- additionalAccountEventIdentifiersobject
  - AdditionalAccountEventIdentifiers
- additionalInformationobject
  - GeneralPayloadMap
- channelTypestring<WEB | PHONE | DYNAMIC_PHONE | MOBILE | MOBILE_IN_STORE | IOS | ANDROID | WAP | STORE | MERCHANT_EMPLOYEE | MAIL_ORDER | AUTOMATIC_RENEWAL_OR_INSTALLMENT_PAYMENT | MERCHANT_INITIATED | UNKNOWN | POS | API_ONLY | PERSONAL_POS | PHONE_LINK>
  Description
  The source channel through which the customer requested profile access. Note that some of the enum values are not relevant for this interaction.
  Default
  WEB
- connectionInformationConnectionInformationrequired
  Description
  Connection information about the customer typically found in the HTTP request header.
  - 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
- newAddressobject
  - Address
    - address1string
      Description
      Street-level address. Required when full address details are available
      Default
      235 Montgomery st.
    - address2string
      Description
      Unit-level address
      Default
      Ste. 1110
    - citystring
      Description
      City. Required when full address details are available
      Default
      San Francisco
    - companystring
      Description
      Company
      Default
      Generic Corp. ltd.
    - countrystringrequired
      Description
      Country, two-letter ISO 3166-1 alpha-2 country code
      Default
      US
    - regionstring
      Description
      Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
      Default
      CA
    - savedDataobject
      - SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        Default
        false
        usedSavedDatabooleanrequired
        Description
        True if customer chose to use data saved in the account
        Default
        true
    - zipstring
      Description
      Zipcode
      Default
      94104
- newEmailobject
  - 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
- newPaymentMethodsobject
  - Payment
    - allowedMerchantInitiatedTransactionsboolean
      Description
      True if customer chose to allow future transactions to initiate without taking further action (payment that's initiated on behalf of a customer)
      Default
      false
    - amountAmountrequired
      Description
      Amount paid with this payment instrument
      - amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
      - amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
      - currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
    - androidPayobject
      - TokenizedCreditCard
        cardBankstring
        Description
        Credit card's issuing bank
        Default
        Chase
        cardBrandstring
        Description
        Credit card's issuer brand
        Default
        VISA
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Description
        Payment card type
        Default
        CREDIT
        countryOfIssuancestring
        Description
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        creationTimenumber
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1430997968
        creditCardCorrelationIdstring
        Description
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Description
        Credit card's expiration month, in MM format
        Default
        03
        expirationYearstringrequired
        Description
        Credit card's expiration year, in YYYY format
        Default
        2018
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Description
        Credit card's last 4 digits
        Default
        4242
        nameOnCardstring
        Description
        Cardholder's full name
        Default
        John R. H. Smith
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Description
        Payment processor name
        Default
        Chase Paymentech
        processorTransactionIdstring
        Description
        Unique transaction identifier (sent by processor)
        Default
        fjdsS46sdklFd20
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Description
        Bank acquirer BIN (Bank Identification Number)
        Default
        457173
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Description
        Acquirer country
        Default
        US
        acquirerMerchantIdstring
        Description
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Default
        5245020244654
        acquirerMerchantNamestring
        Description
        Merchant Name as appearing in processor records
        Default
        Simple T-shirt
        acquirerNamestring
        Description
        Bank acquirer Name
        Default
        Barclays
        merchantCategoryCodenumber
        Description
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Default
        5655
        merchantCountryCodenumber
        Description
        Merchant country code
        Default
        840
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Default
        NO_PREFERENCE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Description
        Request your preference regarding the execution of 3DS
        Default
        DYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Description
        The channel through which the exemption is requested
        Default
        THREEDS_RAILS
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Description
        The type of exemption requested
        Default
        LOW_VALUE
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        Default
        false
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        tokenstringrequired
        Description
        Credit card token used by the merchant
        Default
        tkn-77620C360132856A103477D2959967AB
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        verificationResultsobject
        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
    - applePayobject
      - TokenizedCreditCard
        cardBankstring
        Description
        Credit card's issuing bank
        Default
        Chase
        cardBrandstring
        Description
        Credit card's issuer brand
        Default
        VISA
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Description
        Payment card type
        Default
        CREDIT
        countryOfIssuancestring
        Description
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        creationTimenumber
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1430997968
        creditCardCorrelationIdstring
        Description
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Description
        Credit card's expiration month, in MM format
        Default
        03
        expirationYearstringrequired
        Description
        Credit card's expiration year, in YYYY format
        Default
        2018
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Description
        Credit card's last 4 digits
        Default
        4242
        nameOnCardstring
        Description
        Cardholder's full name
        Default
        John R. H. Smith
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Description
        Payment processor name
        Default
        Chase Paymentech
        processorTransactionIdstring
        Description
        Unique transaction identifier (sent by processor)
        Default
        fjdsS46sdklFd20
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Description
        Bank acquirer BIN (Bank Identification Number)
        Default
        457173
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Description
        Acquirer country
        Default
        US
        acquirerMerchantIdstring
        Description
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Default
        5245020244654
        acquirerMerchantNamestring
        Description
        Merchant Name as appearing in processor records
        Default
        Simple T-shirt
        acquirerNamestring
        Description
        Bank acquirer Name
        Default
        Barclays
        merchantCategoryCodenumber
        Description
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Default
        5655
        merchantCountryCodenumber
        Description
        Merchant country code
        Default
        840
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Default
        NO_PREFERENCE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Description
        Request your preference regarding the execution of 3DS
        Default
        DYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Description
        The channel through which the exemption is requested
        Default
        THREEDS_RAILS
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Description
        The type of exemption requested
        Default
        LOW_VALUE
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        Default
        false
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        tokenstringrequired
        Description
        Credit card token used by the merchant
        Default
        tkn-77620C360132856A103477D2959967AB
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        verificationResultsobject
        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
    - bankTransferobject
      - 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
    - billingDetailsPersonrequired
      Description
      Billing details associated with this payment method
      - addressobject
        Address
        address1string
        Description
        Street-level address. Required when full address details are available
        Default
        235 Montgomery st.
        address2string
        Description
        Unit-level address
        Default
        Ste. 1110
        citystring
        Description
        City. Required when full address details are available
        Default
        San Francisco
        companystring
        Description
        Company
        Default
        Generic Corp. ltd.
        countrystringrequired
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        regionstring
        Description
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Default
        CA
        savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        Default
        false
        usedSavedDatabooleanrequired
        Description
        True if customer chose to use data saved in the account
        Default
        true
        zipstring
        Description
        Zipcode
        Default
        94104
      - allAdditionalVerificationDocumentsAdditionalVerificationDocuments[]
        Description
        Additional identification documents details and verification
        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
      - employmentInformationEmploymentInformation[]
        Description
        Credit applicant's employment information
        employerAddressobject
        Address
        address1string
        Description
        Street-level address. Required when full address details are available
        Default
        235 Montgomery st.
        address2string
        Description
        Unit-level address
        Default
        Ste. 1110
        citystring
        Description
        City. Required when full address details are available
        Default
        San Francisco
        companystring
        Description
        Company
        Default
        Generic Corp. ltd.
        countrystringrequired
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        regionstring
        Description
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Default
        CA
        savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        Default
        false
        usedSavedDatabooleanrequired
        Description
        True if customer chose to use data saved in the account
        Default
        true
        zipstring
        Description
        Zipcode
        Default
        94104
        employerCompanySizeRangestring
        Description
        Employing company's number of employees
        Default
        20
        employerIndustrystring
        Description
        Employing company's industry
        Default
        Retail
        employerNamestringrequired
        Description
        Employing company's name
        Default
        Forter
        employerPhonestring
        Description
        Employing company's phone
        Default
        +12126667777
        incomeobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        jobTitlestring
        Description
        Job title
        Default
        Fraud Analyst
      - personalDetailsPersonalDetailsrequired
        Description
        Personal information such as name and birthdate
        birthdatestring<date>
        Description
        Date of birth. Use YYYY-MM-DD format.
        Default
        1987-05-22
        emailstring
        Description
        Email address
        Default
        [email protected]
        firstNamestring
        Description
        First name
        Default
        John
        fullNamestring
        Description
        Full name. Not Needed if firstName and LastName are provided independently.
        Default
        John Smith
        genderstring<MALE | FEMALE | CHOSE_NOT_TO_SPECIFY | NONE>
        Description
        Gender
        Default
        MALE
        lastNamestring
        Description
        Last name
        Default
        Smith
      - phonePhone[]
        Description
        Phone details
        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
    - cameraCapturedboolean
      Description
      True if payment instrument details were captured by OCR from a picture. False if payment instrument details were manually typed in
      Default
      true
    - cashboolean
      Description
      Payed with cash
      Default
      false
    - creditCardobject
      - CreditCard
        binstringrequired
        Description
        Credit card's BIN (Bank Identification Number)
        Default
        42424242
        cardBankstring
        Description
        Credit card's issuing bank
        Default
        Chase
        cardBrandstring
        Description
        Credit Card's issuer brand
        Default
        VISA
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Description
        Payment card type
        Default
        CREDIT
        countryOfIssuancestring
        Description
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        creditCardCorrelationIdstring
        Description
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Description
        Credit card's expiration month, in MM format
        Default
        03
        expirationYearstringrequired
        Description
        Credit card's expiration year, in YYYY format
        Default
        2018
        fingerprintstring
        Description
        Unique identifier for card (sent by gateway or processor)
        Default
        Xt5EWLLDS7FJjR1c
        fullCreditCardstring
        Description
        Credit Card's full PAN - needed for the 3DS secure implementation
        Default
        2424242424242424
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstringrequired
        Description
        Credit card's last 4 digits (For Amex, take 4 digits from last digit)
        Default
        4242
        nameOnCardstringrequired
        Description
        Cardholder's full name
        Default
        John R. H. Smith
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Description
        Payment processor name
        Default
        Chase Paymentech
        processorTransactionIdstring
        Description
        Unique transaction identifier (sent by processor)
        Default
        fjdsS46sdklFd20
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Description
        Bank acquirer BIN (Bank Identification Number)
        Default
        457173
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Description
        Acquirer country
        Default
        US
        acquirerMerchantIdstring
        Description
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Default
        5245020244654
        acquirerMerchantNamestring
        Description
        Merchant Name as appearing in processor records
        Default
        Simple T-shirt
        acquirerNamestring
        Description
        Bank acquirer Name
        Default
        Barclays
        merchantCategoryCodenumber
        Description
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Default
        5655
        merchantCountryCodenumber
        Description
        Merchant country code
        Default
        840
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Default
        NO_PREFERENCE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Description
        Request your preference regarding the execution of 3DS
        Default
        DYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Description
        The channel through which the exemption is requested
        Default
        THREEDS_RAILS
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Description
        The type of exemption requested
        Default
        LOW_VALUE
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        Default
        false
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        verificationResultsobject
        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
    - creditLineDetailsobject
      - CreditLineDetails
        askedToIncreaseCreditLineLimitbooleanrequired
        Description
        True if customer asked to increase credit line limit
        Default
        false
        creditLineLimitIncreaseMethodstring<PRE_APPROVAL | AT_PURCHASE>required
        Description
        Method customer chose to ask to increase credit line limit - PRE_APPROVAL, AT_PURCHASE
        Default
        AT_PURCHASE
        currentCreditLineLimitAmountrequired
        Description
        Current limit that was set for the credit line
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        originalCreditLineLimitAmountrequired
        Description
        Original limit that was set for the credit line
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
    - cryptoWalletobject
      - CryptoWallet
        cryptoWalletNamestring
        Description
        Crypto wallet name
        Default
        CryptoWallet
        cryptoWalletPaymentIdstring
        Description
        Crypto wallet payment ID
        Default
        3JQiwG88SQvwihDAHg9M2EnqEisharz49c
        cryptoWalletTypestring<INTERNAL | EXTERNAL>required
        Description
        Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem)
        Default
        EXTERNAL
    - digitalWalletobject
      - DigitalWallet
        digitalWalletNamestring<AMAZONPAY | FACEBOOKPAY | ALIPAY | WECHAT | AMEDIGITAL | MERCADOPAGO | DUE | ZELLE | PAYONEER | ALLIEDWALLET | KONBINI | UNIONPAY | IYZICO | VENMO | BARTER | PAYNOW | PAYCO | KAKAOPAY | NAVERPAY | LINEPAY | BANCONTACT | MBWAY | AIIA | BLIK | EPS | OVO | DANA | GCASH | GOPAY | RAKUTENPAY | APLAZO | GRABPAY | TWINT | TRUEMONEY | SWISH | KLARNA | SHOPBACK | OTHER | PAYPAY>required
        Description
        Digital wallet name
        Default
        ALIPAY
        digitalWalletPayerEmailstring
        Description
        Email address associated with the digital wallet account
        Default
        [email protected]
        digitalWalletPayerIdstring
        Description
        Unique identifier for each digital wallet account. This ID should persist across all orders made by the same user, regardless of underlying payment methods.
        Default
        FD000A45P
        digitalWalletpaymentIdstring
        Description
        Digital wallet payment ID
        Default
        PAY-0MB00000KR8073311KZSDEYA
        freeTextDigitalWalletNamestring
        Description
        Specifics about the source of the wallet such as the name / 3rd party name, etc. (required for OTHER digitalWalletName)
        Default
        ALIBABA
        fullDigitalWalletResponsePayloadobject
        GeneralPayloadMap
        payerAccountCountrystring
        Description
        Digital wallet account country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        paymentSuccessStatusstring
        Description
        Digital wallet payment status
        Default
        COMPLETED
        underlyingPaymentMethodUnderlyingPaymentMethodrequired
        Description
        The underlying payment method associated to the digital wallet that was used in the current transaction
        bankTransferobject
        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
        bitcoinboolean
        Description
        Bitcoin payment details
        Default
        false
        cashboolean
        Description
        Payed with cash
        Default
        false
        creditCardobject
        TokenizedCreditCard
        cardBankstring
        Description
        Credit card's issuing bank
        Default
        Chase
        cardBrandstring
        Description
        Credit card's issuer brand
        Default
        VISA
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Description
        Payment card type
        Default
        CREDIT
        countryOfIssuancestring
        Description
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        creationTimenumber
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1430997968
        creditCardCorrelationIdstring
        Description
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Description
        Credit card's expiration month, in MM format
        Default
        03
        expirationYearstringrequired
        Description
        Credit card's expiration year, in YYYY format
        Default
        2018
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Description
        Credit card's last 4 digits
        Default
        4242
        nameOnCardstring
        Description
        Cardholder's full name
        Default
        John R. H. Smith
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Description
        Payment processor name
        Default
        Chase Paymentech
        processorTransactionIdstring
        Description
        Unique transaction identifier (sent by processor)
        Default
        fjdsS46sdklFd20
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        Max depth limit reached
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Default
        NO_PREFERENCE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Description
        Request your preference regarding the execution of 3DS
        Default
        DYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        Max depth limit reached
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        Default
        false
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        tokenstringrequired
        Description
        Credit card token used by the merchant
        Default
        tkn-77620C360132856A103477D2959967AB
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        verificationResultsobject
        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
        underlyingPaymentMethodTypestring<UNKNOWN | CREDITCARD | BANKTRANSFER | CASH | BITCOIN>required
        Description
        Underlying payment method type used in current transaction
        Default
        UNKNOWN
    - giftCardobject
      - CreditUsed
        activationTimenumber
        Description
        Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1448549922
        creditCurrencystring
        Description
        Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        creditOriginstring
        Description
        Source which created gift card for customer.
        Default
        CS Compensation
        merchantPaymentIdstring
        Description
        unique payment identifier for the merchant reference.
        Default
        eab12-ba9a-367-60b
        valueobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
    - installmentServiceobject
      - InstallmentService
        firstNamestring
        Description
        Account holder's first name
        Default
        John
        fullResponsePayloadobject
        GeneralPayloadMap
        lastNamestring
        Description
        Account holder's last name
        Default
        Smith
        paymentIdstring
        Description
        Installment payment ID
        Default
        YTZ8IATEGAWRRVVG
        serviceNamestring
        Description
        Installment service's name
        Default
        Affirm
        serviceResponseCodestring
        Description
        Response code received from installment service
        Default
        200
    - loyaltyPointsobject
      - LoyaltyPoints
        loyaltyPointsCountnumberrequired
        Description
        Number of points (miles, stars, etc.)
        Default
        1506
        loyaltyPointsSourcestring<REFERRAL | IN_ACCOUNT_PURCHASES | PROMOTION | COMPENSATION | CARD_SCHEME_POINTS>
        Description
        Source of points (promo, referral, etc.)
        Default
        IN_ACCOUNT_PURCHASES
        loyaltyPointsValueobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        merchantPaymentIdstring
        Description
        unique payment identifier for the merchant reference.
        Default
        eab12-ba9a-367-60b
    - merchantInitiatedobject
      - MerchantInitiatedPayment
        initialOrderIdstring
        Description
        Unique order/transaction identifier of the initial order (CIT).
        Default
        2356fdse0rr489
        typestring<RECURRING_TRANSACTION | INSTALMENT_TRANSACTION | ADD_CARD | MAINTAIN_CARD_INFORMATION | ACCOUNT_VERIFICATION | SPLIT_OR_DELAYED_SHIPMENT | TOP_UP | MAIL_ORDER | TELEPHONE_ORDER | WHITELIST_STATUS_CHECK | OTHER_PAYMENT>
        Description
        Specifies the type of merchant-initiated payment
    - mobileMoneyobject
      - MobileMoney
        fullResponsePayloadobject
        GeneralPayloadMap
        mobileMoneyNetworkstring<MPESA | MTN | MPAWA | MSHWAEI | SAFARICOM | DASH>required
        Description
        Mobile money provider name
        Default
        MPESA
        paymentAcquirerDataobject
        AcquirerData
        acquirerBINstring
        Description
        Bank acquirer BIN (Bank Identification Number)
        Default
        457173
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Description
        Acquirer country
        Default
        US
        acquirerMerchantIdstring
        Description
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Default
        5245020244654
        acquirerMerchantNamestring
        Description
        Merchant Name as appearing in processor records
        Default
        Simple T-shirt
        acquirerNamestring
        Description
        Bank acquirer Name
        Default
        Barclays
        merchantCategoryCodenumber
        Description
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Default
        5655
        merchantCountryCodenumber
        Description
        Merchant country code
        Default
        840
        paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Description
        Payment gateway name
        Default
        Braintree
        gatewayTransactionIdstring
        Description
        Unique transaction identifier (sent by gateway)
        Default
        fjdsS46sdklFd20
        paymentSuccessStatusstring
        Description
        Mobile money payment status
        Default
        success
        phoneNumberstringrequired
        Description
        Account phone number
        Default
        15557654321
    - numberOfInstallmentsinteger
      Description
      Number of payments if customer chose to pay in several installments
      Default
      12
    - paymentMethodNicknamestring
      Description
      Nickname assigned to this payment method by the user
      Default
      My Work Card
    - paypalobject
      - 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
    - recurringPaymentobject
      - RecurringPaymentDetails
        currentPaymentNumberinteger
        Description
        The number of payments processed in this recurring event including current transaction (1 for the original transaction)
        Default
        1
        initialPaymentOrderIdstringrequired
        Description
        Original order/transaction identifier that started the recurring event (payment number 1)
        Default
        2356fdse0rr483
        isPaymentAmountIdenticalForAllPaymentsboolean
        Description
        True if the amount is constant between payments
        Default
        false
        recurringPaymentExpirationDatestring<date>
        Description
        Date of last expected payment event. Use YYYY-MM-DD format.
        Default
        1988-06-22
        recurringPaymentFrequencystringrequired
        Description
        The number of days between transactions.
        Default
        7
        totalNumberOfPaymentsinteger
        Description
        Expected number of payments processed in this recurring event
        Default
        12
    - samsungPayobject
      - TokenizedCreditCard
        cardBankstring
        Description
        Credit card's issuing bank
        Default
        Chase
        cardBrandstring
        Description
        Credit card's issuer brand
        Default
        VISA
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Description
        Payment card type
        Default
        CREDIT
        countryOfIssuancestring
        Description
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        creationTimenumber
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1430997968
        creditCardCorrelationIdstring
        Description
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Description
        Credit card's expiration month, in MM format
        Default
        03
        expirationYearstringrequired
        Description
        Credit card's expiration year, in YYYY format
        Default
        2018
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Description
        Credit card's last 4 digits
        Default
        4242
        nameOnCardstring
        Description
        Cardholder's full name
        Default
        John R. H. Smith
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Description
        Payment processor name
        Default
        Chase Paymentech
        processorTransactionIdstring
        Description
        Unique transaction identifier (sent by processor)
        Default
        fjdsS46sdklFd20
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Description
        Bank acquirer BIN (Bank Identification Number)
        Default
        457173
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Description
        Acquirer country
        Default
        US
        acquirerMerchantIdstring
        Description
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Default
        5245020244654
        acquirerMerchantNamestring
        Description
        Merchant Name as appearing in processor records
        Default
        Simple T-shirt
        acquirerNamestring
        Description
        Bank acquirer Name
        Default
        Barclays
        merchantCategoryCodenumber
        Description
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Default
        5655
        merchantCountryCodenumber
        Description
        Merchant country code
        Default
        840
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Default
        NO_PREFERENCE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Description
        Request your preference regarding the execution of 3DS
        Default
        DYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Description
        The channel through which the exemption is requested
        Default
        THREEDS_RAILS
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Description
        The type of exemption requested
        Default
        LOW_VALUE
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        Default
        false
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        tokenstringrequired
        Description
        Credit card token used by the merchant
        Default
        tkn-77620C360132856A103477D2959967AB
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        verificationResultsobject
        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
    - savedDataobject
      - SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        Default
        false
        usedSavedDatabooleanrequired
        Description
        True if customer chose to use data saved in the account
        Default
        true
    - storeCreditUsedobject
      - CreditUsed
        activationTimenumber
        Description
        Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1448549922
        creditCurrencystring
        Description
        Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
        creditOriginstring
        Description
        Source which created gift card for customer.
        Default
        CS Compensation
        merchantPaymentIdstring
        Description
        unique payment identifier for the merchant reference.
        Default
        eab12-ba9a-367-60b
        valueobject
        Amount
        amountLocalCurrencystring
        Description
        Transaction amount in currency chosen by the buyer
        Default
        105.55
        amountUSDstring
        Description
        Transaction amount in USD
        Default
        99.95
        currencystring
        Description
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Default
        CAD
    - tokenizedCardobject
      - TokenizedCreditCard
        cardBankstring
        Description
        Credit card's issuing bank
        Default
        Chase
        cardBrandstring
        Description
        Credit card's issuer brand
        Default
        VISA
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Description
        Payment card type
        Default
        CREDIT
        countryOfIssuancestring
        Description
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Default
        US
        creationTimenumber
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        Default
        1430997968
        creditCardCorrelationIdstring
        Description
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Description
        Credit card's expiration month, in MM format
        Default
        03
        expirationYearstringrequired
        Description
        Credit card's expiration year, in YYYY format
        Default
        2018
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Description
        Credit card's last 4 digits
        Default
        4242
        nameOnCardstring
        Description
        Cardholder's full name
        Default
        John R. H. Smith
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Description
        Payment processor name
        Default
        Chase Paymentech
        processorTransactionIdstring
        Description
        Unique transaction identifier (sent by processor)
        Default
        fjdsS46sdklFd20
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Description
        Bank acquirer BIN (Bank Identification Number)
        Default
        457173
        acquirerCountrystring<AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CK | CR | HR | CU | CY | CZ | DK | DJ | DM | DO | TP | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | NF | KP | GB | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | SH | KN | LC | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SK | SI | SB | SO | ZA | GS | KR | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TJ | TZ | TH | CD | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | YU | ZM | ZW>
        Description
        Acquirer country
        Default
        US
        acquirerMerchantIdstring
        Description
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Default
        5245020244654
        acquirerMerchantNamestring
        Description
        Merchant Name as appearing in processor records
        Default
        Simple T-shirt
        acquirerNamestring
        Description
        Bank acquirer Name
        Default
        Barclays
        merchantCategoryCodenumber
        Description
        A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
        Default
        5655
        merchantCountryCodenumber
        Description
        Merchant country code
        Default
        840
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Default
        NO_PREFERENCE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Description
        Request your preference regarding the execution of 3DS
        Default
        DYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Description
        The channel through which the exemption is requested
        Default
        THREEDS_RAILS
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Description
        The type of exemption requested
        Default
        LOW_VALUE
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        Default
        false
        threeDSServerTransIDstringrequired
        Description
        Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
        Default
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        threeDsExecutorstring<FORTER | MERCHANT>
        Description
        Request your preference regarding the 3DS executor. To be used only for an edge case, where a merchant with 3DS execution demands Forter to not execute 3DS on a limited subset of TXs
        tokenstringrequired
        Description
        Credit card token used by the merchant
        Default
        tkn-77620C360132856A103477D2959967AB
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        verificationResultsobject
        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
    - venmoobject
      - Venmo
        fullVenmoResponsePayloadGeneralPayloadMaprequired
        Description
        Full Venmo response object
        paymentIdstring
        Description
        Venmo payment ID
        Default
        1KZSDEYA
        tokenstringrequired
        Description
        Token representing the specific payment method used within the Venmo vault
        Default
        77620C360132856A103477D2959967AB
        userIdstringrequired
        Description
        Venmo userID
        Default
        johndoe
        userNamestringrequired
        Description
        Venmo user name
        Default
        johndoe1987
- newPhoneobject
  - 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
- originalOrderIdstring
  Description
  Unique order/transaction identifier for which this access request is referring to, if relevant. Note that Forter treats this ID as case-insensitive; Order123 and ORDER123 will be identified as the same order.
  Default
  2356fdse0rr489
- passwordUpdateTriggerstring<MERCHANT_POLICY | USER_FORGOT_PASSWORD | LOGGED_IN_USER>
  Description
  The trigger that caused the password update. Required only in case the access request is UPDATE_PASSWORD
  Default
  USER_FORGOT_PASSWORD

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/profile-access/{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 '{
     "accessRequestType": "UPDATE_PASSWORD",
     "accountId": "e520-ba9a-367-60b",
     "accountOwner": {
     "accountId": "e520-ba9a-367-60b",
     "birthdate": "1987-05-22",
     "created": 1415273168,
     "email": "[email protected]",
     "firstName": "John",
     "fullName": "Smith",
     "gender": "MALE",
     "lastName": "Smith",
     "loyaltyProgramsInAccount": [
     {
     "accountNumber": "VC1568OP",
     "loyaltyPointsValue": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "programName": "StarAlliance",
     "tier": "Blue"
     }
     ],
     "socialNetworkData": [
     {
     "networkName": "FACEBOOK",
     "profileId": "10000054564897"
     }
     ]
     },
     "additionalAccountEventIdentifiers": {},
     "additionalInformation": {},
     "channelType": "WEB",
     "connectionInformation": {
     "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
     "customerIP": "10.0.0.127",
     "forterMobileUID": "6429751237891",
     "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
     "merchantDeviceIdentifier": "HGJ7512345H3",
     "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
     "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
     },
     "eventTime": 1415287568000,
     "newAddress": {
     "address1": "235 Montgomery st.",
     "address2": "Ste. 1110",
     "city": "San Francisco",
     "company": "Generic Corp. ltd.",
     "country": "US",
     "region": "CA",
     "savedData": {
     "usedSavedData": true
     },
     "zip": "94104"
     },
     "newEmail": {
     "email": "[email protected]",
     "emailVerification": {
     "sent": true,
     "timeSent": 1389567341,
     "verified": false
     }
     },
     "newPaymentMethods": {
     "amount": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "androidPay": {
     "cardBank": "Chase",
     "cardBrand": "VISA",
     "cardType": "CREDIT",
     "countryOfIssuance": "US",
     "creationTime": 1430997968,
     "expirationMonth": "03",
     "expirationYear": "2018",
     "fullResponsePayload": {},
     "lastFourDigits": "4242",
     "nameOnCard": "John R. H. Smith",
     "paymentProcessorData": {
     "processorName": "Chase Paymentech",
     "processorTransactionId": "fjdsS46sdklFd20"
     },
     "threeDSecure": {
     "acquirerData": {
     "acquirerBIN": "457173",
     "acquirerCountry": "US",
     "acquirerMerchantId": "5245020244654",
     "acquirerMerchantName": "Simple T-shirt",
     "acquirerName": "Barclays",
     "merchantCategoryCode": 5655,
     "merchantCountryCode": 840
     },
     "challengeIndicator": "NO_PREFERENCE",
     "execute3ds": "DYNAMIC_FORTER_DECISION",
     "forcePsd2Exemption": {
     "channel": "THREEDS_RAILS",
     "type": "LOW_VALUE"
     },
     "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
     },
     "token": "tkn-77620C360132856A103477D2959967AB",
     "verificationResults": {
     "authorizationCode": "A33244",
     "authorizationProcessedWith3DS": true,
     "avsFullResult": "Y",
     "avsNameResult": "M",
     "avsStreetResult": "N",
     "avsZipResult": "M",
     "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
     "cvvResult": "M",
     "eciValue": "05",
     "liabilityShift": true,
     "processorResponseCode": "D23",
     "processorResponseText": "Stolen card",
     "threeDsStatus": "Cardholder authenticated",
     "threeDsVersion": "2.1.0"
     }
     },
     "applePay": {
     "cardBank": "Chase",
     "cardBrand": "VISA",
     "cardType": "CREDIT",
     "countryOfIssuance": "US",
     "creationTime": 1430997968,
     "expirationMonth": "03",
     "expirationYear": "2018",
     "fullResponsePayload": {},
     "lastFourDigits": "4242",
     "nameOnCard": "John R. H. Smith",
     "paymentProcessorData": {
     "processorName": "Chase Paymentech",
     "processorTransactionId": "fjdsS46sdklFd20"
     },
     "threeDSecure": {
     "acquirerData": {
     "acquirerBIN": "457173",
     "acquirerCountry": "US",
     "acquirerMerchantId": "5245020244654",
     "acquirerMerchantName": "Simple T-shirt",
     "acquirerName": "Barclays",
     "merchantCategoryCode": 5655,
     "merchantCountryCode": 840
     },
     "challengeIndicator": "NO_PREFERENCE",
     "execute3ds": "DYNAMIC_FORTER_DECISION",
     "forcePsd2Exemption": {
     "channel": "THREEDS_RAILS",
     "type": "LOW_VALUE"
     },
     "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
     },
     "token": "tkn-77620C360132856A103477D2959967AB",
     "verificationResults": {
     "authorizationCode": "A33244",
     "authorizationProcessedWith3DS": true,
     "avsFullResult": "Y",
     "avsNameResult": "M",
     "avsStreetResult": "N",
     "avsZipResult": "M",
     "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
     "cvvResult": "M",
     "eciValue": "05",
     "liabilityShift": true,
     "processorResponseCode": "D23",
     "processorResponseText": "Stolen card",
     "threeDsStatus": "Cardholder authenticated",
     "threeDsVersion": "2.1.0"
     }
     },
     "bankTransfer": {
     "accountHolderFirstName": "John",
     "accountHolderLastName": "Smith",
     "achProcessingType": "SAME_DAY_ACH",
     "bankAccountIdentifier": "TEST63TEST1212121212",
     "bankAccountType": "Savings",
     "bankName": "Citigroup",
     "paymentGatewayData": {
     "gatewayName": "Braintree",
     "gatewayTransactionId": "fjdsS46sdklFd20"
     },
     "paymentSuccessStatus": "Payment Successful",
     "serviceName": "Direct Debit"
     },
     "billingDetails": {
     "address": {
     "address1": "235 Montgomery st.",
     "address2": "Ste. 1110",
     "city": "San Francisco",
     "company": "Generic Corp. ltd.",
     "country": "US",
     "region": "CA",
     "savedData": {
     "usedSavedData": true
     },
     "zip": "94104"
     },
     "allAdditionalVerificationDocuments": [
     {
     "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"
     }
     ],
     "employmentInformation": [
     {
     "employerAddress": {
     "address1": "235 Montgomery st.",
     "address2": "Ste. 1110",
     "city": "San Francisco",
     "company": "Generic Corp. ltd.",
     "country": "US",
     "region": "CA",
     "savedData": {
     "usedSavedData": true
     },
     "zip": "94104"
     },
     "employerCompanySizeRange": "20",
     "employerIndustry": "Retail",
     "employerName": "Forter",
     "employerPhone": "+12126667777",
     "income": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "jobTitle": "Fraud Analyst"
     }
     ],
     "personalDetails": {
     "birthdate": "1987-05-22",
     "email": "[email protected]",
     "firstName": "John",
     "fullName": "John Smith",
     "gender": "MALE",
     "lastName": "Smith"
     },
     "phone": [
     {
     "phone": "15557654321",
     "smsVerified": {
     "sent": true,
     "timeSent": 1389567341,
     "verified": false
     }
     }
     ]
     },
     "cameraCaptured": true,
     "creditCard": {
     "bin": "42424242",
     "cardBank": "Chase",
     "cardBrand": "VISA",
     "cardType": "CREDIT",
     "countryOfIssuance": "US",
     "expirationMonth": "03",
     "expirationYear": "2018",
     "fingerprint": "Xt5EWLLDS7FJjR1c",
     "fullCreditCard": "2424242424242424",
     "fullResponsePayload": {},
     "lastFourDigits": "4242",
     "nameOnCard": "John R. H. Smith",
     "paymentProcessorData": {
     "processorName": "Chase Paymentech",
     "processorTransactionId": "fjdsS46sdklFd20"
     },
     "threeDSecure": {
     "acquirerData": {
     "acquirerBIN": "457173",
     "acquirerCountry": "US",
     "acquirerMerchantId": "5245020244654",
     "acquirerMerchantName": "Simple T-shirt",
     "acquirerName": "Barclays",
     "merchantCategoryCode": 5655,
     "merchantCountryCode": 840
     },
     "challengeIndicator": "NO_PREFERENCE",
     "execute3ds": "DYNAMIC_FORTER_DECISION",
     "forcePsd2Exemption": {
     "channel": "THREEDS_RAILS",
     "type": "LOW_VALUE"
     },
     "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
     },
     "verificationResults": {
     "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"
     }
     },
     "creditLineDetails": {
     "askedToIncreaseCreditLineLimit": false,
     "creditLineLimitIncreaseMethod": "AT_PURCHASE",
     "currentCreditLineLimit": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "originalCreditLineLimit": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     },
     "cryptoWallet": {
     "cryptoWalletName": "CryptoWallet",
     "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
     "cryptoWalletType": "EXTERNAL"
     },
     "digitalWallet": {
     "digitalWalletName": "ALIPAY",
     "digitalWalletPayerEmail": "[email protected]",
     "digitalWalletPayerId": "FD000A45P",
     "digitalWalletpaymentId": "PAY-0MB00000KR8073311KZSDEYA",
     "freeTextDigitalWalletName": "ALIBABA",
     "fullDigitalWalletResponsePayload": {},
     "payerAccountCountry": "US",
     "paymentSuccessStatus": "COMPLETED",
     "underlyingPaymentMethod": {
     "bankTransfer": {
     "accountHolderFirstName": "John",
     "accountHolderLastName": "Smith",
     "achProcessingType": "SAME_DAY_ACH",
     "bankAccountIdentifier": "TEST63TEST1212121212",
     "bankAccountType": "Savings",
     "bankName": "Citigroup",
     "paymentGatewayData": {
     "gatewayName": "Braintree",
     "gatewayTransactionId": "fjdsS46sdklFd20"
     },
     "paymentSuccessStatus": "Payment Successful",
     "serviceName": "Direct Debit"
     },
     "creditCard": {
     "cardBank": "Chase",
     "cardBrand": "VISA",
     "cardType": "CREDIT",
     "countryOfIssuance": "US",
     "creationTime": 1430997968,
     "expirationMonth": "03",
     "expirationYear": "2018",
     "fullResponsePayload": {},
     "lastFourDigits": "4242",
     "nameOnCard": "John R. H. Smith",
     "paymentProcessorData": {
     "processorName": "Chase Paymentech",
     "processorTransactionId": "fjdsS46sdklFd20"
     },
     "threeDSecure": {
     "acquirerData": {},
     "challengeIndicator": "NO_PREFERENCE",
     "execute3ds": "DYNAMIC_FORTER_DECISION",
     "forcePsd2Exemption": {},
     "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
     },
     "token": "tkn-77620C360132856A103477D2959967AB",
     "verificationResults": {
     "authorizationCode": "A33244",
     "authorizationProcessedWith3DS": true,
     "avsFullResult": "Y",
     "avsNameResult": "M",
     "avsStreetResult": "N",
     "avsZipResult": "M",
     "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
     "cvvResult": "M",
     "eciValue": "05",
     "liabilityShift": true,
     "processorResponseCode": "D23",
     "processorResponseText": "Stolen card",
     "threeDsStatus": "Cardholder authenticated",
     "threeDsVersion": "2.1.0"
     }
     },
     "underlyingPaymentMethodType": "UNKNOWN"
     }
     },
     "giftCard": {
     "activationTime": 1448549922,
     "creditCurrency": "CAD",
     "creditOrigin": "CS Compensation",
     "merchantPaymentId": "eab12-ba9a-367-60b",
     "value": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     },
     "installmentService": {
     "firstName": "John",
     "fullResponsePayload": {},
     "lastName": "Smith",
     "paymentId": "YTZ8IATEGAWRRVVG",
     "serviceName": "Affirm",
     "serviceResponseCode": "200"
     },
     "loyaltyPoints": {
     "loyaltyPointsCount": 1506,
     "loyaltyPointsSource": "IN_ACCOUNT_PURCHASES",
     "loyaltyPointsValue": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     },
     "merchantPaymentId": "eab12-ba9a-367-60b"
     },
     "merchantInitiated": {
     "initialOrderId": "2356fdse0rr489"
     },
     "mobileMoney": {
     "fullResponsePayload": {},
     "mobileMoneyNetwork": "MPESA",
     "paymentAcquirerData": {
     "acquirerBIN": "457173",
     "acquirerCountry": "US",
     "acquirerMerchantId": "5245020244654",
     "acquirerMerchantName": "Simple T-shirt",
     "acquirerName": "Barclays",
     "merchantCategoryCode": 5655,
     "merchantCountryCode": 840
     },
     "paymentGatewayData": {
     "gatewayName": "Braintree",
     "gatewayTransactionId": "fjdsS46sdklFd20"
     },
     "paymentSuccessStatus": "success",
     "phoneNumber": "15557654321"
     },
     "numberOfInstallments": 12,
     "paymentMethodNickname": "My Work Card",
     "paypal": {
     "authorizationId": "2WC75407LV7300439",
     "fullPaypalResponsePayload": {},
     "payerAccountCountry": "US",
     "payerAddressStatus": "CONFIRMED",
     "payerEmail": "[email protected]",
     "payerId": "FD000A45P",
     "payerStatus": "VERIFIED",
     "paymentGatewayData": {
     "gatewayName": "Braintree",
     "gatewayTransactionId": "fjdsS46sdklFd20"
     },
     "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
     "paymentStatus": "COMPLETED",
     "protectionEligibility": "ELIGIBLE"
     },
     "recurringPayment": {
     "currentPaymentNumber": 1,
     "initialPaymentOrderId": "2356fdse0rr483",
     "recurringPaymentExpirationDate": "1988-06-22",
     "recurringPaymentFrequency": "7",
     "totalNumberOfPayments": 12
     },
     "samsungPay": {
     "cardBank": "Chase",
     "cardBrand": "VISA",
     "cardType": "CREDIT",
     "countryOfIssuance": "US",
     "creationTime": 1430997968,
     "expirationMonth": "03",
     "expirationYear": "2018",
     "fullResponsePayload": {},
     "lastFourDigits": "4242",
     "nameOnCard": "John R. H. Smith",
     "paymentProcessorData": {
     "processorName": "Chase Paymentech",
     "processorTransactionId": "fjdsS46sdklFd20"
     },
     "threeDSecure": {
     "acquirerData": {
     "acquirerBIN": "457173",
     "acquirerCountry": "US",
     "acquirerMerchantId": "5245020244654",
     "acquirerMerchantName": "Simple T-shirt",
     "acquirerName": "Barclays",
     "merchantCategoryCode": 5655,
     "merchantCountryCode": 840
     },
     "challengeIndicator": "NO_PREFERENCE",
     "execute3ds": "DYNAMIC_FORTER_DECISION",
     "forcePsd2Exemption": {
     "channel": "THREEDS_RAILS",
     "type": "LOW_VALUE"
     },
     "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
     },
     "token": "tkn-77620C360132856A103477D2959967AB",
     "verificationResults": {
     "authorizationCode": "A33244",
     "authorizationProcessedWith3DS": true,
     "avsFullResult": "Y",
     "avsNameResult": "M",
     "avsStreetResult": "N",
     "avsZipResult": "M",
     "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
     "cvvResult": "M",
     "eciValue": "05",
     "liabilityShift": true,
     "processorResponseCode": "D23",
     "processorResponseText": "Stolen card",
     "threeDsStatus": "Cardholder authenticated",
     "threeDsVersion": "2.1.0"
     }
     },
     "savedData": {
     "usedSavedData": true
     },
     "storeCreditUsed": {
     "activationTime": 1448549922,
     "creditCurrency": "CAD",
     "creditOrigin": "CS Compensation",
     "merchantPaymentId": "eab12-ba9a-367-60b",
     "value": {
     "amountLocalCurrency": "105.55",
     "amountUSD": "99.95",
     "currency": "CAD"
     }
     },
     "tokenizedCard": {
     "cardBank": "Chase",
     "cardBrand": "VISA",
     "cardType": "CREDIT",
     "countryOfIssuance": "US",
     "creationTime": 1430997968,
     "expirationMonth": "03",
     "expirationYear": "2018",
     "fullResponsePayload": {},
     "lastFourDigits": "4242",
     "nameOnCard": "John R. H. Smith",
     "paymentProcessorData": {
     "processorName": "Chase Paymentech",
     "processorTransactionId": "fjdsS46sdklFd20"
     },
     "threeDSecure": {
     "acquirerData": {
     "acquirerBIN": "457173",
     "acquirerCountry": "US",
     "acquirerMerchantId": "5245020244654",
     "acquirerMerchantName": "Simple T-shirt",
     "acquirerName": "Barclays",
     "merchantCategoryCode": 5655,
     "merchantCountryCode": 840
     },
     "challengeIndicator": "NO_PREFERENCE",
     "execute3ds": "DYNAMIC_FORTER_DECISION",
     "forcePsd2Exemption": {
     "channel": "THREEDS_RAILS",
     "type": "LOW_VALUE"
     },
     "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
     },
     "token": "tkn-77620C360132856A103477D2959967AB",
     "verificationResults": {
     "authorizationCode": "A33244",
     "authorizationProcessedWith3DS": true,
     "avsFullResult": "Y",
     "avsNameResult": "M",
     "avsStreetResult": "N",
     "avsZipResult": "M",
     "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
     "cvvResult": "M",
     "eciValue": "05",
     "liabilityShift": true,
     "processorResponseCode": "D23",
     "processorResponseText": "Stolen card",
     "threeDsStatus": "Cardholder authenticated",
     "threeDsVersion": "2.1.0"
     }
     },
     "venmo": {
     "fullVenmoResponsePayload": "",
     "paymentId": "1KZSDEYA",
     "token": "77620C360132856A103477D2959967AB",
     "userId": "johndoe",
     "userName": "johndoe1987"
     }
     },
     "newPhone": {
     "phone": "15557654321",
     "smsVerified": {
     "sent": true,
     "timeSent": 1389567341,
     "verified": false
     }
     },
     "originalOrderId": "2356fdse0rr489",
     "passwordUpdateTrigger": "USER_FORGOT_PASSWORD"
     }'

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({
   "accessRequestType": "UPDATE_PASSWORD",
   "accountId": "e520-ba9a-367-60b",
   "accountOwner": {
      "accountId": "e520-ba9a-367-60b",
      "birthdate": "1987-05-22",
      "created": 1415273168,
      "email": "[email protected]",
      "firstName": "John",
      "fullName": "Smith",
      "gender": "MALE",
      "lastName": "Smith",
      "loyaltyProgramsInAccount": [
         {
            "accountNumber": "VC1568OP",
            "loyaltyPointsValue": {
               "amountLocalCurrency": "105.55",
               "amountUSD": "99.95",
               "currency": "CAD"
            },
            "programName": "StarAlliance",
            "tier": "Blue"
         }
      ],
      "socialNetworkData": [
         {
            "networkName": "FACEBOOK",
            "profileId": "10000054564897"
         }
      ]
   },
   "additionalAccountEventIdentifiers": {},
   "additionalInformation": {},
   "channelType": "WEB",
   "connectionInformation": {
      "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "customerIP": "10.0.0.127",
      "forterMobileUID": "6429751237891",
      "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
      "merchantDeviceIdentifier": "HGJ7512345H3",
      "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "eventTime": 1415287568000,
   "newAddress": {
      "address1": "235 Montgomery st.",
      "address2": "Ste. 1110",
      "city": "San Francisco",
      "company": "Generic Corp. ltd.",
      "country": "US",
      "region": "CA",
      "savedData": {
         "usedSavedData": true
      },
      "zip": "94104"
   },
   "newEmail": {
      "email": "[email protected]",
      "emailVerification": {
         "sent": true,
         "timeSent": 1389567341,
         "verified": false
      }
   },
   "newPaymentMethods": {
      "amount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      },
      "androidPay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "applePay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "bankTransfer": {
         "accountHolderFirstName": "John",
         "accountHolderLastName": "Smith",
         "achProcessingType": "SAME_DAY_ACH",
         "bankAccountIdentifier": "TEST63TEST1212121212",
         "bankAccountType": "Savings",
         "bankName": "Citigroup",
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentSuccessStatus": "Payment Successful",
         "serviceName": "Direct Debit"
      },
      "billingDetails": {
         "address": {
            "address1": "235 Montgomery st.",
            "address2": "Ste. 1110",
            "city": "San Francisco",
            "company": "Generic Corp. ltd.",
            "country": "US",
            "region": "CA",
            "savedData": {
               "usedSavedData": true
            },
            "zip": "94104"
         },
         "allAdditionalVerificationDocuments": [
            {
               "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"
            }
         ],
         "employmentInformation": [
            {
               "employerAddress": {
                  "address1": "235 Montgomery st.",
                  "address2": "Ste. 1110",
                  "city": "San Francisco",
                  "company": "Generic Corp. ltd.",
                  "country": "US",
                  "region": "CA",
                  "savedData": {
                     "usedSavedData": true
                  },
                  "zip": "94104"
               },
               "employerCompanySizeRange": "20",
               "employerIndustry": "Retail",
               "employerName": "Forter",
               "employerPhone": "+12126667777",
               "income": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "jobTitle": "Fraud Analyst"
            }
         ],
         "personalDetails": {
            "birthdate": "1987-05-22",
            "email": "[email protected]",
            "firstName": "John",
            "fullName": "John Smith",
            "gender": "MALE",
            "lastName": "Smith"
         },
         "phone": [
            {
               "phone": "15557654321",
               "smsVerified": {
                  "sent": true,
                  "timeSent": 1389567341,
                  "verified": false
               }
            }
         ]
      },
      "cameraCaptured": true,
      "creditCard": {
         "bin": "42424242",
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fingerprint": "Xt5EWLLDS7FJjR1c",
         "fullCreditCard": "2424242424242424",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "verificationResults": {
            "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"
         }
      },
      "creditLineDetails": {
         "askedToIncreaseCreditLineLimit": false,
         "creditLineLimitIncreaseMethod": "AT_PURCHASE",
         "currentCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         },
         "originalCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "cryptoWallet": {
         "cryptoWalletName": "CryptoWallet",
         "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
         "cryptoWalletType": "EXTERNAL"
      },
      "digitalWallet": {
         "digitalWalletName": "ALIPAY",
         "digitalWalletPayerEmail": "[email protected]",
         "digitalWalletPayerId": "FD000A45P",
         "digitalWalletpaymentId": "PAY-0MB00000KR8073311KZSDEYA",
         "freeTextDigitalWalletName": "ALIBABA",
         "fullDigitalWalletResponsePayload": {},
         "payerAccountCountry": "US",
         "paymentSuccessStatus": "COMPLETED",
         "underlyingPaymentMethod": {
            "bankTransfer": {
               "accountHolderFirstName": "John",
               "accountHolderLastName": "Smith",
               "achProcessingType": "SAME_DAY_ACH",
               "bankAccountIdentifier": "TEST63TEST1212121212",
               "bankAccountType": "Savings",
               "bankName": "Citigroup",
               "paymentGatewayData": {
                  "gatewayName": "Braintree",
                  "gatewayTransactionId": "fjdsS46sdklFd20"
               },
               "paymentSuccessStatus": "Payment Successful",
               "serviceName": "Direct Debit"
            },
            "creditCard": {
               "cardBank": "Chase",
               "cardBrand": "VISA",
               "cardType": "CREDIT",
               "countryOfIssuance": "US",
               "creationTime": 1430997968,
               "expirationMonth": "03",
               "expirationYear": "2018",
               "fullResponsePayload": {},
               "lastFourDigits": "4242",
               "nameOnCard": "John R. H. Smith",
               "paymentProcessorData": {
                  "processorName": "Chase Paymentech",
                  "processorTransactionId": "fjdsS46sdklFd20"
               },
               "threeDSecure": {
                  "acquirerData": {},
                  "challengeIndicator": "NO_PREFERENCE",
                  "execute3ds": "DYNAMIC_FORTER_DECISION",
                  "forcePsd2Exemption": {},
                  "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
               },
               "token": "tkn-77620C360132856A103477D2959967AB",
               "verificationResults": {
                  "authorizationCode": "A33244",
                  "authorizationProcessedWith3DS": true,
                  "avsFullResult": "Y",
                  "avsNameResult": "M",
                  "avsStreetResult": "N",
                  "avsZipResult": "M",
                  "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
                  "cvvResult": "M",
                  "eciValue": "05",
                  "liabilityShift": true,
                  "processorResponseCode": "D23",
                  "processorResponseText": "Stolen card",
                  "threeDsStatus": "Cardholder authenticated",
                  "threeDsVersion": "2.1.0"
               }
            },
            "underlyingPaymentMethodType": "UNKNOWN"
         }
      },
      "giftCard": {
         "activationTime": 1448549922,
         "creditCurrency": "CAD",
         "creditOrigin": "CS Compensation",
         "merchantPaymentId": "eab12-ba9a-367-60b",
         "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "installmentService": {
         "firstName": "John",
         "fullResponsePayload": {},
         "lastName": "Smith",
         "paymentId": "YTZ8IATEGAWRRVVG",
         "serviceName": "Affirm",
         "serviceResponseCode": "200"
      },
      "loyaltyPoints": {
         "loyaltyPointsCount": 1506,
         "loyaltyPointsSource": "IN_ACCOUNT_PURCHASES",
         "loyaltyPointsValue": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         },
         "merchantPaymentId": "eab12-ba9a-367-60b"
      },
      "merchantInitiated": {
         "initialOrderId": "2356fdse0rr489"
      },
      "mobileMoney": {
         "fullResponsePayload": {},
         "mobileMoneyNetwork": "MPESA",
         "paymentAcquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
         },
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentSuccessStatus": "success",
         "phoneNumber": "15557654321"
      },
      "numberOfInstallments": 12,
      "paymentMethodNickname": "My Work Card",
      "paypal": {
         "authorizationId": "2WC75407LV7300439",
         "fullPaypalResponsePayload": {},
         "payerAccountCountry": "US",
         "payerAddressStatus": "CONFIRMED",
         "payerEmail": "[email protected]",
         "payerId": "FD000A45P",
         "payerStatus": "VERIFIED",
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
         "paymentStatus": "COMPLETED",
         "protectionEligibility": "ELIGIBLE"
      },
      "recurringPayment": {
         "currentPaymentNumber": 1,
         "initialPaymentOrderId": "2356fdse0rr483",
         "recurringPaymentExpirationDate": "1988-06-22",
         "recurringPaymentFrequency": "7",
         "totalNumberOfPayments": 12
      },
      "samsungPay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "savedData": {
         "usedSavedData": true
      },
      "storeCreditUsed": {
         "activationTime": 1448549922,
         "creditCurrency": "CAD",
         "creditOrigin": "CS Compensation",
         "merchantPaymentId": "eab12-ba9a-367-60b",
         "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "tokenizedCard": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "venmo": {
         "fullVenmoResponsePayload": "",
         "paymentId": "1KZSDEYA",
         "token": "77620C360132856A103477D2959967AB",
         "userId": "johndoe",
         "userName": "johndoe1987"
      }
   },
   "newPhone": {
      "phone": "15557654321",
      "smsVerified": {
         "sent": true,
         "timeSent": 1389567341,
         "verified": false
      }
   },
   "originalOrderId": "2356fdse0rr489",
   "passwordUpdateTrigger": "USER_FORGOT_PASSWORD"
});

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

fetch("https://api.forter-secure.com/v2/accounts/profile-access/{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/profile-access/{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({
   "accessRequestType": "UPDATE_PASSWORD",
   "accountId": "e520-ba9a-367-60b",
   "accountOwner": {
      "accountId": "e520-ba9a-367-60b",
      "birthdate": "1987-05-22",
      "created": 1415273168,
      "email": "[email protected]",
      "firstName": "John",
      "fullName": "Smith",
      "gender": "MALE",
      "lastName": "Smith",
      "loyaltyProgramsInAccount": [
         {
            "accountNumber": "VC1568OP",
            "loyaltyPointsValue": {
               "amountLocalCurrency": "105.55",
               "amountUSD": "99.95",
               "currency": "CAD"
            },
            "programName": "StarAlliance",
            "tier": "Blue"
         }
      ],
      "socialNetworkData": [
         {
            "networkName": "FACEBOOK",
            "profileId": "10000054564897"
         }
      ]
   },
   "additionalAccountEventIdentifiers": {},
   "additionalInformation": {},
   "channelType": "WEB",
   "connectionInformation": {
      "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "customerIP": "10.0.0.127",
      "forterMobileUID": "6429751237891",
      "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
      "merchantDeviceIdentifier": "HGJ7512345H3",
      "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "eventTime": 1415287568000,
   "newAddress": {
      "address1": "235 Montgomery st.",
      "address2": "Ste. 1110",
      "city": "San Francisco",
      "company": "Generic Corp. ltd.",
      "country": "US",
      "region": "CA",
      "savedData": {
         "usedSavedData": true
      },
      "zip": "94104"
   },
   "newEmail": {
      "email": "[email protected]",
      "emailVerification": {
         "sent": true,
         "timeSent": 1389567341,
         "verified": false
      }
   },
   "newPaymentMethods": {
      "amount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      },
      "androidPay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "applePay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "bankTransfer": {
         "accountHolderFirstName": "John",
         "accountHolderLastName": "Smith",
         "achProcessingType": "SAME_DAY_ACH",
         "bankAccountIdentifier": "TEST63TEST1212121212",
         "bankAccountType": "Savings",
         "bankName": "Citigroup",
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentSuccessStatus": "Payment Successful",
         "serviceName": "Direct Debit"
      },
      "billingDetails": {
         "address": {
            "address1": "235 Montgomery st.",
            "address2": "Ste. 1110",
            "city": "San Francisco",
            "company": "Generic Corp. ltd.",
            "country": "US",
            "region": "CA",
            "savedData": {
               "usedSavedData": true
            },
            "zip": "94104"
         },
         "allAdditionalVerificationDocuments": [
            {
               "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"
            }
         ],
         "employmentInformation": [
            {
               "employerAddress": {
                  "address1": "235 Montgomery st.",
                  "address2": "Ste. 1110",
                  "city": "San Francisco",
                  "company": "Generic Corp. ltd.",
                  "country": "US",
                  "region": "CA",
                  "savedData": {
                     "usedSavedData": true
                  },
                  "zip": "94104"
               },
               "employerCompanySizeRange": "20",
               "employerIndustry": "Retail",
               "employerName": "Forter",
               "employerPhone": "+12126667777",
               "income": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "jobTitle": "Fraud Analyst"
            }
         ],
         "personalDetails": {
            "birthdate": "1987-05-22",
            "email": "[email protected]",
            "firstName": "John",
            "fullName": "John Smith",
            "gender": "MALE",
            "lastName": "Smith"
         },
         "phone": [
            {
               "phone": "15557654321",
               "smsVerified": {
                  "sent": true,
                  "timeSent": 1389567341,
                  "verified": false
               }
            }
         ]
      },
      "cameraCaptured": true,
      "creditCard": {
         "bin": "42424242",
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fingerprint": "Xt5EWLLDS7FJjR1c",
         "fullCreditCard": "2424242424242424",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "verificationResults": {
            "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"
         }
      },
      "creditLineDetails": {
         "askedToIncreaseCreditLineLimit": false,
         "creditLineLimitIncreaseMethod": "AT_PURCHASE",
         "currentCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         },
         "originalCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "cryptoWallet": {
         "cryptoWalletName": "CryptoWallet",
         "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
         "cryptoWalletType": "EXTERNAL"
      },
      "digitalWallet": {
         "digitalWalletName": "ALIPAY",
         "digitalWalletPayerEmail": "[email protected]",
         "digitalWalletPayerId": "FD000A45P",
         "digitalWalletpaymentId": "PAY-0MB00000KR8073311KZSDEYA",
         "freeTextDigitalWalletName": "ALIBABA",
         "fullDigitalWalletResponsePayload": {},
         "payerAccountCountry": "US",
         "paymentSuccessStatus": "COMPLETED",
         "underlyingPaymentMethod": {
            "bankTransfer": {
               "accountHolderFirstName": "John",
               "accountHolderLastName": "Smith",
               "achProcessingType": "SAME_DAY_ACH",
               "bankAccountIdentifier": "TEST63TEST1212121212",
               "bankAccountType": "Savings",
               "bankName": "Citigroup",
               "paymentGatewayData": {
                  "gatewayName": "Braintree",
                  "gatewayTransactionId": "fjdsS46sdklFd20"
               },
               "paymentSuccessStatus": "Payment Successful",
               "serviceName": "Direct Debit"
            },
            "creditCard": {
               "cardBank": "Chase",
               "cardBrand": "VISA",
               "cardType": "CREDIT",
               "countryOfIssuance": "US",
               "creationTime": 1430997968,
               "expirationMonth": "03",
               "expirationYear": "2018",
               "fullResponsePayload": {},
               "lastFourDigits": "4242",
               "nameOnCard": "John R. H. Smith",
               "paymentProcessorData": {
                  "processorName": "Chase Paymentech",
                  "processorTransactionId": "fjdsS46sdklFd20"
               },
               "threeDSecure": {
                  "acquirerData": {},
                  "challengeIndicator": "NO_PREFERENCE",
                  "execute3ds": "DYNAMIC_FORTER_DECISION",
                  "forcePsd2Exemption": {},
                  "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
               },
               "token": "tkn-77620C360132856A103477D2959967AB",
               "verificationResults": {
                  "authorizationCode": "A33244",
                  "authorizationProcessedWith3DS": true,
                  "avsFullResult": "Y",
                  "avsNameResult": "M",
                  "avsStreetResult": "N",
                  "avsZipResult": "M",
                  "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
                  "cvvResult": "M",
                  "eciValue": "05",
                  "liabilityShift": true,
                  "processorResponseCode": "D23",
                  "processorResponseText": "Stolen card",
                  "threeDsStatus": "Cardholder authenticated",
                  "threeDsVersion": "2.1.0"
               }
            },
            "underlyingPaymentMethodType": "UNKNOWN"
         }
      },
      "giftCard": {
         "activationTime": 1448549922,
         "creditCurrency": "CAD",
         "creditOrigin": "CS Compensation",
         "merchantPaymentId": "eab12-ba9a-367-60b",
         "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "installmentService": {
         "firstName": "John",
         "fullResponsePayload": {},
         "lastName": "Smith",
         "paymentId": "YTZ8IATEGAWRRVVG",
         "serviceName": "Affirm",
         "serviceResponseCode": "200"
      },
      "loyaltyPoints": {
         "loyaltyPointsCount": 1506,
         "loyaltyPointsSource": "IN_ACCOUNT_PURCHASES",
         "loyaltyPointsValue": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         },
         "merchantPaymentId": "eab12-ba9a-367-60b"
      },
      "merchantInitiated": {
         "initialOrderId": "2356fdse0rr489"
      },
      "mobileMoney": {
         "fullResponsePayload": {},
         "mobileMoneyNetwork": "MPESA",
         "paymentAcquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
         },
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentSuccessStatus": "success",
         "phoneNumber": "15557654321"
      },
      "numberOfInstallments": 12,
      "paymentMethodNickname": "My Work Card",
      "paypal": {
         "authorizationId": "2WC75407LV7300439",
         "fullPaypalResponsePayload": {},
         "payerAccountCountry": "US",
         "payerAddressStatus": "CONFIRMED",
         "payerEmail": "[email protected]",
         "payerId": "FD000A45P",
         "payerStatus": "VERIFIED",
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
         "paymentStatus": "COMPLETED",
         "protectionEligibility": "ELIGIBLE"
      },
      "recurringPayment": {
         "currentPaymentNumber": 1,
         "initialPaymentOrderId": "2356fdse0rr483",
         "recurringPaymentExpirationDate": "1988-06-22",
         "recurringPaymentFrequency": "7",
         "totalNumberOfPayments": 12
      },
      "samsungPay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "savedData": {
         "usedSavedData": true
      },
      "storeCreditUsed": {
         "activationTime": 1448549922,
         "creditCurrency": "CAD",
         "creditOrigin": "CS Compensation",
         "merchantPaymentId": "eab12-ba9a-367-60b",
         "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "tokenizedCard": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": true,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": true,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "venmo": {
         "fullVenmoResponsePayload": "",
         "paymentId": "1KZSDEYA",
         "token": "77620C360132856A103477D2959967AB",
         "userId": "johndoe",
         "userName": "johndoe1987"
      }
   },
   "newPhone": {
      "phone": "15557654321",
      "smsVerified": {
         "sent": true,
         "timeSent": 1389567341,
         "verified": false
      }
   },
   "originalOrderId": "2356fdse0rr489",
   "passwordUpdateTrigger": "USER_FORGOT_PASSWORD"
})

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

python

import requests
import json

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

payload = json.dumps({
   "accessRequestType": "UPDATE_PASSWORD",
   "accountId": "e520-ba9a-367-60b",
   "accountOwner": {
      "accountId": "e520-ba9a-367-60b",
      "birthdate": "1987-05-22",
      "created": 1415273168,
      "email": "[email protected]",
      "firstName": "John",
      "fullName": "Smith",
      "gender": "MALE",
      "lastName": "Smith",
      "loyaltyProgramsInAccount": [
         {
            "accountNumber": "VC1568OP",
            "loyaltyPointsValue": {
               "amountLocalCurrency": "105.55",
               "amountUSD": "99.95",
               "currency": "CAD"
            },
            "programName": "StarAlliance",
            "tier": "Blue"
         }
      ],
      "socialNetworkData": [
         {
            "networkName": "FACEBOOK",
            "profileId": "10000054564897"
         }
      ]
   },
   "additionalAccountEventIdentifiers": {},
   "additionalInformation": {},
   "channelType": "WEB",
   "connectionInformation": {
      "checkoutToolsSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "customerIP": "10.0.0.127",
      "forterMobileUID": "6429751237891",
      "forterTokenCookie": "249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg",
      "merchantDeviceIdentifier": "HGJ7512345H3",
      "merchantProvidedSessionId": "HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "eventTime": 1415287568000,
   "newAddress": {
      "address1": "235 Montgomery st.",
      "address2": "Ste. 1110",
      "city": "San Francisco",
      "company": "Generic Corp. ltd.",
      "country": "US",
      "region": "CA",
      "savedData": {
         "usedSavedData": True
      },
      "zip": "94104"
   },
   "newEmail": {
      "email": "[email protected]",
      "emailVerification": {
         "sent": True,
         "timeSent": 1389567341,
         "verified": False
      }
   },
   "newPaymentMethods": {
      "amount": {
         "amountLocalCurrency": "105.55",
         "amountUSD": "99.95",
         "currency": "CAD"
      },
      "androidPay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": True,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": True,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "applePay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": True,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": True,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "bankTransfer": {
         "accountHolderFirstName": "John",
         "accountHolderLastName": "Smith",
         "achProcessingType": "SAME_DAY_ACH",
         "bankAccountIdentifier": "TEST63TEST1212121212",
         "bankAccountType": "Savings",
         "bankName": "Citigroup",
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentSuccessStatus": "Payment Successful",
         "serviceName": "Direct Debit"
      },
      "billingDetails": {
         "address": {
            "address1": "235 Montgomery st.",
            "address2": "Ste. 1110",
            "city": "San Francisco",
            "company": "Generic Corp. ltd.",
            "country": "US",
            "region": "CA",
            "savedData": {
               "usedSavedData": True
            },
            "zip": "94104"
         },
         "allAdditionalVerificationDocuments": [
            {
               "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"
            }
         ],
         "employmentInformation": [
            {
               "employerAddress": {
                  "address1": "235 Montgomery st.",
                  "address2": "Ste. 1110",
                  "city": "San Francisco",
                  "company": "Generic Corp. ltd.",
                  "country": "US",
                  "region": "CA",
                  "savedData": {
                     "usedSavedData": True
                  },
                  "zip": "94104"
               },
               "employerCompanySizeRange": "20",
               "employerIndustry": "Retail",
               "employerName": "Forter",
               "employerPhone": "+12126667777",
               "income": {
                  "amountLocalCurrency": "105.55",
                  "amountUSD": "99.95",
                  "currency": "CAD"
               },
               "jobTitle": "Fraud Analyst"
            }
         ],
         "personalDetails": {
            "birthdate": "1987-05-22",
            "email": "[email protected]",
            "firstName": "John",
            "fullName": "John Smith",
            "gender": "MALE",
            "lastName": "Smith"
         },
         "phone": [
            {
               "phone": "15557654321",
               "smsVerified": {
                  "sent": True,
                  "timeSent": 1389567341,
                  "verified": False
               }
            }
         ]
      },
      "cameraCaptured": True,
      "creditCard": {
         "bin": "42424242",
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fingerprint": "Xt5EWLLDS7FJjR1c",
         "fullCreditCard": "2424242424242424",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "verificationResults": {
            "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"
         }
      },
      "creditLineDetails": {
         "askedToIncreaseCreditLineLimit": False,
         "creditLineLimitIncreaseMethod": "AT_PURCHASE",
         "currentCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         },
         "originalCreditLineLimit": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "cryptoWallet": {
         "cryptoWalletName": "CryptoWallet",
         "cryptoWalletPaymentId": "3JQiwG88SQvwihDAHg9M2EnqEisharz49c",
         "cryptoWalletType": "EXTERNAL"
      },
      "digitalWallet": {
         "digitalWalletName": "ALIPAY",
         "digitalWalletPayerEmail": "[email protected]",
         "digitalWalletPayerId": "FD000A45P",
         "digitalWalletpaymentId": "PAY-0MB00000KR8073311KZSDEYA",
         "freeTextDigitalWalletName": "ALIBABA",
         "fullDigitalWalletResponsePayload": {},
         "payerAccountCountry": "US",
         "paymentSuccessStatus": "COMPLETED",
         "underlyingPaymentMethod": {
            "bankTransfer": {
               "accountHolderFirstName": "John",
               "accountHolderLastName": "Smith",
               "achProcessingType": "SAME_DAY_ACH",
               "bankAccountIdentifier": "TEST63TEST1212121212",
               "bankAccountType": "Savings",
               "bankName": "Citigroup",
               "paymentGatewayData": {
                  "gatewayName": "Braintree",
                  "gatewayTransactionId": "fjdsS46sdklFd20"
               },
               "paymentSuccessStatus": "Payment Successful",
               "serviceName": "Direct Debit"
            },
            "creditCard": {
               "cardBank": "Chase",
               "cardBrand": "VISA",
               "cardType": "CREDIT",
               "countryOfIssuance": "US",
               "creationTime": 1430997968,
               "expirationMonth": "03",
               "expirationYear": "2018",
               "fullResponsePayload": {},
               "lastFourDigits": "4242",
               "nameOnCard": "John R. H. Smith",
               "paymentProcessorData": {
                  "processorName": "Chase Paymentech",
                  "processorTransactionId": "fjdsS46sdklFd20"
               },
               "threeDSecure": {
                  "acquirerData": {},
                  "challengeIndicator": "NO_PREFERENCE",
                  "execute3ds": "DYNAMIC_FORTER_DECISION",
                  "forcePsd2Exemption": {},
                  "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
               },
               "token": "tkn-77620C360132856A103477D2959967AB",
               "verificationResults": {
                  "authorizationCode": "A33244",
                  "authorizationProcessedWith3DS": True,
                  "avsFullResult": "Y",
                  "avsNameResult": "M",
                  "avsStreetResult": "N",
                  "avsZipResult": "M",
                  "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
                  "cvvResult": "M",
                  "eciValue": "05",
                  "liabilityShift": True,
                  "processorResponseCode": "D23",
                  "processorResponseText": "Stolen card",
                  "threeDsStatus": "Cardholder authenticated",
                  "threeDsVersion": "2.1.0"
               }
            },
            "underlyingPaymentMethodType": "UNKNOWN"
         }
      },
      "giftCard": {
         "activationTime": 1448549922,
         "creditCurrency": "CAD",
         "creditOrigin": "CS Compensation",
         "merchantPaymentId": "eab12-ba9a-367-60b",
         "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "installmentService": {
         "firstName": "John",
         "fullResponsePayload": {},
         "lastName": "Smith",
         "paymentId": "YTZ8IATEGAWRRVVG",
         "serviceName": "Affirm",
         "serviceResponseCode": "200"
      },
      "loyaltyPoints": {
         "loyaltyPointsCount": 1506,
         "loyaltyPointsSource": "IN_ACCOUNT_PURCHASES",
         "loyaltyPointsValue": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         },
         "merchantPaymentId": "eab12-ba9a-367-60b"
      },
      "merchantInitiated": {
         "initialOrderId": "2356fdse0rr489"
      },
      "mobileMoney": {
         "fullResponsePayload": {},
         "mobileMoneyNetwork": "MPESA",
         "paymentAcquirerData": {
            "acquirerBIN": "457173",
            "acquirerCountry": "US",
            "acquirerMerchantId": "5245020244654",
            "acquirerMerchantName": "Simple T-shirt",
            "acquirerName": "Barclays",
            "merchantCategoryCode": 5655,
            "merchantCountryCode": 840
         },
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentSuccessStatus": "success",
         "phoneNumber": "15557654321"
      },
      "numberOfInstallments": 12,
      "paymentMethodNickname": "My Work Card",
      "paypal": {
         "authorizationId": "2WC75407LV7300439",
         "fullPaypalResponsePayload": {},
         "payerAccountCountry": "US",
         "payerAddressStatus": "CONFIRMED",
         "payerEmail": "[email protected]",
         "payerId": "FD000A45P",
         "payerStatus": "VERIFIED",
         "paymentGatewayData": {
            "gatewayName": "Braintree",
            "gatewayTransactionId": "fjdsS46sdklFd20"
         },
         "paymentId": "PAY-0MB00000KR8073311KZSDEYA",
         "paymentStatus": "COMPLETED",
         "protectionEligibility": "ELIGIBLE"
      },
      "recurringPayment": {
         "currentPaymentNumber": 1,
         "initialPaymentOrderId": "2356fdse0rr483",
         "recurringPaymentExpirationDate": "1988-06-22",
         "recurringPaymentFrequency": "7",
         "totalNumberOfPayments": 12
      },
      "samsungPay": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": True,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": True,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "savedData": {
         "usedSavedData": True
      },
      "storeCreditUsed": {
         "activationTime": 1448549922,
         "creditCurrency": "CAD",
         "creditOrigin": "CS Compensation",
         "merchantPaymentId": "eab12-ba9a-367-60b",
         "value": {
            "amountLocalCurrency": "105.55",
            "amountUSD": "99.95",
            "currency": "CAD"
         }
      },
      "tokenizedCard": {
         "cardBank": "Chase",
         "cardBrand": "VISA",
         "cardType": "CREDIT",
         "countryOfIssuance": "US",
         "creationTime": 1430997968,
         "expirationMonth": "03",
         "expirationYear": "2018",
         "fullResponsePayload": {},
         "lastFourDigits": "4242",
         "nameOnCard": "John R. H. Smith",
         "paymentProcessorData": {
            "processorName": "Chase Paymentech",
            "processorTransactionId": "fjdsS46sdklFd20"
         },
         "threeDSecure": {
            "acquirerData": {
               "acquirerBIN": "457173",
               "acquirerCountry": "US",
               "acquirerMerchantId": "5245020244654",
               "acquirerMerchantName": "Simple T-shirt",
               "acquirerName": "Barclays",
               "merchantCategoryCode": 5655,
               "merchantCountryCode": 840
            },
            "challengeIndicator": "NO_PREFERENCE",
            "execute3ds": "DYNAMIC_FORTER_DECISION",
            "forcePsd2Exemption": {
               "channel": "THREEDS_RAILS",
               "type": "LOW_VALUE"
            },
            "threeDSServerTransID": "26d648a9-da8a-4f8b-a76d-094801d2fd45"
         },
         "token": "tkn-77620C360132856A103477D2959967AB",
         "verificationResults": {
            "authorizationCode": "A33244",
            "authorizationProcessedWith3DS": True,
            "avsFullResult": "Y",
            "avsNameResult": "M",
            "avsStreetResult": "N",
            "avsZipResult": "M",
            "cavvResult": "VYboNwcsB3F9gTIsbaUjvEuLW0o=",
            "cvvResult": "M",
            "eciValue": "05",
            "liabilityShift": True,
            "processorResponseCode": "D23",
            "processorResponseText": "Stolen card",
            "threeDsStatus": "Cardholder authenticated",
            "threeDsVersion": "2.1.0"
         }
      },
      "venmo": {
         "fullVenmoResponsePayload": "",
         "paymentId": "1KZSDEYA",
         "token": "77620C360132856A103477D2959967AB",
         "userId": "johndoe",
         "userName": "johndoe1987"
      }
   },
   "newPhone": {
      "phone": "15557654321",
      "smsVerified": {
         "sent": True,
         "timeSent": 1389567341,
         "verified": False
      }
   },
   "originalOrderId": "2356fdse0rr489",
   "passwordUpdateTrigger": "USER_FORGOT_PASSWORD"
})
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)

顧客プロファイルへのアクセスまたは編集の試みについての情報を送信し、詐欺の決定を受け取ります。プロファイルの接触点でのアカウント乗っ取り、カードテスト、およびデジタルキーの使用ケースに使用されます。応答には、追加の認証（MFA）に関する推奨事項や、認証結果に含める相関IDも含まれる場合があります。