Customer Profile
POST/customers/{customerid}
Creates a profile for a customer. The customer will be required to go through Green Dot’s verification process before initiating further API calls.
The customer can be in any of the following status conditions:
Status | Description |
---|---|
Pending | The customer verification is pending, and the customer cannot initiate transfer requests till such time the customer has been verified. For Future use |
Verified | The customer has been verified and the customer can initiate transfer requests. This is the status that we will return for all successful POST requests. |
FailedVerification | The customer verification failed. Customer cannot initiate transfer requests. See accompanying response codes |
OFACMatch-Pending | The customer verification had a soft OFAC Match that is getting reviewed by internal Risk Team. At this time transactions/links will not be blocked for this customer. |
OFACMatch-Confirmed | The customer verification had a hard OFAC Match that is confirmed by internal Risk Team. At this time, transactions/links will be blocked for this customer. |
Request
Field | Type | Format | Values Allowed | Required | Description |
---|---|---|---|---|---|
customerid | String | Min 2 characters Max 50 characters | a-Z, A-Z, 0-9 | No | The unique ID for this customer |
Firstname | String | Min 2 characters Max 25 characters | a-z, A-Z, hyphen, space | Yes | Customer’s first name. |
Lastname | String | Min 2 characters Max 25 characters | a-z, A-Z, hyphen, space | Yes | Customer’s last name. |
String | Min 6 characters Max 50 characters | a-Z, A-Z, 0-9, underscore, hyphen, period, ampersand | No | Customer’s verified Email address. | |
Phonenumber | String | Only allow 10 characters | 0-9 | No | Customer’s verified Phone Number. |
Dateofbirth | String | Min 10 characters Max 10 characters | 0-9, hyphen, dash, period | Conditional | If Partner is disbursing to AnyDebit, this field is required. Date of birth in valid format (e.g.: MM-DD-YYYY): • MM-DD-YY • MM/DD/YYYY • MM/DD/YY |
Socialsecuritynumber | String | Min 11 characters Max 11 characters | 0-9, hyphen | Conditional | The Social Security Number of the customer. |
address1 | String | Min 0 characters Max 25 characters | a-z, A-Z, 0-9, hyphen, space, /, period | No | Address Line 1. |
address2 | String | Min 0 characters Max 25 characters | a-z, A-Z, 0-9, hyphen, space, /, period | No | Address Line 2. |
City | String | Min 0 characters Max 25 characters | a-z, A-Z, hyphen, space | No | City of the customer. |
State | String | Min 0 characters Max 2 characters | any word character | No | Abbreviation of the State (e.g. CA, OH). |
Zipcode | String | max 5 characters | 0-9 | Yes | Zip Code of the customer (e.g. 54321). |
LastFourSSN | String | Min and Max 4 digits | 0-9 | Conditional | Last 4 digits of the SSN |
Response Object
If the request is successful, a customerid is returned to the partner.
- customerid: If a CustomerID is not provided by the partner in the POST request (Path Parameter), Green Dot will generate a unique CustomerID for this transfer.
- customeruri: The Customer URL to be referenced in transfer requests.
- status: See the status table above.
- responsecode: Response code of this API request. It is not the response code for the transaction. See the response code & description above.
- responsemessage: Response code description associated with response of this API request. See the response code & description above.
- responsedate: Response date in UTC format.
- responsedetail: ResponseDetail object of this API request. It is not the response detail code of the transaction.
- responsedetailcode: Response detail code.
- responsedetailcodedescription: Response detail code description associated with response detail code.
Field | Type | Format | Description |
---|---|---|---|
customerid | String | Min 2 characters Max 50 characters | CustomerID is provided by the partner in the POST request (Path Parameter), Green Dot will generate a unique CustomerID for this transfer if no data in request. (e.g. e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15) |
customeruri | String | Max 255 characters | The Customer URL to be referenced in transfer requests. (e.g. https://partners.greendotonline.com/customers/ e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15) |
status | String | Max 50 characters | See the status table above. (e.g. Verified) |
responsecode | Int | N/A | See the response code & description above. (e.g. 0) |
responsemessage | String | Max 150 characters | See the response code & description above. (e.g. Success) |
responsedate | Datetime | N/A | The response date and time. (e.g. 2023-11-26T08:28:34.6348002Z) |
POST Request
Sample /customers/ Request
{
"firstname": "new12145",
"lastname": "user1214",
"email": "[email protected]",
"phonenumber": "6162534111",
"dateofbirth": "01/14/78",
"socialsecuritynumber": "555123456",
"address1": "123 Main St",
"address2": "Apt 51",
"city": "SomeCity",
"state": "CA",
"zipcode": "54321"
}
Sample Success Response
{
"customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
"customeruri": "https://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
"status": "Verified",
"responsecode": 0,
"responsemessage": "Success",
"responsedate": "2016-01-26T08:28:34.6348002Z",
"responsedetail": {
"responsedetailcode": 0,
"responsedetaildescription": " Success"
}
}
GET/customers/{customerid}
Request
None.
Response Object
- Customer: Complex object containing the customer attributes/properties.
- customerid: Unique ID provided by the partner or generated by Green Dot.
- customeruri: The customer URI referenced in transfer requests.
- firstname: First Name of the customer.
- lastname: Last Name of the customer.
- isactive: indicates if customer is active or blocked.
- email: Email address of the customer.
- phonenumber: Phone number of the customer.
- partnerprogramidentifier: partner program identifier associated with the customer.
- partnername: partner name associated with the partnerprogramidentifier.
- linkid: profile id/link id, if any generated by Disbursement Platform.
- status: customer verification status.
- responsecode: See the response code & description below.
- responsemessage: See the response code & description below.
- responsedate: The response date and time.
Field | Type | Format | Description |
---|---|---|---|
customerid | String | Max 50 characters | Unique ID provided by the partner or generated by Green Dot. |
customeruri | String | Max 255 characters | The Customer URL to be referenced in transfer requests. (e.g. https://partners.greendotonline.com/customers/ e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15) |
partnerprogramidentifier | String | Max 100 characters | Partner program identifier associated with the customer. |
partnername | String | Max 50 characters | Partner name associated with the partnerprogramidentifier. |
firstname | String | Max 25 characters | First Name of the customer. |
lastname | String | Max 25 characters | Last Name of the customer. |
String | Max 50 characters | Email address of the customer. | |
phonenumber | String | only allow 10 characters | Phone number of the customer. |
linkid | String | Max 100 characters | Profile id/link id, if any generated by Disbursement Platform. |
isactive | Bool | N/A | Indicates if customer is active or blocked. |
status | String | Max 50 characters | Customer verification status. |
responsecode | Int | N/A | See the response code & description above. (e.g. 0) |
responsemessage | String | Max 150 characters | See the response code & description above. (e.g. Success) |
responsedate | Datetime | N/A | The response date and time. (e.g. 2023-11-26T08:28:34.6348002Z) |
GET Request
/customers/ e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15
Sample Success Response
{
"Customer": {
"customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
"customeruri": "https://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
"firstname": "john",
"lastname": "doe",
"isactive": "true",
"email": "[email protected]",
"phonenumber": "4085551234",
"partnerprogramidentifier": " FiservCashOut",
"partnername": " Fiserv",
"linkid": "950e4868-9f51-4a08-96a7-fcad96c4458e",
"status": "verified"
},
"responsecode": "0",
"responsemessage": "Success",
"responsedate": "2015-10-02T09:00:000Z",
"responsedetail": {
"responsedetailcode": 10,
"responsedetaildescription": "None"
}
}
Updated 7 months ago