--- title: "Get Users" method: GET path: "/programs/{programCode}/accounts/{accountIdentifier}/users" tags: ["Account"] --- # Get Users `GET /programs/{programCode}/accounts/{accountIdentifier}/users` This endpoint allows the retrieval of the users’ profile information, associated with a specific account. Request Parameters - Retrieve profile information for all associated users See Structure of API Calls for details. Response Message - If the GET request is successful, the following response message will be returned along with a 200 HTTP status code. ## Path parameters - `programCode` string, required - `accountIdentifier` string, required ## Headers - `X-GD-RequestId` string, required ## Response `200` OK - GetUsersResponse — Represents the response containing a list of user profiles. - `users` UserProfile[], nullable — The list of user profiles returned by the request. - `accountIdentifier` string, nullable — The unique identifier for the account associated with this user profile. - `userIdentifier` string, nullable — The unique identifier for the user. - `peerTransferAcceptPreference` string, nullable — The user's peer transfer acceptance preference (e.g., "acceptAll", "acceptNone"). - `profileData` ProfileData — Represents a user's personal profile data, including name, addresses, and date of birth. Used to store and transfer user identity and contact information for onboarding, profile management, and compliance purposes. - `firstName` string, nullable — The user's first name. - `middleName` string, nullable — The user's middle name, if applicable. - `lastName` string, nullable — The user's last name. - `addresses` Address[], nullable — A list of addresses associated with the user, including mailing, residential, or other address types. - `addressLine1` string, nullable — The first line of the street address (e.g., house number and street name). - `addressLine2` string, nullable — The second line of the street address (e.g., apartment, suite, unit, building, floor, etc.). - `city` string, nullable — The city or locality of the address. - `state` string, nullable — The state, province, or region of the address. - `zipCode` string, nullable — The postal or ZIP code for the address. - `county` string, nullable — The county or district of the address, if applicable. - `countryCode` string, nullable — The ISO country code (e.g., "US" for United States). - `type` string, nullable — The type of address (e.g., "home", "work", "mailing"). - `isDefault` boolean — Indicates whether this address is the default address for the user or account. - `isVerified` boolean — Indicates whether this address has been verified (e.g., by postal service or user confirmation). - `isReturned` boolean — Indicates whether mail sent to this address has been returned as undeliverable. - `lastUpdatedDateTime` string, nullable — The date and time when the address was last updated, typically in ISO 8601 format. - `lastUpdatedDateTime` string, nullable — The date and time when the profile was last updated, typically in ISO 8601 format. - `dateOfBirth` string, nullable — The user's date of birth, typically in ISO 8601 format (e.g., "YYYY-MM-DD"). - `email` Email — Represents an email address and related metadata for a user. Contains the email address, verification status, default flag, and last updated timestamp. Used to store and manage user contact information for notifications, authentication, and communication purposes. - `emailAddress` string, nullable — The user's email address. - `isVerified` boolean — Indicates whether the email address has been verified. - `isDefault` boolean — Indicates whether this email address is the user's default contact email. - `lastUpdatedDateTime` string, nullable — The date and time when the email address was last updated, typically in ISO 8601 format. - `emailHistory` Email[], nullable - `emailAddress` string, nullable — The user's email address. - `isVerified` boolean — Indicates whether the email address has been verified. - `isDefault` boolean — Indicates whether this email address is the user's default contact email. - `lastUpdatedDateTime` string, nullable — The date and time when the email address was last updated, typically in ISO 8601 format. - `phoneNumbers` PhoneNumber[], nullable - `number` string, nullable — The user's phone number. - `type` string, nullable — The type of phone number (e.g., "Mobile", "Home", "Work"). - `isDefault` boolean — Indicates whether this phone number is the user's default contact number. - `isVerified` boolean — Indicates whether the phone number has been verified. - `lastUpdatedDateTime` string, nullable — The date and time when the phone number was last updated, typically in ISO 8601 format. - `phoneNumbersHistory` PhoneNumber[], nullable - `number` string, nullable — The user's phone number. - `type` string, nullable — The type of phone number (e.g., "Mobile", "Home", "Work"). - `isDefault` boolean — Indicates whether this phone number is the user's default contact number. - `isVerified` boolean — Indicates whether the phone number has been verified. - `lastUpdatedDateTime` string, nullable — The date and time when the phone number was last updated, typically in ISO 8601 format. - `identities` Identity[], nullable — The list of identity documents or numbers associated with the user (e.g., SSN, passport). - `identityType` 'SSN' | 'DrivingLicense' | 'Passport' | 'MatriculaId' | 'ITIN' | 'EIN' | 'NationalIdCard' | 'ConsulateId' — The type of identity document or number (e.g., SSN, passport, driving license). - `last4Identity` string, nullable — The last four digits or characters of the identity value (e.g., last 4 of SSN or passport number). - `countryCode` string, nullable — The ISO 3166-1 alpha-2 country code where the identity document was issued. - `termsAcceptances` TermsAcceptance[], nullable — The list of terms and conditions acceptances for the user. - `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). - `partnerConsumerId` string, nullable — The Partner Consumer ID - `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)