Sona Integration: API keys
To connect your Borderless account to Sona, you need to provide us with your Sona API key. We use it to read your HR data on Sona's platform on your behalf. Treat it like a password - we encrypt it immediately and store it securely.
Obtaining your API key
API keys are generated by Sona, not Borderless. Contact your Sona Customer Success Manager and ask them to create a key for your account with the following scopes:
POST /webhooks/subscriptions
DELETE /webhooks/subscriptions/{id}
GET /users
GET /users/{id}
GET /employment_periods
GET /users/{id}/standard_documents/right_to_work
Scopes are the specific permissions a key carries - these are the ones we need to read your HR data.
Once you have the key, paste it into the Sona connection screen in Borderless. We'll validate it and start importing your employees.
Adding scopes later
As we release new features, we may need additional scopes and will ask you to request an updated key. We'll let you know when that happens.
Related articles
For an overview of what the Sona integration does once connected, see What's new: Sona integration. For the full list of HRIS integrations we support, see Borderless HRIS integrations.