Individuals

Steps

1. The first step is to make a POST request to the Accounts endpoint.

2. The response from Step 1 is a onboardingUrl. Upon receiving the onboardingUrl from the first step, use it to launch the UI and authenticate the user into Beam.

3. The first screen the user will see is the Terms and Conditions, it is required that the user agrees to our Terms and User Agreements

4. The second screen is the KYC collection screen. Users are required to provide a date of birth, social security number and a valid address.

❗️

At this time, we are unable to onboard users who are based in New York, Alaska, Hawaii, and Louisiana and they will be informed in the UI that we do not support their current region.

5. The third screen is to collect their preferred payout method. The user can connect their bank account or input their Visa or Mastercard debit card
6. Once the user has completed these 3 steps, beam will send a message to the parent window called beamIframeCloseOnSuccess in which we pass the users publicToken that can be used to query the users information
   1. You can listen to these messages using the following

// Listening for messages in the parent window
window.addEventListener("message", function(event) {

  // Parse the message data
  const { eventName, publicToken } = event.data;

  // Check the event name and handle the message
  if (eventName === "beamIframeCloseOnSuccess") {
    console.log("User public token:", publicToken); // Corrected line
    // Handle the message as needed
  }
});