Authentication

To access Affinity APIs, it is required that our partners' IP addresses are whitelisted (maximum of 3). In addition to the whitelisted IP addresses, all endpoints need to be authenticated using an API token generated from our partner portal.

You can register on our developer portal here

Sample request

curl --request GET \
  --url https://open-orion.affnty.co/api/v1/accounts/{accountNumber}/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: 1245'

Developer portal requirements

	Requirement	Description
1.	Webhook Url	A URL that we can send notifications to when events occur on an account. More on that here.
2.	IP addresses	A maximum of 3 IPs can be added to be whitelisted. The IP addresses are expected to be to be a /32 address. This is subject to change. Addresses such as 0.0.0.0/0 will be rejected.

API keys

An API key generated is valid for 12 months. It is important to keep this key safe, as it will grant access to anyone in its possession. Affinity will send reminders about the key's expiration.

Last modified: 27 August 2025