v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

ExternalAccount

Create a new customer profile in the Green Dot system.

This API creates a customer profile. Afterwards, the customer must go through Green Dot's verification process before initiating any further API calls.

Business Logic

CustomerToken -- Depending on the partner configuration, this field can be mandatory or optional.

When this field is mandatory, the partner must provide a unique value.
When this field is mandatory, the partner must provide a unique value.
When this field is optional and the request contains a CustomerToken value, the same value is used. Otherwise, the Instant Transfer Service generates a GUID as the CustomerToken.

Idempotent Check -- This check is based on the CustomerToken. If the request contains a value that already exists in the database, it returns the Record already exists error.

DB Level Encryption -- This encryption is based on DateOfBirth.

CustomerID in DB -- As per Green Dot standards, the CustomerID is a GUID that the the Instant Transfer service generates.

post/programs/{programCode}/externalAccounts/customers

Path parameters

programCodestring required

Program code assigned to the partner.

Headers

X-GD-RequestIdstring required

Unique request identifier (GUID).

X-GD-CustomerTypestring

Type of customer (default: External).

Request body

saltstring nullable

Unique id in GUID format, must match the RequestID in the headers. Used for idempotency and encryption.

customerTokenstring nullable

Unique Id for an existing customer profile. Use an empty string to create a new customer profile. Used for idempotency and partner-specific logic.

Example request

{
  "salt": "eb6c967d-765a-4b18-9a6e-d4eb4df69efa",
  "customerToken": "eb6c967d-765a-4b18-9a6e-d4eb4df69efa"
}

Response

Customer profile created successfully.

customerTokenstring nullable

Unique token generated to identify the customer profile. Used for subsequent operations such as linking cards or banks.

statusstring nullable

The status of the customer profile after creation (e.g., Pending, Active, Suspended).

Example response

{
  "customerToken": "eb6c967d-765a-4b18-9a6e-d4eb4df69efa",
  "status": "Pending"
}