Example Integration Flow
Example Integration Guide: Non-KYC Enrollment Flow
This guide provides a high-level, end-to-end example of a non-KYC (Know Your Customer) enrollment flow using Green Dot’s BaaS APIs. It combines a recommended integration order with a practical scenario to help partners understand how APIs are typically used together during onboarding and early account activity.
This example represents a simplified enrollment flow that does not include identity verification through IDV. Your actual implementation may differ based on program configuration, compliance requirements, and product design, but this guide can be used as a reference for planning your integration.
Note: many partners do require KYC verification and is documented in our Enrollment APIs and KYC guides as needed.
Recommended Integration Order (High Level)
Most partner integrations follow this general sequence:
- Enrollments
- Users
- Accounts
- Payment Instruments
- Transfers
- Webhooks
- Optional add-on APIs
The sections below walk through this order using a concrete, non-KYC use case.
1. Enroll the User and Create the Account
Call the Enrollments API to enroll a new user into your program and establish the initial banking relationship.
This step typically:
- Runs OFAC screening
- Creates the BaaS user profile
- Creates the primary account
- Creates or associates a payment instrument (card), based on your program setup
Possible Status Outcomes
- Success
- Status pending (OFAC match)
- Failed due to invalid input
Webhook Behavior
An Account Updated webhook is returned for successful or pending enrollments, whether the result is positive or negative.
This webhook is not returned if enrollment fails due to a server error or exception.
You will receive an account identifier from both the API response and the webhook, which is used in subsequent calls.
If an OFAC name match occurs, the enrollment enters a manual review process. The final outcome of that review is delivered via webhook, such as:
- Status declined – OFAC manual review failed
2. Retrieve Account Details
After enrollment is completed or approved, call the Accounts API to retrieve account details.
This step is commonly used to:
- Confirm account creation
- Display non-sensitive account information in your application
- Prepare for balance and transaction visibility
3. Initiate Digital Wallet Provisioning (Optional)
If your product supports digital wallets, call the Payment Instruments API to initiate push provisioning for app-initiated wallet operations.
This step prepares the payment instrument for provisioning into a supported digital wallet experience.
4. Provision the Card (Optional)
If your business flow includes awarding points, promotions, or cashback at enrollment, determine whether the user is eligible to receive a balance adjustment before or after card provisioning.
This step is optional and depends on your product design.
5. Adjust the Account Balance (Optional)
Call the Adjustments API to apply a balance adjustment to the user’s account.
Common examples include:
- Welcome bonuses
- Promotional credits
- Cashback rewards
A Transaction Event webhook is returned once the adjustment is processed.
6. Retrieve Transaction History
After account activity has occurred and sufficient time has passed, call the Transactions API to retrieve a list of transactions.
This step is typically used to:
- Display transaction history in your application
- Support customer visibility into spending and account activity
- Validate adjustments, transfers, or deposits
Supporting APIs to Integrate Early
In parallel with the steps above, partners are strongly encouraged to integrate Webhooks early in development. Webhooks provide real-time notifications for enrollment outcomes, balance changes, transactions, and account updates, reducing the need for polling APIs.
Final Notes
- This guide is an example only and does not represent all possible enrollment or onboarding paths.
- Not all partners use every step or API shown here.
- Your Green Dot representative can help tailor the integration order and API usage to your specific program requirements and roadmap.
For additional capabilities beyond this flow, browse the developer portal or consult your Green Dot representative to identify optional add-on APIs that best support your use case.
Updated 17 days ago
