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.

Path Params
string
required

Program code assigned to the partner.

Body Params

Encrypted customer profile data.

string | null

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

string | null

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

encryptedData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

Headers
string
required

Unique request identifier (GUID).

string
Defaults to external

Type of customer (default: External).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Invalid or missing parameters.

401

Unauthorized access.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json