Partner Authentication

POST /aggregation/v2/partners/authentication

Validate the partner’s credentials (Finicity-App-Key, Partner ID, and Partner Secret) and return a temporary access token. The token must be passed in the HTTP header Finicity-App-Token on all subsequent API requests.

The token is valid for two hours. You can have multiple active tokens at the same time.

Five unsuccessful authentication attempts will cause the partner’s account to be locked. To unlock the account, send an email to support@finicity.com

JSON Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Content-Type HTTP Header application/json
Accept HTTP Header application/json
partnerId JSON Field Partner ID from Developer Portal
partnerSecret JSON Field Partner Secret from Developer Portal

Success: HTTP 200 (OK)

Example Request:

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

Using Curl:

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

Request Details:

Field Name Description
token A temporary access token, which must be passed in the HTTP header Finicity-App-Token on all subsequent API requests (see Accessing the API).

Example Response:

{
  "token": "ACCESS_TOKEN"
}

XML Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Content-Type HTTP Header application/json
Accept HTTP Header application/json
credentials XML element Root Element
partnerId XML element Partner ID from Developer Portal
partnerSecret XML element Partner Secret from Developer Portal

Success: HTTP 200 (OK)

Example Request:

POST https://api.finicity.com/aggregation/v2/partners/authentication
<pre><credentials> 
	<partnerId>PARTNER_ID<partnerId> 
	<partnerSecret>PARTNER_SECRET<partnerSecret> 
<credentials></pre>

Using Curl:

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

Request Details:

Field Name Description
access Root element
token A temporary access token, which must be passed in the HTTP header Finicity-App-Token on all subsequent API requests (see Accessing the API).

Example Response:

<access>
  <token>ACCESS_TOKEN</token>
</access>