Modify Partner Secret

PUT /aggregation/v2/partners/authentication

Change the partner secret that is used to authenticate this partner. The secret does not expire, but can be changed by calling Modify Partner Secret. A valid partner secret may contain upper- and lowercase characters, numbers, and the characters !, @, #, $, %, &, *, _, -, +. It must include at least one number and at least one letter, and its length should be between 12 and 255 characters.

JSON Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Content-Type HTTP Header application/json
partnerId JSON Field Partner ID from Developer Portal
partnerSecret JSON Field Current value of Partner Secret from Developer Portal
newPartnerSecret JSON Field The new value for Partner Secret

Success: HTTP 204 (No Content)

Example Request:

PUT https://api.finicity.com/aggregation/v2/partners/authentication
{
  "partnerId": "PARTNER_ID",
  "partnerSecret": "PARTNER_SECRET",
  "newPartnerSecret": "NEW_PARTNER_SECRET"
}

Using Curl:

curl -v -H "Finicity-App-Key:APP_KEY" -H "Content-Type:application/json" -H "Accept:application/json" -X PUT "https://api.finicity.com/aggregation/v2/partners/authentication""" -d '{ "partnerId": "PARTNER_ID", "partnerSecret": "PARTNER_SECRET", "newPartnerSecret": "NEW_PARTNER_SECRET" }'

XML Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Content-Type HTTP Header application/json
partnerId XML Element Partner ID from Developer Portal
partnerSecret  XML Element Current value of Partner Secret from Developer Portal
newPartnerSecret  XML Element The new value for Partner Secret

Success: HTTP 204 (No Content)

Example Request:

PUT https://api.finicity.com/aggregation/v2/partners/authentication
<credentials>
  <partnerId>PARTNER_ID</partnerId>
  <partnerSecret>PARTNER_SECRET</partnerSecret>
  <newPartnerSecret>NEW_PARTNER_SECRET</newPartnerSecret>
</credentials>

Using Curl:

curl -v -H "Finicity-App-Key:APP_KEY" -H "Content-Type:application/xml" -H "Accept:application/xml" -X PUT "https://api.finicity.com/aggregation/v2/partners/authentication""" -d '<credentials> <partnerId>PARTNER_ID</partnerId> <partnerSecret>PARTNER_SECRET</partnerSecret> <newPartnerSecret>NEW_PARTNER_SECRET</newPartnerSecret> </credentials>'