HR API

Atriis offers an HR API supporting profile information synchronization between third-party solutions and Atriis. The third-party provider will need to send over an API call on individual or bulk profiles to be updated in Atriis.

In addition, every profile creation/update on Atriis will be available in the API request for the third-party provider to pull.

This page includes the most recent information and documentation of the HR API file. In the attachments, you will find:

• PDF document detailing the flow
• Excel sheet with detailed documentation of the hr response (equivalent to HRUpdate request)
• Sample JSON file for reference

Set-Up

Atriis implementation fee: consult your Order Form or the Extended Services List. Alternatively, you can contact your Customer Success Manager, who will confirm the pricing.

To kick off the connection, please follow the steps below:

1. Sign-up to Atriis Developer Portal to generate APIKEY to our API. Atriis will instruct you if you will develop towards our production or staging site. If you develop towards production, then register on this link: https://gtp.developer.azure-api.net/signup. If you are developing towards staging, then register on this link: https://tmc2staging.azure-api.net/Authorize.
2. Review the attached documents with setup instructions and API documentation.
3. After we have accomplished the above steps, we will start the development process.

Please consult our dedicated FAQ on HR API - FAQ

Targeted Profile ID Update Endpoint

In addition to the full-profile send, Atriis offers a dedicated endpoint that updates only the GDS Locator Profile ID fields on existing profiles. Use this endpoint when your migration or HR extract needs to change these identifiers without resending — and risking overwriting — every other field on the profile.

The endpoint updates these fields only:

• Business Profile
• Personal Profile
• Office ID

No other profile data is read or modified by this endpoint.

How Matching and Overwriting Work

• Each entry is matched to an existing profile by Username only. The Username must belong to your own corporate account; a Username that belongs to a different corporate account fails validation and updates nothing.
• The new profile ID values fully replace the existing values. They are not appended to or merged with what is already on the profile.
• You can optionally include the old Business Profile, Personal Profile, and Office ID values in the request. These old values are not validated against what’s currently on the profile — they are accepted whether they match, don’t match, or are left empty.

Request Fields

Each entry in the request includes:

Field	Required	Notes
Username	Yes	Used to match the entry to an existing profile in your corporate account
Old Business Profile / Personal Profile / Office ID	No	Not validated against current profile values
New Business Profile / Personal Profile / Office ID	Yes	Overwrites the corresponding existing value

Batch Processing

• You can submit any number of profile entries in a single request — there is no enforced limit on batch size.
• Atriis processes each entry independently. If one entry fails (for example, because of a missing mandatory field or a Username outside your corporate account), only that entry fails — the rest of the batch continues to process.
• The response reports a success or failure result for every entry, so you can identify and resubmit only the entries that failed.

The existing full-profile send endpoint remains available and works exactly as before. This targeted endpoint is additive and does not replace or change that endpoint’s behavior.

Further Reading

• HR API - FAQ
• Atriis API Services Overview