Add Enrollment for User and Create Account/Card (Encrypted)

post

https://example.com/programs/{programCode}/enrollments

Creates a new enrollment for a user, including account and card creation. Supports instant issue scenarios and account upgrades (for example, from GPG to DDA if the "upgradeFlag" parameter is true). This endpoint is also used for the card-in-hand use case to support instant issue enrollment.

Key operations performed:

Create new user
Create account
Create payment instrument
Support instant issue enrollment
Support account upgrade

Note: If POST /enrollments is called with a valid request and enrollment fails during processing, the request will be automatically completed if the customer clears OFAC.

Name	Comment
200	Success
400	Bad request, such as unsupported operation
401	Unauthorized

Group	Property	Required	Constraint/Scenario	HttpStatus	Code	Sub Code	Description
			PACKAGE_LOOKUP_EXCEPTION	400	5020	5021	Connection issue looking up package info
			PACKAGE_NOT_FOUND	400	5020	5022	No package is associated with the provided identifier
			PACKAGEID_IN_USE	400	5020	5023	The package associated with the identifier is already being used
			INSTANT_ISSUE_NOT_SUPPORTED	400	5030	5031	Product does not support instant issue enrollment
			INSTANT_ISSUE_REQUEST_PHYSICAL_CARD_NOT_SUPPORTED	400	5030	5032	Product does not support requesting a physical card during instant issue enrollment
instantIssue	type	Y ONLY if enrollment is instantIssue	INSTANT_ISSUE_TYPE	400	600	Required: 6181, Invalid: 6182	If instantIssue object is provided, then type must be provided. Must be CBS
instantIssue	mappingIdentifier	Y ONLY if enrollment is instantIssue	INSTANT_ISSUE_MAPPING_IDENTIFIER	400	600	Required: 6183, Invalid: 6184	If instantIssue object is provided, then mappingIdentifier must be provided
	accountIdentifier	N	missing/invalid accountIdentifier	400	350	0	accountIdentifier is invalid
			change user profile	400	4502	0	User profile cannot be changed
			account status not normal	400	4503	0	Account status is not healthy
			target product code same as current product code	400	4504	0	Account already upgraded successfully
			same requestId, accountIdentifier is different	400	4505	0	Account not matched
			target product code not allowed for upgrade	400	4506	0	Account already upgraded successfully
			account not found	400	10	0	Account, account holder, or user not found
			[CPM] upgrade service returned error	400	5030	0	A downstream provider did not return success for Upgrade Account

Path Params

programCode

string

required

The program code for the enrollment flow.

Body Params

The encrypted enrollment request payload. See Gd.Bos.DataTransfer.Request.EnrollmentRequestEncrypted for details.

user

object

Container for encrypted user information, including the encrypted user data payload and a list of terms and conditions acceptances. Used for secure transmission and processing of sensitive user data.

encryptedFraudData

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.

contactVerificationIdentifiers

array of strings | null

A list of identifiers (such as email or phone) used to verify the contact information for the enrollment.

contactVerificationIdentifiers

account

object

Represents a Green Dot account, including identifiers, product and status information, account holders, purses, eligibility, and related metadata. This class is used to provide a comprehensive view of an account's state, configuration, and associated entities for account management, transfer, and reporting operations.

requestPhysicalCardFlag

boolean

Indicates whether a physical card should be requested during enrollment.

executeKycFlag

boolean

Indicates whether KYC (Know Your Customer) checks should be executed as part of the enrollment.

upgradeFlag

boolean

Indicates whether the account should be upgraded (e.g., to a higher product tier) during enrollment.

instantIssue

object

Represents instant card issuance details for an account, including the mapping identifier and type. Used to specify instant issue configuration during account enrollment or card issuance.

Headers

X-GD-RequestId

string

required

The unique request identifier for tracking and logging.

X-GD-Source

string

The source system or channel identifier).

X-Gd-Bos-IgnoreMFA

string

Flag to ignore multi-factor authentication; 'true' or 'false'.

X-GD-EnrollmentRequestIdentifier

string

The unique identifier for the enrollment request.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

200OK

403Forbidden

500Internal Server Error

503Service Unavailable