--- title: "Get Account Details" method: GET path: "/programs/{programCode}/accounts/{accountIdentifier}" tags: ["Account"] --- # Get Account Details `GET /programs/{programCode}/accounts/{accountIdentifier}` This endpoint allows the retrieval of detailed information about a specific account. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. Note:UpgradeKycStateData will be return when customer upgrade their account to DDA ## Path parameters - `programCode` string, required - `accountIdentifier` string, required ## Query parameters - `extend` string ## Headers - `X-GD-RequestId` string, required ## Response `200` OK - GetAccountResponse — Represents the response for retrieving detailed account information. - `prospectIdentifier` string, nullable — The unique identifier for the prospect, if the account is in a prospect state. - `account` AccountResponse — sub-class of Account class, used in GetAccountResponse - `accountHolders` AccountHolderBase[], nullable — Represents the list of account holders associated with the account, including primary and secondary users. - `user` User — Represents user profile information associated with an account holder. Contains personal details, identity information, account status, and KYC (Know Your Customer) state data. Used to provide a comprehensive view of the user's identity, preferences, and compliance status within the system. - `firstName` string, nullable — The user's first name. - `lastName` string, nullable — The user's last name. - `dobStatus` string, nullable — The status of the user's date of birth verification. - `last4Identity` string, nullable — The last four digits of the user's identity number. - `identityType` string, nullable — The type of identity document or number provided (e.g., "SSN", "Passport", "DriverLicense"). - `userIdentifier` string, nullable — The unique identifier assigned to the user within the system. - `peerTransferAcceptPreference` string, nullable — The user's preference for accepting peer-to-peer transfers (e.g., "AutoAccept", "ManualAccept"). - `status` string, nullable — The current status of the user (e.g., "Active", "Inactive", "Suspended"). - `isPrimaryAccountHolder` boolean — Indicates whether the user is the primary account holder. - `kycStateData` KycStateData — Represents the Know Your Customer (KYC) state data for a user. Contains information about OFAC (Office of Foreign Assets Control) screening status, overall KYC status, and any pending KYC gates. Used to track regulatory compliance and the current state of user verification during onboarding or account management. - `ofacStatus` string, nullable — The OFAC (Office of Foreign Assets Control) screening status for the user. Typical values: "Passed", "Failed", "Pending", or other business-specific status indicators. - `kycStatus` string, nullable — The overall KYC (Know Your Customer) status for the user. Typical values: "Verified", "Pending", "Failed", or other business-specific status indicators. - `kycPendingGate` string, nullable — The name or code of any pending KYC gate or step that must be completed for full verification. Example: "DocumentVerification", "AddressCheck", or null if no gates are pending. - `partnerConsumerId` string, nullable — The partner consumer identifier associated with the user. - `accountHolderIdentifier` string, nullable — The unique identifier for the account holder. - `accountIdentifier` string, nullable — The unique identifier assigned to the account. Used for all account-related operations and references. - `accountReferenceNumber` string, nullable — The reference number associated with the account, typically used for display or reporting purposes. - `partnerConsumerId` string, nullable — Gets or sets the identifier for the partner's consumer. - `productCode` string, nullable — The product code that identifies the type of account or product (e.g., card program, account type). - `productTierKey` integer — The tier key for the product, indicating the account's product tier or level. - `cipLevel` string, nullable — The Customer Identification Program (CIP) level for the account, indicating the level of identity verification completed. - `productMaterialType` string, nullable — The material type of the product (e.g., "plastic", "virtual"). - `currency` string, nullable — The ISO 4217 currency code for the account (e.g., "USD"). - `status` string, nullable — The current status of the account. - `instantIssue` boolean — Indicates whether the account was issued instantly. - `statusReasons` string[], nullable — A list of reasons for the current account status, if any. - `statusCure` string, nullable — The action or process required to cure the current account status, if applicable. - `accountStatusChangedDateTime` string, nullable — The date and time when the account status last changed. - `activationDate` string, nullable — The date and time when the account was activated. - `directDepositInformation` DirectDepositInformation — Represents the direct deposit information for an account. Contains the account number and routing number required to receive ACH direct deposits. Used to provide customers and partners with the necessary banking details for setting up direct deposit transactions. - `accountNumber` string, nullable — The account number used for receiving direct deposits via ACH. - `routingNumber` string, nullable — The routing number of the financial institution for ACH direct deposits. - `purses` Purse[], nullable — The list of purses (sub-accounts or balances) associated with the account, including primary and additional purses. - `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. - `additionalPurses` Purse[], nullable — Additional purses associated with the account, if any. - `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. - `termsAcceptances` TermsAcceptance[], nullable — The list of terms and conditions acceptances for the account. - `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). - `fraudData` object, nullable — Optional. A dictionary of key/value pairs containing fraud detection data associated with the account. - `accountType` string, nullable — The type of account (e.g., "personal", "business", "joint"). - `language` string, nullable — The preferred language for the account (e.g., "en", "es"). - `accountCycleDay` integer, nullable — The account cycle day, if applicable (e.g., billing or statement cycle day). - `accountEligibility` AccountEligibility — Represents the eligibility status of a Green Dot account for specific actions or changes. Contains information about whether the account is eligible to update contact details such as address, email, or phone number. - `contactChangeEligibility` ContactChangeEligibility — Represents the eligibility of a Green Dot account to update specific contact information. Contains lists of eligible or ineligible contact types (address, email, phone) that can be changed, based on business rules, account status, or regulatory requirements. - `address` string[], nullable — A list of address types (e.g., "home", "mailing") that are eligible for update on the account. If the list is empty or missing, address changes may not be allowed. - `email` string[], nullable — A list of email types (e.g., "primary", "secondary") that are eligible for update on the account. If the list is empty or missing, email changes may not be allowed. - `phone` string[], nullable — A list of phone types (e.g., "mobile", "home", "work") that are eligible for update on the account. If the list is empty or missing, phone number changes may not be allowed. - `upgradeKycStateData` KycStateData — Represents the Know Your Customer (KYC) state data for a user. Contains information about OFAC (Office of Foreign Assets Control) screening status, overall KYC status, and any pending KYC gates. Used to track regulatory compliance and the current state of user verification during onboarding or account management. - `ofacStatus` string, nullable — The OFAC (Office of Foreign Assets Control) screening status for the user. Typical values: "Passed", "Failed", "Pending", or other business-specific status indicators. - `kycStatus` string, nullable — The overall KYC (Know Your Customer) status for the user. Typical values: "Verified", "Pending", "Failed", or other business-specific status indicators. - `kycPendingGate` string, nullable — The name or code of any pending KYC gate or step that must be completed for full verification. Example: "DocumentVerification", "AddressCheck", or null if no gates are pending. - `targetUserType` string, nullable — The type of user targeted by the account (e.g., "primary", "secondary", "authorized user"). - `partnerAccountId` string, nullable — The partner-specific account identifier, if the account is linked to a partner system. - `productClass` string, nullable — The product class for the account, indicating the broader product grouping or classification. - `enrollmentSource` string, nullable — The source of enrollment for the account (e.g., "web", "mobile", "partner"). - `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/versions/666553766b78/schema)