Signup

POST

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

Send account registration information at signup to receive a fraud or abuse decision.

Path Parameters

idstringrequired

Header Parameters

api-versionstringrequired
Example
10.3
Description
Specify the version of the API to target.
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.

Body Parameters

bodyaccountSignupRequestrequired
Description
Send account registration information at signup to receive a fraud or abuse decision.
- accountDataobject
  - AccountData
    - additionalVerificationDocumentsobject
      - AdditionalVerificationDocuments
        documentDateOfBirthstring<date>
        Example
        1991-01-09
        Description
        Date of birth as appears on the document. Use YYYY-MM-DD format.
        Format
        date
        documentExpirationstring<date>
        Example
        2017-01-15
        Description
        Document's exipration date. Use YYYY-MM-DD format.
        Format
        date
        documentFirstNamestring
        Example
        John
        Description
        First name as appears on the document
        Max Length
        50
        documentIssuingStatestring
        Example
        NY
        Description
        Conditional. Document issuing state or region
        Max Length
        25
        documentLastNamestring
        Example
        Smith
        Description
        Last name as appears on the document
        Max Length
        50
        documentNumberstring
        Example
        20439190
        Description
        Conditional.
        Official document's number (e.g. passport number, driving license number, etc.)
        Max Length
        50
        documentSourcestring<CAMERA_CAPTURED | UPLOADED_FILE | TYPED | OTHER>required
        Example
        UPLOADED_FILE
        Description
        Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)
        Allowed
        CAMERA_CAPTUREDUPLOADED_FILETYPEDOTHER
        documentStatusstring<SENT_TO_CLIENT | RECEIVED_FROM_CLIENT | ABANDONED_BY_CLIENT | RECEIVED_FROM_CLIENT_FAULTY>
        Example
        SENT_TO_CLIENT
        Description
        Conditional.
        Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).
        Allowed
        SENT_TO_CLIENTRECEIVED_FROM_CLIENTABANDONED_BY_CLIENTRECEIVED_FROM_CLIENT_FAULTY
        Max Length
        50
        documentTypestringrequired
        Example
        Passport
        Description
        Type of document (Passport, ID, Driving license)
        Max Length
        35
        documentVerificationServiceAnswerstring
        Example
        APPROVED
        Description
        Conditional. Answer received from 3rd party document verification services
        Max Length
        20
        documentVerificationServiceNamestring
        Example
        IDVerification.com
        Description
        Conditional. Name of 3rd party document verifcation service
        Max Length
        50
        documentVerificationServiceResponsePayloadobject
        GeneralPayloadMap
        documentVerifiedboolean
        Example
        true
        Description
        Conditional. True if document was verified as authentic by merchant or 3rd party service
        eventTimenumber
        Example
        1420070400
        Description
        Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00
        is 1420070400
        nationalitystring
        Example
        US
        Description
        Conditional. Document holder's nationality
        Max Length
        25
    - addressesInAccountAddress[]
      Description
      Conditional.
      All non-billing addresses saved in account. Billing information is included in paymentMethodsInAccount
      - address1stringrequired
        Example
        235 Montgomery st.
        Description
        Street-level address. Required when full address details are available
        Max Length
        255
      - address2string
        Example
        Ste. 1110
        Description
        Conditional.
        Unit-level address
        Max Length
        255
      - citystringrequired
        Example
        San Francisco
        Description
        City. Required when full address details are available
        Max Length
        200
      - companystring
        Example
        Generic Corp. ltd.
        Description
        Company
        Max Length
        225
      - countrystringrequired
        Example
        US
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
      - regionstring
        Example
        CA
        Description
        Conditional.
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Max Length
        200
      - savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
      - zipstring
        Example
        94104
        Description
        Conditional. Zipcode
        Max Length
        20
    - creatednumber
      Example
      1415273168
      Description
      Conditional.
      Account creation date in seconds since unix epoch (UTC, Jan 1, 1970)
    - customerEngagementobject
      - CustomerEngagement
        aboutMeboolean
        Description
        True if customer added a short bio or about me to the profile
        communityPostsWrittenobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        enableDeviceLocationboolean
        Description
        Set to True if the user has allowed the app to track their location.
        extendedBioOrDescriptionboolean
        Description
        True if account owner added an extended info/bio/description paragraph to their profile
        followersCountinteger
        Example
        105
        Description
        Number of followers of customer's account, or number of likes to user's profile
        followingCountinteger
        Example
        230
        Description
        Number of other users the customer is following, or number of likes customer gave to other users' profiles
        invitesInvite[]
        Description
        Invites to merchant's site customer sent and received
        invitationCounterpartyPhonestring
        Example
        +12126667777
        Description
        Invitation sender/recipient phone number
        Max Length
        25
        sentnumber
        Example
        1420955538
        Description
        Conditional.
        Time invite was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        typestring<SENT | RECEIVED>required
        Example
        SENT
        Description
        Type of invite
        Allowed
        SENTRECEIVED
        likedItemsobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        messagesReceivedobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        messagesSentobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        newslettersobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        profileLogoboolean
        Description
        True if account owner added a non-default logo to their account
        profilePictureboolean
        Example
        true
        Description
        True if customer added a profile picture
        requestedDemoboolean
        Example
        true
        Description
        True if account owner requested to schedule a walthrough or demo of the site
        reviewsWrittenobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        savedLocationsExactLocation[]
        Description
        Saved locations in account.
        latitudenumberrequired
        Example
        32.07332
        Description
        Latitude in Decimal Degrees (WGS84)
        longitudenumberrequired
        Example
        34.79675
        Description
        Longitude in Decimal Degrees (WGS84)
        sourcestringrequired
        Example
        MOBILE
        Description
        Source of location data
        Max Length
        50
        sharedItemsobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        signedUpForPushNotificationsboolean
        Example
        true
        Description
        True if customer asked to receive push notifications from the merchant.
        signedUpForSMSUpdatesboolean
        Example
        true
        Description
        True if customer asked to receive SMS updates from the merchant regarding discounts, promotions, etc.
        wishlistobject
        ListProperties
        inUseboolean
        Example
        true
        Description
        Indicates whether the feature is in use, for example if a customer is subscribed to a newsletter, has items in his wishlist etc.
        itemInListCountinteger
        Example
        4
        Description
        Number of items in the list
        updateTimesobject
        UpdateTimes
        creationTimenumberrequired
        Example
        1448549922
        Description
        Time item was first entered by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastModifiedTimenumber
        Example
        1448549922
        Description
        Time item was last modified by the customer in seconds since unix epoch (UTC, Jan 1, 1970)
        lastUsednumber
        Example
        1448560456
        Description
        Time item was last used by customer in seconds since unix epoch (UTC, Jan 1, 1970)
        removalTimenumber
        Example
        1448895522
        Description
        Time item was removed by customer in seconds since unix epoch (UTC, Jan 1, 1970)
    - emailsInAccountEmail[]
      Description
      All email addresses saved in account
      - emailstringrequired
        Example
        [email protected]
        Description
        Email address
        Max Length
        256
      - emailVerificationVerificationrequired
        Description
        True if customer received email verification message to this address and clicked-through back to merchant's site
        sentbooleanrequired
        Example
        true
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        timeSentnumber
        Example
        1389567341
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        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)
    - paymentMethodsInAccountPayment[]
      Description
      Conditional. All payment methods saved in account
      - 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)
      - amountobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - androidPayobject
        TokenizedCreditCard
        cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        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>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        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.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        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
        Max Length
        100
        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
        Allowed
        FORTERMERCHANT
        tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
        verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
      - applePayobject
        TokenizedCreditCard
        cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        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>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        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.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        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
        Max Length
        100
        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
        Allowed
        FORTERMERCHANT
        tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
        verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
      - bankTransferobject
        BankTransfer
        accountHolderFirstNamestring
        Example
        John
        Description
        Bank account holder first name
        Max Length
        50
        accountHolderLastNamestring
        Example
        Smith
        Description
        Bank account holder last name
        Max Length
        50
        achProcessingTypestring
        Example
        SAME_DAY_ACH
        Description
        Type of ACH processing used in the transaction
        Max Length
        50
        bankAccountIdentifierstring
        Example
        TEST63TEST1212121212
        Description
        Bank account unique identifier (IBAN or equivalent)
        Max Length
        40
        bankAccountTypestring
        Example
        Savings
        Description
        Type of bank account payment is made from (e.g. savings/checking, etc.)
        Max Length
        50
        bankNamestring
        Example
        Citigroup
        Description
        Name of bank payment is made from
        Max Length
        50
        paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
        paymentSuccessStatusstring
        Example
        Payment Successful
        Description
        Response text as received from the service provider
        serviceNamestring
        Example
        Direct Debit
        Description
        Conditional. Payment method name
        Max Length
        30
      - billingDetailsobject
        Person
        addressAddressrequired
        Description
        Address details
        address1stringrequired
        Example
        235 Montgomery st.
        Description
        Street-level address. Required when full address details are available
        Max Length
        255
        address2string
        Example
        Ste. 1110
        Description
        Conditional.
        Unit-level address
        Max Length
        255
        citystringrequired
        Example
        San Francisco
        Description
        City. Required when full address details are available
        Max Length
        200
        companystring
        Example
        Generic Corp. ltd.
        Description
        Company
        Max Length
        225
        countrystringrequired
        Example
        US
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        regionstring
        Example
        CA
        Description
        Conditional.
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Max Length
        200
        savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
        zipstring
        Example
        94104
        Description
        Conditional. Zipcode
        Max Length
        20
        allAdditionalVerificationDocumentsAdditionalVerificationDocuments[]
        Description
        Conditional. Additional identification documents details and verification
        documentDateOfBirthstring<date>
        Example
        1991-01-09
        Description
        Date of birth as appears on the document. Use YYYY-MM-DD format.
        Format
        date
        documentExpirationstring<date>
        Example
        2017-01-15
        Description
        Document's exipration date. Use YYYY-MM-DD format.
        Format
        date
        documentFirstNamestring
        Example
        John
        Description
        First name as appears on the document
        Max Length
        50
        documentIssuingStatestring
        Example
        NY
        Description
        Conditional. Document issuing state or region
        Max Length
        25
        documentLastNamestring
        Example
        Smith
        Description
        Last name as appears on the document
        Max Length
        50
        documentNumberstring
        Example
        20439190
        Description
        Conditional.
        Official document's number (e.g. passport number, driving license number, etc.)
        Max Length
        50
        documentSourcestring<CAMERA_CAPTURED | UPLOADED_FILE | TYPED | OTHER>required
        Example
        UPLOADED_FILE
        Description
        Source of document (e.g. uploaded file, captured by camera, typed in by customer, etc.)
        Allowed
        CAMERA_CAPTUREDUPLOADED_FILETYPEDOTHER
        documentStatusstring<SENT_TO_CLIENT | RECEIVED_FROM_CLIENT | ABANDONED_BY_CLIENT | RECEIVED_FROM_CLIENT_FAULTY>
        Example
        SENT_TO_CLIENT
        Description
        Conditional.
        Status of verification document (e.g. sent to customer, received by customer, abandoned by customer ).
        Allowed
        SENT_TO_CLIENTRECEIVED_FROM_CLIENTABANDONED_BY_CLIENTRECEIVED_FROM_CLIENT_FAULTY
        Max Length
        50
        documentTypestringrequired
        Example
        Passport
        Description
        Type of document (Passport, ID, Driving license)
        Max Length
        35
        documentVerificationServiceAnswerstring
        Example
        APPROVED
        Description
        Conditional. Answer received from 3rd party document verification services
        Max Length
        20
        documentVerificationServiceNamestring
        Example
        IDVerification.com
        Description
        Conditional. Name of 3rd party document verifcation service
        Max Length
        50
        documentVerificationServiceResponsePayloadobject
        GeneralPayloadMap
        documentVerifiedboolean
        Example
        true
        Description
        Conditional. True if document was verified as authentic by merchant or 3rd party service
        eventTimenumber
        Example
        1420070400
        Description
        Time of event in seconds since unix epoch (UTC, Jan 1, 1970). For example, 01/01/2015 00
        is 1420070400
        nationalitystring
        Example
        US
        Description
        Conditional. Document holder's nationality
        Max Length
        25
        employmentInformationEmploymentInformation[]
        Description
        Credit applicant's employment information
        employerAddressobject
        Address
        address1stringrequired
        Example
        235 Montgomery st.
        Description
        Street-level address. Required when full address details are available
        Max Length
        255
        address2string
        Example
        Ste. 1110
        Description
        Conditional.
        Unit-level address
        Max Length
        255
        citystringrequired
        Example
        San Francisco
        Description
        City. Required when full address details are available
        Max Length
        200
        companystring
        Example
        Generic Corp. ltd.
        Description
        Company
        Max Length
        225
        countrystringrequired
        Example
        US
        Description
        Country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        regionstring
        Example
        CA
        Description
        Conditional.
        Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York)
        Max Length
        200
        savedDataobject
        SavedData
        Max depth limit reached
        zipstring
        Example
        94104
        Description
        Conditional. Zipcode
        Max Length
        20
        employerCompanySizeRangestring
        Example
        20
        Description
        Employing company's number of employees
        Max Length
        30
        employerIndustrystring
        Example
        Retail
        Description
        Employing company's industry
        Max Length
        100
        employerNamestringrequired
        Example
        Forter
        Description
        Employing company's name
        Max Length
        100
        employerPhonestring
        Example
        +12126667777
        Description
        Employing company's phone
        Max Length
        30
        incomeobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        jobTitlestring
        Example
        Fraud Analyst
        Description
        Job title
        Max Length
        50
        personalDetailsPersonalDetailsrequired
        Description
        Personal information such as name and birthdate
        birthdatestring<date>
        Example
        1987-05-22
        Description
        Conditional.
        Date of birth. Use YYYY-MM-DD format.
        Format
        date
        emailstring
        Example
        [email protected]
        Description
        Conditional. Email address
        Max Length
        256
        firstNamestring
        Example
        John
        Description
        Conditional. First name
        Max Length
        75
        fullNamestring
        Example
        John Smith
        Description
        Conditional. Full name. Not Needed if firstName and LastName are provided independently.
        Max Length
        150
        genderstring<MALE | FEMALE | CHOSE_NOT_TO_SPECIFY | NONE>
        Example
        MALE
        Description
        Conditional. Gender
        Allowed
        MALEFEMALECHOSE_NOT_TO_SPECIFYNONE
        lastNamestring
        Example
        Smith
        Description
        Conditional. Last name
        Max Length
        75
        phonePhone[]
        Description
        Conditional. Phone details
        phonestringrequired
        Example
        15557654321
        Description
        Phone number including all country and local access codes
        Max Length
        25
        smsVerifiedVerificationrequired
        Description
        Phone verification details
        sentbooleanrequired
        Example
        true
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        timeSentnumber
        Example
        1389567341
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        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)
      - cameraCapturedboolean
        Example
        true
        Description
        Conditional. True if payment instrument details were captured by OCR from a picture. False if payment instrument details were manually typed in
      - cashboolean
        Description
        Payed with cash
      - creditCardobject
        CreditCard
        binstringrequired
        Example
        42424242
        Description
        Credit card's BIN (Bank Identification Number)
        Max Length
        8
        Pattern
        [0-9]{6,8}
        cardBankstring
        Example
        Chase
        Description
        Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Credit Card's issuer brand
        Max Length
        30
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstringrequired
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstringrequired
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fingerprintstring
        Example
        Xt5EWLLDS7FJjR1c
        Description
        Conditional.
        Unique identifier for card (sent by gateway or processor)
        Max Length
        128
        fullCreditCardstring
        Example
        2424242424242424
        Description
        Credit Card's full PAN - needed for the 3DS secure implementation
        Max Length
        30
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstringrequired
        Example
        4242
        Description
        Credit card's last 4 digits (For Amex, take 4 digits from last digit)
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstringrequired
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        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>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        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.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        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
        Max Length
        100
        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
        Allowed
        FORTERMERCHANT
        verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
      - creditLineDetailsobject
        CreditLineDetails
        askedToIncreaseCreditLineLimitbooleanrequired
        Description
        True if customer asked to increase credit line limit
        creditLineLimitIncreaseMethodstring<PRE_APPROVAL | AT_PURCHASE>required
        Example
        AT_PURCHASE
        Description
        Method customer chose to ask to increase credit line limit - PRE_APPROVAL, AT_PURCHASE
        Allowed
        PRE_APPROVALAT_PURCHASE
        currentCreditLineLimitAmountrequired
        Description
        Current limit that was set for the credit line
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        originalCreditLineLimitAmountrequired
        Description
        Original limit that was set for the credit line
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - cryptoWalletobject
        CryptoWallet
        cryptoWalletNamestring
        Example
        CryptoWallet
        Description
        Crypto wallet name
        Max Length
        30
        cryptoWalletPaymentIdstring
        Example
        3JQiwG88SQvwihDAHg9M2EnqEisharz49c
        Description
        Crypto wallet payment ID
        Max Length
        50
        cryptoWalletTypestring<INTERNAL | EXTERNAL>required
        Example
        EXTERNAL
        Description
        Crypto wallet type (Indicate whether wallet provider is internal to the site ecosystem)
        Allowed
        INTERNALEXTERNAL
      - 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
        Example
        ALIPAY
        Description
        Digital wallet name
        Allowed
        AMAZONPAYFACEBOOKPAYALIPAYWECHATAMEDIGITALMERCADOPAGODUEZELLEPAYONEERALLIEDWALLETKONBINIUNIONPAYIYZICOVENMOBARTERPAYNOWPAYCOKAKAOPAYNAVERPAYLINEPAYBANCONTACTMBWAYAIIABLIKEPSOVODANAGCASHGOPAYRAKUTENPAYAPLAZOGRABPAYTWINTTRUEMONEYSWISHKLARNASHOPBACKOTHERPAYPAY
        digitalWalletPayerEmailstring
        Example
        [email protected]
        Description
        Conditional. Email address associated with the digital wallet account
        Max Length
        75
        digitalWalletPayerIdstring
        Example
        FD000A45P
        Description
        Conditional.
        Unique identifier for each digital wallet account. This ID should persist across all orders made by the same user, regardless of underlying payment methods.
        Max Length
        154
        digitalWalletpaymentIdstring
        Example
        PAY-0MB00000KR8073311KZSDEYA
        Description
        Digital wallet payment ID
        Max Length
        50
        freeTextDigitalWalletNamestring
        Example
        ALIBABA
        Description
        Conditional.
        Specifics about the source of the wallet such as the name / 3rd party name, etc. (required for OTHER digitalWalletName)
        fullDigitalWalletResponsePayloadobject
        GeneralPayloadMap
        payerAccountCountrystring
        Example
        US
        Description
        Conditional.
        Digital wallet account country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        paymentSuccessStatusstring
        Example
        COMPLETED
        Description
        Conditional. Digital wallet payment status
        Max Length
        50
        underlyingPaymentMethodUnderlyingPaymentMethodrequired
        Description
        The underlying payment method associated to the digital wallet that was used in the current transaction
        bankTransferobject
        BankTransfer
        accountHolderFirstNamestring
        Example
        John
        Description
        Bank account holder first name
        Max Length
        50
        accountHolderLastNamestring
        Example
        Smith
        Description
        Bank account holder last name
        Max Length
        50
        achProcessingTypestring
        Example
        SAME_DAY_ACH
        Description
        Type of ACH processing used in the transaction
        Max Length
        50
        bankAccountIdentifierstring
        Example
        TEST63TEST1212121212
        Description
        Bank account unique identifier (IBAN or equivalent)
        Max Length
        40
        bankAccountTypestring
        Example
        Savings
        Description
        Type of bank account payment is made from (e.g. savings/checking, etc.)
        Max Length
        50
        bankNamestring
        Example
        Citigroup
        Description
        Name of bank payment is made from
        Max Length
        50
        paymentGatewayDataobject
        PaymentGatewayData
        Max depth limit reached
        paymentSuccessStatusstring
        Example
        Payment Successful
        Description
        Response text as received from the service provider
        serviceNamestring
        Example
        Direct Debit
        Description
        Conditional. Payment method name
        Max Length
        30
        bitcoinboolean
        Description
        Conditional. Bitcoin payment details
        cashboolean
        Description
        Conditional. Payed with cash
        creditCardobject
        TokenizedCreditCard
        cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fullResponsePayloadobject
        GeneralPayloadMap
        Max depth limit reached
        lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        Max depth limit reached
        threeDSecureobject
        ThreeDSecureInput
        Max depth limit reached
        tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
        verificationResultsobject
        CreditCardVerification
        Max depth limit reached
        underlyingPaymentMethodTypestring<UNKNOWN | CREDITCARD | BANKTRANSFER | CASH | BITCOIN>required
        Example
        UNKNOWN
        Description
        Underlying payment method type used in current transaction
        Allowed
        UNKNOWNCREDITCARDBANKTRANSFERCASHBITCOIN
      - giftCardobject
        CreditUsed
        activationTimenumber
        Example
        1448549922
        Description
        Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCurrencystring
        Example
        CAD
        Description
        Conditional.
        Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        creditOriginstring
        Example
        CS Compensation
        Description
        Source which created gift card for customer.
        merchantPaymentIdstring
        Example
        eab12-ba9a-367-60b
        Description
        unique payment identifier for the merchant reference.
        Max Length
        150
        valueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - installmentServiceobject
        InstallmentService
        firstNamestring
        Example
        John
        Description
        Account holder's first name
        Max Length
        75
        fullResponsePayloadobject
        GeneralPayloadMap
        lastNamestring
        Example
        Smith
        Description
        Account holder's last name
        Max Length
        75
        paymentIdstring
        Example
        YTZ8IATEGAWRRVVG
        Description
        Installment payment ID
        Max Length
        50
        serviceNamestring
        Example
        Affirm
        Description
        Conditional. Installment service's name
        Max Length
        30
        serviceResponseCodestring
        Example
        200
        Description
        Response code received from installment service
        Max Length
        50
      - loyaltyPointsobject
        LoyaltyPoints
        loyaltyPointsCountnumberrequired
        Example
        1506
        Description
        Number of points (miles, stars, etc.)
        loyaltyPointsSourcestring<REFERRAL | IN_ACCOUNT_PURCHASES | PROMOTION | COMPENSATION | CARD_SCHEME_POINTS>
        Example
        IN_ACCOUNT_PURCHASES
        Description
        Conditional.
        Source of points (promo, referral, etc.)
        Allowed
        REFERRALIN_ACCOUNT_PURCHASESPROMOTIONCOMPENSATIONCARD_SCHEME_POINTS
        loyaltyPointsValueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        merchantPaymentIdstring
        Example
        eab12-ba9a-367-60b
        Description
        unique payment identifier for the merchant reference.
        Max Length
        150
      - merchantInitiatedobject
        MerchantInitiatedPayment
        initialOrderIdstring
        Example
        2356fdse0rr489
        Description
        Unique order/transaction identifier of the initial order (CIT).
        Max Length
        40
        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
        Allowed
        RECURRING_TRANSACTIONINSTALMENT_TRANSACTIONADD_CARDMAINTAIN_CARD_INFORMATIONACCOUNT_VERIFICATIONSPLIT_OR_DELAYED_SHIPMENTTOP_UPMAIL_ORDERTELEPHONE_ORDERWHITELIST_STATUS_CHECKOTHER_PAYMENT
      - mobileMoneyobject
        MobileMoney
        fullResponsePayloadobject
        GeneralPayloadMap
        mobileMoneyNetworkstring<MPESA | MTN | MPAWA | MSHWAEI | SAFARICOM | DASH>required
        Example
        MPESA
        Description
        Mobile money provider name
        Allowed
        MPESAMTNMPAWAMSHWAEISAFARICOMDASH
        paymentAcquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        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>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        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.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
        paymentSuccessStatusstring
        Example
        success
        Description
        Mobile money payment status
        Max Length
        50
        phoneNumberstringrequired
        Example
        15557654321
        Description
        Account phone number
        Max Length
        50
      - numberOfInstallmentsinteger
        Example
        12
        Description
        Conditional. Number of payments if customer chose to pay in several installments
      - paymentMethodNicknamestring
        Example
        My Work Card
        Description
        Conditional. Nickname assigned to this payment method by the user
      - paypalobject
        Paypal
        authorizationIdstring
        Example
        2WC75407LV7300439
        Description
        Conditional. PayPal authorization ID
        Max Length
        50
        fullPaypalResponsePayloadobject
        GeneralPayloadMap
        payerAccountCountrystring
        Example
        US
        Description
        Conditional.
        PayPal account country, two-letter ISO 3166-1 alpha-2 country code
        Min Length
        2
        Max Length
        2
        payerAddressStatusstring
        Example
        CONFIRMED
        Description
        Conditional. PayPal payer address status
        payerEmailstringrequired
        Example
        [email protected]
        Description
        PayPal payer Email address
        Max Length
        256
        payerIdstringrequired
        Example
        FD000A45P
        Description
        PayPal payer ID
        Max Length
        154
        payerStatusstring
        Example
        VERIFIED
        Description
        Conditional. PayPal payer status
        paymentGatewayDataobject
        PaymentGatewayData
        gatewayNamestring
        Example
        Braintree
        Description
        Conditional. Payment gateway name
        Max Length
        50
        gatewayTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by gateway)
        Max Length
        50
        paymentIdstring
        Example
        PAY-0MB00000KR8073311KZSDEYA
        Description
        Conditional. PayPal payment ID
        Max Length
        50
        paymentStatusstring
        Example
        COMPLETED
        Description
        PayPal payment status
        Max Length
        50
        protectionEligibilitystring
        Example
        ELIGIBLE
        Description
        Conditional. PayPal protection eligibility
      - recurringPaymentobject
        RecurringPaymentDetails
        currentPaymentNumberinteger
        Example
        1
        Description
        The number of payments processed in this recurring event including current transaction (1 for the original transaction)
        initialPaymentOrderIdstringrequired
        Example
        2356fdse0rr483
        Description
        Original order/transaction identifier that started the recurring event (payment number 1)
        Max Length
        40
        isPaymentAmountIdenticalForAllPaymentsboolean
        Description
        True if the amount is constant between payments
        recurringPaymentExpirationDatestring<date>
        Example
        1988-06-22
        Description
        Date of last expected payment event. Use YYYY-MM-DD format.
        Format
        date
        recurringPaymentFrequencystringrequired
        Example
        7
        Description
        The number of days between transactions.
        totalNumberOfPaymentsinteger
        Example
        12
        Description
        Expected number of payments processed in this recurring event
      - samsungPayobject
        TokenizedCreditCard
        cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        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>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        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.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        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
        Max Length
        100
        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
        Allowed
        FORTERMERCHANT
        tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
        verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
      - savedDataobject
        SavedData
        choseToSaveDataboolean
        Description
        True if customer chose to save data in the account for future use
        usedSavedDatabooleanrequired
        Example
        true
        Description
        True if customer chose to use data saved in the account
      - storeCreditUsedobject
        CreditUsed
        activationTimenumber
        Example
        1448549922
        Description
        Time credit/gift card was activated in the account, in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCurrencystring
        Example
        CAD
        Description
        Conditional.
        Original transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
        creditOriginstring
        Example
        CS Compensation
        Description
        Source which created gift card for customer.
        merchantPaymentIdstring
        Example
        eab12-ba9a-367-60b
        Description
        unique payment identifier for the merchant reference.
        Max Length
        150
        valueobject
        Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
      - tokenizedCardobject
        TokenizedCreditCard
        cardBankstring
        Example
        Chase
        Description
        Conditional. Credit card's issuing bank
        Max Length
        128
        cardBrandstring
        Example
        VISA
        Description
        Conditional. Credit card's issuer brand
        Max Length
        50
        cardTypestring<CREDIT | DEBIT | PREPAID | UNKNOWN>
        Example
        CREDIT
        Description
        Conditional. Payment card type
        Allowed
        CREDITDEBITPREPAIDUNKNOWN
        countryOfIssuancestring
        Example
        US
        Description
        Conditional.
        Credit card's issuing country, two-letter ISO 3166-1 alpha-2 country code
        Max Length
        2
        Pattern
        [A-Za-z]{2}
        creationTimenumber
        Example
        1430997968
        Description
        Time the card was tokenized by the merchant in seconds since unix epoch (UTC, Jan 1, 1970)
        creditCardCorrelationIdstring
        Description
        Conditional.
        Credit card - CorrelationId that was recieved by the init 3DS API
        expirationMonthstring
        Example
        03
        Description
        Credit card's expiration month, in MM format
        Max Length
        2
        Pattern
        [0-9]{2}
        expirationYearstring
        Example
        2018
        Description
        Credit card's expiration year, in YYYY format
        Max Length
        4
        Pattern
        [0-9]{4}
        fullResponsePayloadobject
        GeneralPayloadMap
        lastFourDigitsstring
        Example
        4242
        Description
        Credit card's last 4 digits
        Max Length
        4
        Pattern
        [0-9]{2,4}
        nameOnCardstring
        Example
        John R. H. Smith
        Description
        Cardholder's full name
        Max Length
        75
        paymentProcessorDataobject
        PaymentProcessorData
        processorNamestring
        Example
        Chase Paymentech
        Description
        Conditional. Payment processor name
        Max Length
        50
        processorTransactionIdstring
        Example
        fjdsS46sdklFd20
        Description
        Conditional.
        Unique transaction identifier (sent by processor)
        Max Length
        50
        threeDSecureobject
        ThreeDSecureInput
        acquirerDataobject
        AcquirerData
        acquirerBINstring
        Example
        457173
        Description
        Conditional.
        Bank acquirer BIN (Bank Identification Number)
        Max Length
        12
        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>
        Example
        US
        Description
        Acquirer country
        Allowed
        AFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCMCACVKYCFTDCLCNCXCCCOKMCGCKCRHRCUCYCZDKDJDMDOTPECEGSVGQEREEETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKWKGLALVLBLSLRLYLILTLUMOMKMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLANNCNZNINENGNUNFKPGBMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWSHKNLCPMVCWSSMSTSASNRSSCSLSGSKSISBSOZAGSKRSSESLKSDSRSJSZSECHSYTJTZTHCDTLTGTKTOTTTNTRTMTCTVUGUAAEUSUMUYUZVUVEVNVGVIWFEHYEYUZMZW
        acquirerMerchantIdstring
        Example
        5245020244654
        Description
        Conditional.
        Merchant ID (MID) - merchant ID is a unique code provided to merchants by their payment processor
        Max Length
        30
        acquirerMerchantNamestring
        Example
        Simple T-shirt
        Description
        Merchant Name as appearing in processor records
        Max Length
        100
        acquirerNamestring
        Example
        Barclays
        Description
        Bank acquirer Name
        Max Length
        50
        merchantCategoryCodenumber
        Example
        5655
        Description
        Conditional.
        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.
        Max Length
        4
        merchantCountryCodenumber
        Example
        840
        Description
        Conditional. Merchant country code
        Max Length
        3
        challengeIndicatorstring<NO_PREFERENCE | NO_CHALLENGE | CHALLENGE | CHALLENGE_AS_MANDATE>
        Example
        NO_PREFERENCE
        Description
        Request your preference regarding the executing of 3DS challange regardless of Forter's decision and recommendation
        Allowed
        NO_PREFERENCENO_CHALLENGECHALLENGECHALLENGE_AS_MANDATE
        execute3dsstring<FORCE_3DS | NOT_SUPPORTED_BY_MERCHANT | DYNAMIC_FORTER_DECISION>
        Example
        DYNAMIC_FORTER_DECISION
        Description
        Request your preference regarding the execution of 3DS
        Allowed
        FORCE_3DSNOT_SUPPORTED_BY_MERCHANTDYNAMIC_FORTER_DECISION
        forcePsd2Exemptionobject
        ThreeDSecureForcePsd2Exemption
        channelstring<THREEDS_RAILS | AUTHORIZATION>required
        Example
        THREEDS_RAILS
        Description
        The channel through which the exemption is requested
        Allowed
        THREEDS_RAILSAUTHORIZATION
        typestring<LOW_VALUE | TRANSACTION_RISK_ANALYSIS | SECURE_CORPORATE | TRUSTED_BENEFICIARY>required
        Example
        LOW_VALUE
        Description
        The type of exemption requested
        Allowed
        LOW_VALUETRANSACTION_RISK_ANALYSISSECURE_CORPORATETRUSTED_BENEFICIARY
        requestChallengeboolean
        Description
        Indicates if a 3DS challenge should be requested from the Issuer ACS.
        threeDSServerTransIDstringrequired
        Example
        26d648a9-da8a-4f8b-a76d-094801d2fd45
        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
        Max Length
        100
        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
        Allowed
        FORTERMERCHANT
        tokenstring
        Example
        tkn-77620C360132856A103477D2959967AB
        Description
        Credit card token used by the merchant
        Max Length
        200
        tokenTypestring<PSP | EMV_PAYMENT_TOKEN | MERCHANT_GENERATED | FORTER_TOKEN | OTHER>
        Description
        Token type, determined by the party/protocol the token created by
        Allowed
        PSPEMV_PAYMENT_TOKENMERCHANT_GENERATEDFORTER_TOKENOTHER
        Max Length
        128
        verificationResultsobject
        CreditCardVerification
        authorizationCodestring
        Example
        A33244
        Description
        Conditional. Card authorization code from payment gateway
        Max Length
        255
        authorizationProcessedWith3DSboolean
        Example
        true
        Description
        3DSecure - indicating that the 3DS results were sent to processor and have been used during the authorization
        avsFullResultstring
        Example
        Y
        Description
        Conditional.
        Procesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
        Max Length
        50
        avsNameResultstring
        Example
        M
        Description
        Conditional.
        Name portion of card's AVS result (when available)
        Max Length
        30
        avsStreetResultstring
        Example
        N
        Description
        Conditional. Street address portion of card's AVS result
        Max Length
        30
        avsZipResultstring
        Example
        M
        Description
        Conditional. Zipcode portion of card's AVS result
        Max Length
        30
        cavvResultstring
        Example
        VYboNwcsB3F9gTIsbaUjvEuLW0o=
        Description
        Conditional.
        3DSecure - Authentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
        Max Length
        50
        cvvResultstring
        Example
        M
        Description
        Conditional.
        CVV result (if no data please send the value U)
        Max Length
        30
        eciValuestring
        Example
        05
        Description
        Conditional.
        3DSecure - ECI value recieved from authorization/authentication response
        Max Length
        2
        exemptionStatusstring
        Example
        accepted
        Description
        Conditional. Exemption status as received from the processor
        Max Length
        100
        external3dsVendorPayloadobject
        GeneralPayloadMap
        issuerResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from issuer
        Max Length
        50
        issuerResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from issuer
        Max Length
        255
        liabilityShiftboolean
        Example
        true
        Description
        Conditional.
        3DSecure - liability shift - indicate whether the chargeback liability shifted to the card issuer
        partyExecuted3DSstring<PSP | FORTER | BOTH>
        Example
        PSP
        Description
        3DSecure - Party executed the 3DS authentication
        Allowed
        PSPFORTERBOTH
        processorResponseCodestring
        Example
        D23
        Description
        Conditional. Response code received from processor
        Max Length
        50
        processorResponseTextstring
        Example
        Stolen card
        Description
        Conditional. Response text received from processor
        Max Length
        255
        threeDsInteractionModestring<FRICTIONLESS | CHALLENGED>
        Example
        FRICTIONLESS
        Description
        Conditional.
        3DSecure - Indication of the friction that the user experienced
        Allowed
        FRICTIONLESSCHALLENGED
        threeDsStatusstring
        Example
        Cardholder authenticated
        Description
        Conditional.
        3DSecure - Status text received from 3D secure vendor
        Max Length
        100
        threeDsVersionstring
        Example
        2.1.0
        Description
        Conditional.
        3DSecure - Version used in the transaction
        Max Length
        5
      - venmoobject
        Venmo
        fullVenmoResponsePayloadGeneralPayloadMaprequired
        Description
        Full Venmo response object
        paymentIdstring
        Example
        1KZSDEYA
        Description
        Conditional. Venmo payment ID
        Max Length
        50
        tokenstringrequired
        Example
        77620C360132856A103477D2959967AB
        Description
        Token representing the specific payment method used within the Venmo vault
        Max Length
        200
        userIdstringrequired
        Example
        johndoe
        Description
        Venmo userID
        Max Length
        50
        userNamestringrequired
        Example
        johndoe1987
        Description
        Venmo user name
        Max Length
        50
    - phonesInAccountPhone[]
      Description
      Conditional. All phone numbers saved in account
      - phonestringrequired
        Example
        15557654321
        Description
        Phone number including all country and local access codes
        Max Length
        25
      - smsVerifiedVerificationrequired
        Description
        Phone verification details
        sentbooleanrequired
        Example
        true
        Description
        True if verification email was sent to email address or verification SMS was sent to phone number
        timeSentnumber
        Example
        1389567341
        Description
        Date verification email or SMS was sent in seconds since unix epoch (UTC, Jan 1, 1970)
        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)
    - ratingAsBuyerobject
      - Rating
        scorestringrequired
        Example
        4.5
        Description
        Rating score (numeric - 97 or textual - 'Excellent')
        Max Length
        25
        sourcestringrequired
        Example
        yelp
        Description
        Source of rating, for example tripAdvisor, yelp, etc.
        Max Length
        50
        typestring<INTERNAL_PEERS | INTERNAL_MERCHANT | EXTERNAL_PEERS | EXTERNAL_INDEPENDENT>required
        Example
        INTERNAL_PEERS
        Description
        Rating type. Internal if rating was generated within the merchant's site or community, otherwise external.
        Allowed
        INTERNAL_PEERSINTERNAL_MERCHANTEXTERNAL_PEERSEXTERNAL_INDEPENDENT
    - registrationIPstring
      Example
      203.12.55.12
      Description
      IP address used by the account owner at the time of registration.
    - typestring<GUEST | PRIVATE | BUSINESS | VIP | MERCHANT_OPERATED | TRIAL | MERCHANT_EMPLOYEE | PREMIUM_PAID | SMALL_BUSINESS | AGENT | BUSINESS_PRIVATE | BUSINESS_PREMIUM_PAID>
      Example
      BUSINESS
      Description
      Conditional.
      Account type (a business account, a private account, a merchant-operated account)
      Allowed
      GUESTPRIVATEBUSINESSVIPMERCHANT_OPERATEDTRIALMERCHANT_EMPLOYEEPREMIUM_PAIDSMALL_BUSINESSAGENTBUSINESS_PRIVATEBUSINESS_PREMIUM_PAID
