Account status - API Reference

Account status

POST

Try it

Inform of updates to the status of an account. While no decision is provided on this request, it improves the decision model.

Credentials

HTTP Basic basicAuth

Path Parameters

Parameter	Type	Required
id	string	*

Header Parameters

Parameter	Type	Required
api-version	string	*
x-forter-siteid	string	*

Body Parameters

Parameter	Type	Required
body	accountStatusUpdateRequest	*

Description

Inform of updates to the status of an account. While no decision is provided on this request, it improves the decision model.

accountId: string *
additionalInformation: object
- All Of
- GeneralPayloadMap +
connectionInformation: object
- All Of
- ConnectionInformation +
eventTime: number *
merchantAccountStatus: string nullable
merchantIdentifiers: object
- All Of
- MerchantIdentifiers +
status: string <ACTIVE | SUSPENDED | CLOSED | GUEST | PENDING> *
statusChangeBy: string <MERCHANT_ADMIN | END_USER | FORTER> nullable
statusChangeReason: string nullable
type: string <GUEST | PRIVATE | BUSINESS | VIP | MERCHANT_OPERATED | TRIAL | MERCHANT_EMPLOYEE | PREMIUM_PAID | SMALL_BUSINESS | AGENT | BUSINESS_PRIVATE | BUSINESS_PREMIUM_PAID> nullable

Responses

200

Example adaptiveAuthAccountsResponse

{ "accountId": "e520-ba9a-367-60b", "correlationId": "HGJ7512345H3DE", "decisionReason": "", "forterDecision": "<APPROVE | DECLINE | VERIFICATION_REQUIRED | NOT_REVIEWED>", "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)

Request

Curl

curl --request POST \
  --url https://api.forter-secure.com/v2/accounts/status/{id} \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'api-version: 10.1' \
  --header 'x-forter-siteid: a1b2c3d4e5f6' \
  --data '{
    "accountId": "e520-ba9a-367-60b",
    "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"
    },
    "eventTime": 1415287568000,
    "merchantIdentifiers": {},
    "status": "ACTIVE"
}'

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