Ansible Labs

Quick start

How it works

Making API requests

Sandbox

Overview

Beam Link

Libraries

Webhooks

Authentication

Registrations

Events

Reference

API versioning

Postman Collection

Default

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Beam Link is the client-side component that your users will interact with in order to link their beam accounts to your systems and allow you to access their accounts via the Beam API.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Beam Link flow overview</h3><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">The diagram below shows a model of how Beam Link is used to obtain a <code class="slate-code">public_token</code>, which will then be exchanged for an <code class="slate-code">access_token</code>, which is used to authenticate requests to the Beam API.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">&lt;insert diagram&gt;</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Initializing Beam Link</h3><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Link is initialized by passing the <code class="slate-code">link_token</code> to Beam Link.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Beam Link updates</h3><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Ansible periodically updates Beam Link to add new functionality and improve conversion. These changes will be automatically deployed. Any test suites and business logic in your app should be robust to the possibility of changes to the user-facing Beam Link flow.</p>

Beam Link is the client-side component that your users will interact with in order to link their beam accounts to your systems and allow you to access their accounts via the Beam API.

The diagram below shows a model of how Beam Link is used to obtain a 

, which is used to authenticate requests to the Beam API.

Ansible periodically updates Beam Link to add new functionality and improve conversion. These changes will be automatically deployed. Any test suites and business logic in your app should be robust to the possibility of changes to the user-facing Beam Link flow.

<p class="slate-p" placeholder="Type / for widgets"></p><h4 class="slate-h4">Comprehensive reference for integrating with Beam API endpoints</h4><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Beams API endpoints and schemas are listed below. If you are looking for reference information about client-side integrations on web, see the <a href="https://plaid.com/docs/link/" target="_blank">Link docs</a>.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><h4 class="slate-h4">Accounts</h4><p class="slate-p" placeholder="Type / for widgets">Retrieving and updating user accounts</p><p class="slate-p" placeholder="Type / for widgets"></p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Path</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Notes</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">GET <code class="slate-code">/accounts/${accountId}</code></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Will return a single user account by id</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">GET <code class="slate-code">/accounts/${accountId}/deposits</code></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Will return all deposits for a single user</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h4 class="slate-h4">Deposits</h4><p class="slate-p" placeholder="Type / for widgets">Retrieving and updating deposits associated with your users</p><p class="slate-p" placeholder="Type / for widgets"></p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Path</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Notes</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">GET <code class="slate-code">/deposits/${depositId}</code></p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Will return a single deposit by id</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

Comprehensive reference for integrating with Beam API endpoints

Beams API endpoints and schemas are listed below. If you are looking for reference information about client-side integrations on web, see the 

Retrieving and updating deposits associated with your users

<h4 class="slate-h4"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-backgroundColor">Keep track of changes and updates to the Beam API</span></span></h4><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Keep track of changes and updates to the Beam API

<h1 class="slate-h1">Ansible Postman Collection</h1><h4 class="slate-h4">Learn more about the Beam Postman Collection, which allows you to send API requests without code</h4><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Introduction</h3><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-backgroundColor">Interested in experimenting with the Beam API without having to write a full-stack application? Beam offers a </span></span><a href="https://github.com/plaid/plaid-postman" target="_blank">Postman Collection</a><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-backgroundColor"> as a convenient tool for exploring Beams API endpoints without writing code. The Postman Collection provides pre-formatted requests for almost all of Beams API endpoints that you can call from their desktop application, or a web browser. All you have to do is fill in your API keys and any arguments.</span></span></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(17, 17, 17);font-size:16px" class="slate-backgroundColor"></span></span></p><p class="slate-p" placeholder="Type / for widgets">To get started using the Postman collection, you will need an Beam account with access to the Sandbox environment, an account at <a href="https://www.postman.com/" target="_blank">Postman.com</a>, and (optionally) the Postman <a href="https://www.postman.com/downloads/" target="_blank">desktop application</a>. Once you have all the prerequisites.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Learn more about the Beam Postman Collection, which allows you to send API requests without code

Interested in experimenting with the Beam API without having to write a full-stack application? Beam offers a 

 as a convenient tool for exploring Beams API endpoints without writing code. The Postman Collection provides pre-formatted requests for almost all of Beams API endpoints that you can call from their desktop application, or a web browser. All you have to do is fill in your API keys and any arguments.

To get started using the Postman collection, you will need an Beam account with access to the Sandbox environment, an account at 

Sections