- accountIdstringrequired
  Example
  e520-ba9a-367-60b
  Description
  Customer's account UID in merchant's site. Should not be the user email. If no account ID is available send NO_ACCOUNT_ID
  Max Length
  50
- 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>
  Example
  WEB
  Description
  Conditional. The source channel through which the customer conducted the signup. Note that some of the enum values are not relevant for this interaction.
  Allowed
  WEBPHONEDYNAMIC_PHONEMOBILEMOBILE_IN_STOREIOSANDROIDWAPSTOREMERCHANT_EMPLOYEEMAIL_ORDERAUTOMATIC_RENEWAL_OR_INSTALLMENT_PAYMENTMERCHANT_INITIATEDUNKNOWNPOSAPI_ONLYPERSONAL_POSPHONE_LINK
- connectionInformationConnectionInformationrequired
  Description
  Connection information about the customer typically found in the HTTP request header.
  - checkoutToolsSessionIdstring
    Example
    HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
    Description
    CheckoutToolsSessionId received from the SDK
    Max Length
    128
  - customerIPstringrequired
    Example
    10.0.0.127
    Description
    Customer IP address in IPv4 or IPv6 format. If missing should be populated with 127.0.0.1
  - forterMobileUIDstring
    Example
    6429751237891
    Description
    Conditional.
    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)
    Max Length
    128
  - forterTokenCookiestring
    Example
    249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg
    Description
    Conditional. Forter token cookie from request headers
    Max Length
    128
  - merchantDeviceIdentifierstring
    Example
    HGJ7512345H3
    Description
    Conditional. A unique device identifier generated by merchant
    Max Length
    100
  - merchantProvidedSessionIdstring
    Example
    HTGDVC232fdFDFdfkdjk87382938mcndjc2f4gbbGd
    Description
    An identifier of the merchant session
    Max Length
    128
  - userAgentstringrequired
    Example
    Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36
    Description
    Customer's User agent
    Max Length
    4096
