user_id
.Step | Description | Options Available |
---|---|---|
authorization | Creates a Dots user and verifies their phone number. |
|
compliance | Collects tax information for the user based on their current location. This step will collect the user’s SSN, date of birth, and address if the user is based in the US. |
|
id-verification | Collects and verifies a user’s government-issued ID and matches their facial scan to that ID. |
|
background-check | Collects the user’s SSN, date of birth, and address to run a background check. If the background check fails, it will trigger an email notification to the app and user.has_criminal_activity will be true . |
|
manage-payouts | Allows the user to add payout methods, set a default, and enable automatic payouts. |
|
manage-payments | Enable the user to connect a bank account for ACH payments. |
|
payout | Allows the user to initiate a payout to their preferred payout method. |
|
redirect | Redirects the user to a URL of your choice. |
|
user_id
is not provided, the onboarding
step is automatically added to the start of all Flows.When using the Sandbox environment, the compliance step will always be shown even if tax information has already been collected for the user. This allows testing the form without creating a new user.compliance
step will be added to the onboard flow.
link
to embed the onboard process into an iframe within your application. In addition, you’ll use the Flow id
to retrieve the user information after they complete the onboarding.
The GIF below presents the user interface provided by Dots, which is completely responsive, enabling you to integrate into any application.
id
received in the previous step. See the Webhooks documentation page to learn how to configure your webhooks in Dots.
After receiving the confirmation, you can use the Retrieve Flow Information endpoint to have access to the new user_id
. The following code block presents request and response examples of retrieving Flow information.
user_id
, which you’ll use to create a payout Flow.
user_id
in your response, it means that the user hasn’t finished the onboarding Flor.user_id
), you can transfer the funds related to the payout to their account. To perform this action, you’ll use the Create a Transfer endpoint, informing the amount
to transfer and the receiver user_id
.
The following code block presents request and response examples of creating a transfer using the user_id
received in the previous step.
amount
value must be informed in cents. Use negative values to transfer money from your App to the user.status
, you can see that the transfer was completed
. Therefore, the funds are in the user account, and now you need to create a Flow to enable them to withdraw these funds.
payout
step and informing the user_id
retrieve in Step 2. Since you provide the user_id
, the onboarding steps won’t be presented to your user.
The following code block presents request and response examples of creating a Flow using the Create a Flow endpoint with only the payout
step.
link
to embed the payout process into an iframe within your application. The GIF below presents the user interface provided by Dots.