Get Customer Info API Method

This operation is used to retrieve customer information.

📘
Every request triggered should have a unique X-GD-RequestId value in the header.

Syntax

POST {baseUrl}/card/direct-deposit-form

API Reference

Get Customer Info

Request Samples

Success Request

POST {baseUrl}/customer/getCustomerInfo
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 227ed887-8bc7-4e97-9173-a8ead91effc0
{
 "accountIdentifier": "1F56D5DA-45B0-4250-80C0-2DC8DC50D0DC",
 "metadata": {
 "storeId": "PLSCC1936",
 "merchantId": "FSCC0342",
 "userId": "TellerIDwruaQnIt",
 "requestDateTime": "2024-07-23T07:09:46.0000000+00:00",
 "registerId": "5399860082642512131121312121213121212121"
 }
}

Negative Request

POST {baseUrl}}/card/direct-deposit-form
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 66219996371691
{
 "accountIdentifier": "", ---------------------- Invalid OR Missing AccountIdentifier
 "metadata": {
 "storeId": "", ---------------------- Invalid OR Missing StoreId
 "merchantId": "FSCC0342",
 "userId": "TellerIDwruaQnIt",
 "requestDateTime": "2024-07-23T07:09:46.0000000+00:00",
 "registerId": "5399860082642512131121312121213121212121"
 }
}

Request Parameters

Parameter	Required (Y/N)	Format/ Data Type	Pattern	Description
X-GD-RequestId	Yes	String	MaxLength:50	It is a unique transaction identifier that is generated by the retailer
requestDateTime	Yes	DateTime	2024-08- 13T12:34:56Z	Time stamp at which transaction occurred The time stamp has to be in UTC time zone and follow the following date and time formats: • YYYY-MM-DDTHH:mm:ssZ
userId	Yes	String	MaxLength:50	The unique ID of the user generating the transaction.
storeId	Yes	String	MaxLength: 20	The store number associated with the offline store of retailer. If not supplied, InvalidParameter (Code:100) error will be return.
registerId	No	String		Register where the transaction occurred
merchantId	Yes	String	MaxLength: 20	Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer
accountIdentifier	Yes	GUID	e5843e05-d367- 4bf1-a223- 3af46ae18802	When an account is created in-store or online, the GUID serves as the account identifier used to access all user information such as phone number, address, and email. Note: AccountIdentifier is required

Response Samples

Success Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 0648d859-f7e3-4d51-a164-af4d2614dc90
X-GD-ResponseCode: 0
{
 "customers": [{
 "accountIdentifier": "da5c9e4a-57af-4536-bf0c-5a24bf129350",
 "userIdentifier": "7bfc74cb-a26f-4f65-bf4d-f263c1cc2ae3",
 "peerTransferAcceptPreference": "manual",
 "profileData": {
 "firstName": "DocConSCOLAccept",
 "lastName": "veiyeoxnslqkg",
 "lastUpdatedDateTime": "2025-08-13T08:22:05",
 "addresses": [{
 "addressLine1": "4675 Cornell Rd",
"addressLine2": "Suite 280",
"city": "Cincinnati",
"state": "OH",
"zipCode": "45241",
"countryCode": "USA",
"type": "Home",
"isDefault": true,
"isVerified": false,
"isReturned": false,
"lastUpdatedDateTime": "2025-08-12T20:49:29",
Financial Service Center/ Application Programming Interface 117
Green Dot Corporation 2025
 "createdDateTime": "2025-08-12T20:49:29"
 }
 ],
 "dateOfBirth": "1997-08-01"
 },
 "email": {
 "emailAddress": "[email protected]",
 "isVerified": false,
 "isPrimary": false,
 "emailType": 0,
 "isDefault": true,
 "lastUpdatedDateTime": "2025-08-12T20:49:29",
 "createdDateTime": "0001-01-01T00:00:00"
 },
 "phoneNumbers": [{
 "number": "2432343377",
"type": "Mobile",
"isDefault": true,
"isVerified": true,
"lastUpdatedDateTime": "2025-08-12T20:49:30",
 "createdDateTime": "0001-01-01T00:00:00"
 }
 ],
 "identities": [{
 "identityType": "ConsulateId",
"last4Identity": "8027",
"countryCode": "COL"
 }
 ]
 }
 ],
 "metadata": {
 "requestId": "ecfc8b89-cd29-44e5-94ea-515b3cca5290",
 "responseId": "b530f472-5930-414b-a198-34324a47538c",
 "responseDateTime": "2025-08-25T15:11:40.3796965Z",
 "responseCode": 0,
 "responseDescription": "Success"
 }
}

Negative Response 1

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 160d9d1b-c528-425c-ad09-01ade5fb5fa9
X-GD-ResponseCode: 100
{
 "customers": null,
 "metadata": {
 "requestId": "df7d996d-1c91-499f-a62b-33f2209b938f",
 "responseId": "fd20ded5-f72f-4eed-b84c-c542876ca4fb",
 "responseDateTime": "2025-08-25T15:32:57.2531167Z",
 "responseCode": 100,
 "responseDescription": "Account identifier is invalid."
 }
}