- customerSignedInUsingSocialNetworkAccountobject
  - CustomerRegistrationSources
    - facebookboolean
      Description
      Facebook
      Max Length
      50
    - googleboolean
      Description
      Google
      Max Length
      50
    - linkedinboolean
      Description
      LinkedIn
      Max Length
      50
    - otherSocialNetworkstring
      Example
      VK
      Description
      Other Social Network
      Max Length
      50
    - paypalboolean
      Description
      PayPal
      Max Length
      50
    - twitterboolean
      Description
      Twitter
      Max Length
      50
- eventTimenumberrequired
  Example
  1415287568000
  Description
  The time that the trigger event occurred in MILLISECONDS since unix epoch (Jan 1, 1970)
- merchantIdentifiersobject
  - MerchantIdentifiers
    - merchantDomainstring
      Example
      HandbagsExpressDiscounts.com
      Description
      Use if merchant operates several sites (such as a regular site and a related discount brand)
      Max Length
      2048
    - merchantNamestring
      Example
      Handbags Express Discounts
      Description
      Use if merchant operates several sites (such as a regular site and a related discount brand)
      Max Length
      50
- promotionsobject
  - Discount
    - couponCodeUsedstringrequired
      Example
      FATHERSDAY2015
      Description
      Coupon code used
      Max Length
      150
    - couponDiscountAmountobject
      - Amount
        amountLocalCurrencystring
        Example
        105.55
        Description
        Conditional. Transaction amount in currency chosen by the buyer
        Max Length
        20
        amountUSDstring
        Example
        99.95
        Description
        Conditional. Transaction amount in USD
        Max Length
        12
        currencystring
        Example
        CAD
        Description
        Conditional.
        Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code
        Max Length
        3
        Pattern
        [A-Z]{3}
    - couponDiscountPercentstring
      Description
      Coupon discount amount
