Configure a Finix Risk Profile

Finix’s Risk Profile contains all the information related to the risk rules you can set. Each Merchant has a Merchant Profile and each MerchantProfile has a Risk Profile which is where the option to enable AVS lives.

Any modifications to a Risk Profile can be accomplished through a PUT request.

Let’s review the API path to RiskProfile starting with Merchant ID (MUxxx). 

1. Retrieve Merchant Profile (MPxxx) using a Merchant ID (MUxxx)

## Request
curl https://finix.sandbox-payments-api.com/merchants/MUsDAChQcLnYmkzKc3xJ8Pek \
    -H "Content-Type: application/vnd.json+api" \
    -u  USuJESezDxCrDtkDjLUxTJP1:347e1349-92b3-405a-bd3a-ecd9beb36ab4

 
## Response
{
  "id" : "MUsDAChQcLnYmkzKc3xJ8Pek",
  "application" : "APiwqrQ7wxQQ6AgJtKz8ibC7",
  "identity" : "IDrE9ezGKCZhFN7NCigZ3TbC",
  "verification" : "VIdrK7hbHJUmbnSnMDSCU6N4",
  "merchant_profile" : "MP7WTJztnvp3sCFQkJfhkm3a",
  "processor" : "DUMMY_V1",
  "processing_enabled" : true,
  "settlement_enabled" : true,
  "gross_settlement_enabled" : false,
  "creating_transfer_from_report_enabled" : false,
  "tags" : {
    "key_2" : "value_2"
  },
  "mcc" : "0742",
  "mid" : null,
  "merchant_name" : "Lees Sandwiches",
  "created_at" : "2019-12-17T19:54:06.30Z",
  "updated_at" : "2019-12-17T19:54:06.57Z",
  "onboarding_state" : "APPROVED",
  "processor_details" : {
    "api_key" : "secretValue"
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/merchants/MUsDAChQcLnYmkzKc3xJ8Pek"
    },
    "identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDrE9ezGKCZhFN7NCigZ3TbC"
    },
    "verifications" : {
      "href" : "https://finix.sandbox-payments-api.com/merchants/MUsDAChQcLnYmkzKc3xJ8Pek/verifications"
    },
    "merchant_profile" : {
      "href" : "https://finix.sandbox-payments-api.com/merchant_profiles/MP7WTJztnvp3sCFQkJfhkm3a"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APiwqrQ7wxQQ6AgJtKz8ibC7"
    },
    "verification" : {
      "href" : "https://finix.sandbox-payments-api.com/verifications/VIdrK7hbHJUmbnSnMDSCU6N4"
    }
  }
}

2. Retrieve Risk Profile using Merchant Profile (MPxxx)

## Request
curl https://finix.sandbox-payments-api.com/merchant_profiles/MP7WTJztnvp3sCFQkJfhkm3a \
    -H "Content-Type: application/vnd.json+api" \
    -u  USuJESezDxCrDtkDjLUxTJP1:347e1349-92b3-405a-bd3a-ecd9beb36ab4

## Response
{
  "id" : "MP7WTJztnvp3sCFQkJfhkm3a",
  "tags" : { },
  "application" : "APiwqrQ7wxQQ6AgJtKz8ibC7",
  "fee_profile" : "FPrbpM1NygfU8nYMK2m1VVQN",
  "risk_profile" : "RPkcdc46vHiKrKvF5AfcUp5v",
  "created_at" : "2019-12-17T19:54:06.29Z",
  "updated_at" : "2019-12-17T19:56:02.06Z",
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/merchant_profiles/MP7WTJztnvp3sCFQkJfhkm3a"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APiwqrQ7wxQQ6AgJtKz8ibC7"
    },
    "risk_profile" : {
      "href" : "https://finix.sandbox-payments-api.com/risk_profiles/RPkcdc46vHiKrKvF5AfcUp5v"
    },
    "fee_profile" : {
      "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPrbpM1NygfU8nYMK2m1VVQN"
    }
  }
}

3. Using the Risk Profile, update the avs_failure_allowed to be true or false

## GET Request
curl https://finix.sandbox-payments-api.com/risk_profiles/RPkcdc46vHiKrKvF5AfcUp5v \
    -H "Content-Type: application/vnd.json+api" \
    -u  USuJESezDxCrDtkDjLUxTJP1:347e1349-92b3-405a-bd3a-ecd9beb36ab4 
  
## Response
{
  "id" : "RP7xmY5rTFReYp6FYgrErh6u",
  "tags" : { },
  "application" : "APwQ7AAsVwBEiDsydGqRiuK3",
  "avs_failure_allowed" : false,
  "csc_failure_allowed" : false,
  "created_at" : "2019-10-08T22:23:38.14Z",
  "updated_at" : "2019-10-08T22:23:37.86Z",
  "_links" : {
    "self" : {
      "href" : "https://finix.qa-payments-api.com/risk_profiles/RP7xmY5rTFReYp6FYgrErh6u"
    },
    "application" : {
      "href" : "https://finix.qa-payments-api.com/applications/APwQ7AAsVwBEiDsydGqRiuK3"
    },
    "rules" : {
      "href" : "https://finix.qa-payments-api.com/risk_profiles/RP7xmY5rTFReYp6FYgrErh6u/rules"
    }
  }
}

## PUT Request (ROLE_PLATFROM Keys Only)
curl https://finix.sandbox-payments-api.com/risk_profiles/RPkcdc46vHiKrKvF5AfcUp5v \
    -H "Content-Type: application/vnd.json+api" \
    -u  "USxxx" \
    -X PUT \
    -d '
    {
      "avs_failure_allowed": true
    }'


## Response
{
 "id" : "RPkcdc46vHiKrKvF5AfcUp5v",
 "tags" : { },
 "application" : "APiwqrQ7wxQQ6AgJtKz8ibC7",
 "avs_failure_allowed" : true,
 "csc_failure_allowed" : false,
 "created_at" : "2019-12-17T19:56:01.93Z",
 "updated_at" : "2019-12-20T22:45:58.76Z",
 "_links" : {
 "self" : {
 "href" : "https://finix.sandbox-payments-api.com/risk_profiles/RPkcdc46vHiKrKvF5AfcUp5v"
 },
 "application" : {
 "href" : "https://finix.sandbox-payments-api.com/applications/APiwqrQ7wxQQ6AgJtKz8ibC7"
 },
 "rules" : {
 "href" : "https://finix.sandbox-payments-api.com/risk_profiles/RPkcdc46vHiKrKvF5AfcUp5v/rules"
 }
 }
}

4. To modify the Address Verification System, simply set ‘avs_failure_allowed' = true.