Negative Response 2

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 160d9d1b-c528-425c-ad09-01ade5fb5fa9
X-GD-ResponseCode: 101
{
 "customers": null,
 "metadata": {
 "requestId": "d6794cf7-244e-4d71-a21e-e8eacadd34c0",
 "responseId": "b1d5ea33-1778-4d62-a80f-e8e1af7698eb",
 "responseDateTime": "2025-08-25T15:34:29.4728203Z",
 "responseCode": 101,
 "responseDescription": "Account Not Found."
 }
}

Response Parameters

Parameter	Format/Data Type	Pattern	Description
requestId	String	MaxLength:50	The unique request ID from request.
responseId	String	MaxLength:50	The unique Response Identifier (generated by GreenDot).
responseDateTime	DateTime	2024-098- 13T16:12:23.4541445+08:00	Time stamp at which transaction occurred. The time stamp is in UTC time zone and follow the following date and time formats: • YYYY-MMDDTHH:mm:ssfffffffK
responseCode	Numeric	MaxLength:4	Indicates success and failure of the response codes. It is in the numeric format
responseDescription	String	MaxLength:255	Describes the Response Code in more detail. It is in the String format
customers	Array	Array Object	Collection of accounts linked with AccountIdentifier
accountIdentifier	GUID	74A021E4-3E5B-48AC-8F4AC0E29AB4C23A	Unique Account Identifier for given accounts
userIdentifier	GUID	14A021E4-3E5B-48AC-8F4AC0E29AB4C23A	Unique user Identifier for given accounts
peerTransferAcceptPreference	String	Manual/Immediate/Approval	Transfer Preferences
profileData	Class	Class Object
firstName	String	MaxLength: 30	User`s First Name
lastName	String	MaxLength: 30	User`s Last Name
LastUpdatedDateTime	String	MaxLength: 30	User`s account last updated date time
addresses	Array	Array Object {1, 2, …..}	Array of address provided by the user.
addressLine1	string	MaxLength: 30	User`s Address Line 1
addressLine2	string	MaxLength: 30	User's Address Line 2
city	string	MaxLength: 30	User`s City
state	string	MaxLength: 30	User`s State
zipCode	string	Min: 5 Max:10	User`s ZipCode
countryCode	string	USA, HND, MEX etc.	User`s Country Code
type	string	Home, Office etc.	User`s Address Type
isDefault	Bool	True / False	User`s Default Address Flag
isVerified	Bool	True / False	User`s Address is verified or not
isReturned	Bool	True / False	User`s Address is returned
lastUpdatedDateTime	DateTime	2025-08-24 23:18:00.340	User`s Address last updated datet time
createdDateTime	DateTime	2025-08-24 23:18:00.340	User`s Address Added/Created date time
dateOfBirth	Date	YYYY-MM-DD	User`s Date of birth
email	Class	Object
emailAddress	String		User`s Email Address
isVerified	Bool	True / False	User`s Email is verified
isPrimary	Bool	True / False	User`s Primary Email flag
emailType	String	Personal / Work	User`s Email Type
lastUpdatedDateTime	DateTime	2025-08-24 23:18:00.340	User`s Email last updated date time
createdDateTime	DateTime	2025-08-24 23:18:00.340	User`s Email Added/Created datime time
identities	Array	Array Object {1, 2, …..}	Array of Identification provided by the user
identityType	String	1234567891	User`s Provided Document Type
last4Identity	String	1234	Last four of Document Type
countryCode	String	HND, MEX, USA etc.	User`s Proivded Document Country Code
phoneNumbers	Array	Array Object {1, 2, …..}	Array of phone numbers provided by the user
number	String	10 digits	User`s provided phone number
type	String	Home / Work / Mobile	User`s phone number type
isDefault	Bool	True / False	User`s phone number default
isVerified	Bool	True / False	User`s phone number verified
lastUpdatedDateTime	Datetime	2025-08-24 23:18:00.340	User`s phone number last updated date time
createdDateTime	Datetime	2025-08-24 23:18:00.340	User`s phone number added/created date time

Response Codes

Code	CodeText	ResponseDescription	Description
0	Success	Success
100	InvalidParameter	• RequestId is too long • UserId is too long • StoreId is too long • MerchantId is too long • RequestId is required • RequestDateTime is required • UserId is required • StoreId is required • MerchantId is required • Account identifier is invalid	Invalid parameter in the request. Examples: MerchantID not supplied, StoreID not supplied.
101	Invalid AccountIdentifier	Account Not Found	The account identifier does not exist. Regardless of the account status, if the account identifier is available.
130	InvalidMerchant	InvalidMerchant	MerchantId in request has not been found/enabled in the system.
800	InvalidStore	Store was not found	Store is not found; store is not for the partner or store does not support this operation.
861	RetailChainUserNotFound	User is not found	UserID in request is not found in system.
862	RetailChainUserNotActive	User is not active	UserId in request is not active.
1000	GeneralFailure	GeneralFailure	Service failure.