- signupStatusstring<SUCCESS | FAILED | BLOCKED_BY_MERCHANT>
  Example
  SUCCESS
  Description
  The status of the Signup attempt
  Allowed
  SUCCESSFAILEDBLOCKED_BY_MERCHANT

Responses

200Example adaptiveAuthAccountsResponse

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

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)

curl

curl --request POST \
     --url https://api.forter-secure.com/v2/accounts/signup/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.3' \
     --header 'x-forter-siteid: a1b2c3d4e5f6' \
     --data-raw '{
     "accountData": {
     "additionalVerificationDocuments": {
     "documentSource": "UPLOADED_FILE",
     "documentType": "Passport",
     "documentVerificationServiceResponsePayload": {}
     },
     "addressesInAccount": [
     {
     "address1": "235 Montgomery st.",
     "city": "San Francisco",
     "country": "US",
     "savedData": {
     "usedSavedData": true
     }
     }
     ],
     "customerEngagement": {
     "communityPostsWritten": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "invites": [
     {
     "type": "SENT"
     }
     ],
     "likedItems": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "messagesReceived": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "messagesSent": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "newsletters": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "reviewsWritten": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "savedLocations": [
     {
     "latitude": 32.07332,
     "longitude": 34.79675,
     "source": "MOBILE"
     }
     ],
     "sharedItems": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     },
     "wishlist": {
     "updateTimes": {
     "creationTime": 1448549922
     }
     }
     },
     "emailsInAccount": [
     {
     "email": "[email protected]",
     "emailVerification": {
     "sent": true,
     "verified": false
     }
     }
     ],
     "phonesInAccount": [
     {
     "phone": "15557654321",
     "smsVerified": {
     "sent": true,
     "verified": false
     }
     }
     ],
     "ratingAsBuyer": {
     "score": "4.5",
     "source": "yelp",
     "type": "INTERNAL_PEERS"
     }
     },
     "accountId": "e520-ba9a-367-60b",
     "additionalAccountEventIdentifiers": {},
     "additionalInformation": {},
     "connectionInformation": {
     "customerIP": "10.0.0.127",
     "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
     },
     "customerSignedInUsingSocialNetworkAccount": {},
     "eventTime": 1415287568000,
     "merchantIdentifiers": {},
     "promotions": {
     "couponCodeUsed": "FATHERSDAY2015",
     "couponDiscountAmount": {}
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.3");
myHeaders.append("x-forter-siteid", "a1b2c3d4e5f6");

var raw = JSON.stringify({
   "accountData": {
      "additionalVerificationDocuments": {
         "documentSource": "UPLOADED_FILE",
         "documentType": "Passport",
         "documentVerificationServiceResponsePayload": {}
      },
      "addressesInAccount": [
         {
            "address1": "235 Montgomery st.",
            "city": "San Francisco",
            "country": "US",
            "savedData": {
               "usedSavedData": true
            }
         }
      ],
      "customerEngagement": {
         "communityPostsWritten": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "invites": [
            {
               "type": "SENT"
            }
         ],
         "likedItems": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "messagesReceived": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "messagesSent": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "newsletters": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "reviewsWritten": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "savedLocations": [
            {
               "latitude": 32.07332,
               "longitude": 34.79675,
               "source": "MOBILE"
            }
         ],
         "sharedItems": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "wishlist": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         }
      },
      "emailsInAccount": [
         {
            "email": "[email protected]",
            "emailVerification": {
               "sent": true,
               "verified": false
            }
         }
      ],
      "phonesInAccount": [
         {
            "phone": "15557654321",
            "smsVerified": {
               "sent": true,
               "verified": false
            }
         }
      ],
      "ratingAsBuyer": {
         "score": "4.5",
         "source": "yelp",
         "type": "INTERNAL_PEERS"
      }
   },
   "accountId": "e520-ba9a-367-60b",
   "additionalAccountEventIdentifiers": {},
   "additionalInformation": {},
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "customerSignedInUsingSocialNetworkAccount": {},
   "eventTime": 1415287568000,
   "merchantIdentifiers": {},
   "promotions": {
      "couponCodeUsed": "FATHERSDAY2015",
      "couponDiscountAmount": {}
   }
});

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

