Changelog

New tables defining column types of reporting fields are indexed within the Standard Reports guide. The SFTP Setup guide is now more comprehensive and clear.

Use the sample EmployeeID values in the description of Get Employee Wallet to generate corresponding test responses.

The Guides section now starts with a Developer Overview, detailing and linking the features and requirements for integrating with Branch. Many new guides are now available to explain the streamlined onboarding process. Older guides have been updated with less complexity and better generalization, recontextualized to tell part of a larger story.

Below the table of contents on each guide, a new Markdown dropdown provides access to view or copy the Markdown source of the page.

The term "Employee" in V1 API was changed to "Worker" in V2 API. A new guide is available for understanding Worker and Employee Compatibility when viewing guides and API reference endpoints.

A new guide for Application Security when integrating with Branch Direct Embedded is now available. Ensuring the security of your application is critical, as this provides access to worker banking and financial information.

For API endpoints in certain categories that don't reference employee_id in their request/response structures, the default URL structure has been adjusted from /employees/{employeeId} to /workers/{workerId}. These categories include:

There is now a limit of 100 retry attempts per request to the Create Disbursement endpoint. Once this limit is reached, any additional retry attempts will return a 200 response with status: SKIPPED and reason_code: RETRY_LIMIT_EXCEEDED.

Paste your Sandbox API key in the Credentials field to use it across multiple endpoints without needing re-entry. Learn more about using this in the API Reference Intro guide.