Core API

Signup

POST

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

Credentials

• HTTP Basic: basicAuth

Path Parameters

• id: string (Required)

Header Parameters

• api-version: string (Required)
• x-forter-siteid: string (Required)

Body Parameters

• body: accountSignupRequest (Required)

Description

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

• accountData: object
  • All Of: AccountData +
  • accountId: string (Required)
  • additionalAccountEventIdentifiers: object
    • All Of: AdditionalAccountEventIdentifiers +
  • additionalInformation: object
    • All Of: GeneralPayloadMap +
  • channelType: string (WEB | PHONE | ...)
    • nullable
  • connectionInformation: ConnectionInformation (Required)
  • customerSignedInUsingSocialNetworkAccount: object
    • All Of: CustomerRegistrationSources +
  • eventTime: number (Required)
  • merchantIdentifiers: object
    • All Of: MerchantIdentifiers +
  • promotions: object
    • All Of: Discount +
  • signupStatus: string (SUCCESS | FAILED | BLOCKED_BY_MERCHANT)
    • nullable

Responses

• 200: Example adaptiveAuthAccountsResponse
• 400: Bad Request (Often missing a required parameter)
• 401: Unauthorized (No valid API key provided)
• 404: Not Found (The requested item doesn't exist)
• 500: Server Error (Something went wrong on Forter's end)

Request

curl --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.1' \
--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": "john_s@test.com",
        "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": {}
  }
}'

Responses

• 200

{
  "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": {}
    }
  }
}