fetch("https://api.forter-secure.com/v2/accounts/signup/{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/signup/{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.3"
request["x-forter-siteid"] = "a1b2c3d4e5f6"
request.body = JSON.dump({
   "accountData": {
      "additionalVerificationDocuments": {
         "documentSource": "UPLOADED_FILE",
         "documentType": "Passport",
         "documentVerificationServiceResponsePayload": {}
      },
      "addressesInAccount": [
         {
            "address1": "235 Montgomery st.",
            "city": "San Francisco",
            "country": "US",
            "savedData": {
               "usedSavedData": true
            }
         }
      ],
      "customerEngagement": {
         "communityPostsWritten": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "invites": [
            {
               "type": "SENT"
            }
         ],
         "likedItems": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "messagesReceived": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "messagesSent": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "newsletters": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "reviewsWritten": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "savedLocations": [
            {
               "latitude": 32.07332,
               "longitude": 34.79675,
               "source": "MOBILE"
            }
         ],
         "sharedItems": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "wishlist": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         }
      },
      "emailsInAccount": [
         {
            "email": "[email protected]",
            "emailVerification": {
               "sent": true,
               "verified": false
            }
         }
      ],
      "phonesInAccount": [
         {
            "phone": "15557654321",
            "smsVerified": {
               "sent": true,
               "verified": false
            }
         }
      ],
      "ratingAsBuyer": {
         "score": "4.5",
         "source": "yelp",
         "type": "INTERNAL_PEERS"
      }
   },
   "accountId": "e520-ba9a-367-60b",
   "additionalAccountEventIdentifiers": {},
   "additionalInformation": {},
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "customerSignedInUsingSocialNetworkAccount": {},
   "eventTime": 1415287568000,
   "merchantIdentifiers": {},
   "promotions": {
      "couponCodeUsed": "FATHERSDAY2015",
      "couponDiscountAmount": {}
   }
})

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

