API Reference

Add Account Holder

post
https://example.com/programs//accounts//AccountHolder

This endpoint allows an account holder to be added to an existing account.Account must have the ability to be a joint account and not be a corp account.Account holder must first pass a validation check if validation check is successful, the account holder will be created and the request will returned the account holders linked to the account.

Path Params
string
required

Partner program code for the account.

string
required

Unique account identifier (UID or GUID).

Body Params

Encrypted request to add an account holder. See Gd.Bos.DataTransfer.Request.EncryptedAddAccountHolderRequest for required fields.

Represents a request to add an account holder to an existing account using encrypted user profile data. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.

string | null

The product material type for the account holder (e.g., "plastic", "virtual").

boolean
Defaults to true

Indicates whether a physical card should be requested for the new account holder. Defaults to true.

string | null

The currency code (e.g., "USD") for the account holder's account.

termsAcceptances
array of objects | null

The list of terms and conditions acceptances for the account holder. Each item represents a specific terms acceptance record.

termsAcceptances
userProfile
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 tracking identifier (X-GD-RequestId header).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 3 months ago

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

Updated 3 months ago