---
title: "Credit Builder Enroll"
method: POST
path: "/programs/{programCode}/creditbuilder/enroll"
tags: ["CreditBuilder"]
---

# Credit Builder Enroll

`POST /programs/{programCode}/creditbuilder/enroll`

Enroll a user in the Credit Builder program

## Path parameters

- `programCode` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- CreditBuilderEnrollRequest — Represents a request to enroll a user in the Credit Builder program. Contains the account identifier and a list of terms acceptances required for enrollment. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `accountIdentifier` string, nullable — Gets or sets the unique identifier for the account to be enrolled in the Credit Builder program.
  - `termsAcceptances` TermsAcceptance[], nullable — Gets or sets the list of terms and conditions acceptances required for enrollment. Each item represents a record of the user's acceptance of specific terms.
    - `termsIdentifier` string, nullable — The unique identifier for the terms and conditions that were presented to the user.
    - `termsAcceptanceDateTime` string, nullable — The date and time when the user accepted the terms, typically in ISO 8601 format (e.g., "2023-07-01T12:34:56Z").
    - `termsAcceptanceFlag` boolean, nullable — Indicates whether the user accepted the terms (true) or declined (false).

## Response `200`

OK

- CreditBuilderEnrollResponse — Represents the response returned when enrolling in the Credit Builder program. Contains a collection of purses associated with the enrollment.
  - `purses` Purse[], nullable — Gets or sets the array of purses associated with the Credit Builder enrollment.
    - `purseIdentifier` string, nullable — The unique identifier for the purse.
    - `purseType` string, nullable — The type of purse (e.g., "Savings", "Spending", "Goal").
    - `purseDescription` string, nullable — A human-readable description of the purse.
    - `availableBalance` number, double — The available balance in the purse, representing funds that can be spent or withdrawn.
    - `ledgerBalance` number, double — The ledger balance in the purse, representing the total balance including pending transactions.
    - `availableBalanceAsOfDateTime` string, nullable — The date and time when the available balance was last updated.
    - `ledgerBalanceAsOfDateTime` string, nullable — The date and time when the ledger balance was last updated.
    - `isHidden` boolean — Indicates whether the purse is hidden from the user interface.
    - `status` string, nullable — The current status of the purse.
    - `goalAmount` number, double, nullable — The goal amount set for the purse, if applicable (e.g., for savings goals).
    - `goalDate` string, nullable — The target date for achieving the goal amount.
    - `iconName` string, nullable — The name of the icon associated with the purse for display purposes.
    - `createDate` string, date-time, nullable — The date and time when the purse was created.
    - `changeDate` string, date-time, nullable — The date and time when the purse was last changed or updated.
    - `purseNumber` string, nullable — The purse number, which may be used for display or reference purposes.
    - `interestRateTierIdentifier` string, nullable — The identifier for the interest rate tier applied to the purse, if applicable.
    - `interestRateTier` string, nullable — The name or description of the interest rate tier applied to the purse.
    - `interestYieldStartDate` string, nullable — The start date for interest yield calculation.
    - `interestYieldEndDate` string, nullable — The end date for interest yield calculation.
    - `APY` number, double, nullable — The annual percentage yield (APY) for the purse, if applicable.
    - `purseSubType` string, nullable — The subtype of the purse, providing additional categorization (e.g., "RoundUp", "EmergencyFund").
    - `interestRate` number, double, nullable — The interest rate applied to the purse, if applicable.
    - `isRoundUp` boolean — Indicates whether the purse is configured for round-up savings functionality.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)