python

import requests
import json

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

payload = json.dumps({
   "accountData": {
      "additionalVerificationDocuments": {
         "documentSource": "UPLOADED_FILE",
         "documentType": "Passport",
         "documentVerificationServiceResponsePayload": {}
      },
      "addressesInAccount": [
         {
            "address1": "235 Montgomery st.",
            "city": "San Francisco",
            "country": "US",
            "savedData": {
               "usedSavedData": True
            }
         }
      ],
      "customerEngagement": {
         "communityPostsWritten": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "invites": [
            {
               "type": "SENT"
            }
         ],
         "likedItems": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "messagesReceived": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "messagesSent": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "newsletters": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "reviewsWritten": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "savedLocations": [
            {
               "latitude": 32.07332,
               "longitude": 34.79675,
               "source": "MOBILE"
            }
         ],
         "sharedItems": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         },
         "wishlist": {
            "updateTimes": {
               "creationTime": 1448549922
            }
         }
      },
      "emailsInAccount": [
         {
            "email": "[email protected]",
            "emailVerification": {
               "sent": True,
               "verified": False
            }
         }
      ],
      "phonesInAccount": [
         {
            "phone": "15557654321",
            "smsVerified": {
               "sent": True,
               "verified": False
            }
         }
      ],
      "ratingAsBuyer": {
         "score": "4.5",
         "source": "yelp",
         "type": "INTERNAL_PEERS"
      }
   },
   "accountId": "e520-ba9a-367-60b",
   "additionalAccountEventIdentifiers": {},
   "additionalInformation": {},
   "connectionInformation": {
      "customerIP": "10.0.0.127",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.73 Safari/537.36"
   },
   "customerSignedInUsingSocialNetworkAccount": {},
   "eventTime": 1415287568000,
   "merchantIdentifiers": {},
   "promotions": {
      "couponCodeUsed": "FATHERSDAY2015",
      "couponDiscountAmount": {}
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.3',
   'x-forter-siteid': 'a1b2c3d4e5f6'
}

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

print(response.text)

200

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

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)