---
title: "Adds Linked Account Enrollment"
method: POST
path: "/programs/{programCode}/enrollments/linkedaccount"
tags: ["Enrollments"]
---

# Adds Linked Account Enrollment

`POST /programs/{programCode}/enrollments/linkedaccount`

## Request

- The document declares no server URL.
- Auth: API key in header `Authorization`

Enrolls a linked user into a product, creates the account and card, and links the account with a parent account.

## Path parameters

- `programCode` string, required

## Headers

- `X-GD-RequestId` string, required
- `X-GD-Source` string
- `X-Gd-Bos-IgnoreMFA` string

## Request body

- EncryptedLinkedAccountRequest: Represents a request to create or link a new account using encrypted user profile data. Inherits all properties from Gd.Bos.DataTransfer.Request.LinkedAccountRequest.
  - `userProfile` EncryptedData: 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.
    - `version` string, nullable: The version of the encryption algorithm used to encrypt the data (e.g., "v1", "v2").
    - `ephemeralPublicKey` string, nullable: The ephemeral public key used in the encryption process, typically for key exchange or session establishment.
    - `publicKeyHash` string, nullable: The hash of the public key used to verify the integrity and authenticity of the encryption key.
    - `data` string, nullable: The encrypted data payload, typically base64-encoded, containing the sensitive information.
  - `accountIdentifier` string, nullable: The unique identifier (UID or GUID) of the account to which a new account will be linked.
  - `linkedProductCode` string, nullable: The product code for the linked account (e.g., card program, account type).
  - `productMaterialType` string, nullable: The material type for the linked product (e.g., "plastic", "virtual").
  - `requestPhysicalCard` boolean: Indicates whether a physical card should be requested for the linked account. Defaults to true.
  - `currency` string, nullable: The currency code (e.g., "USD") for the linked account.
  - `termsAcceptances` TermsAcceptance[], nullable: The list of terms and conditions acceptances for the linked account. Each item represents a record of a user's acceptance of specific terms and conditions.
    - `termsIdentifier` string, nullable: The unique identifier for the terms and conditions that were presented to the user.
    - `termsAcceptanceDateTime` string, nullable: The date and time when the user accepted the terms, typically in ISO 8601 format (e.g., "2023-07-01T12:34:56Z").
    - `termsAcceptanceFlag` boolean, nullable: Indicates whether the user accepted the terms (true) or declined (false).

## Response `201`

Created

- LinkedAccountResponse: Represents the response returned after retrieving linked account information. Contains the account identifier, status, and a list of linked account holders with KYC state data. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `accountIdentifier` string, nullable: The unique identifier (UID or GUID) for the linked account.
  - `status` string, nullable: The current status of the linked account (e.g., "Active", "Pending", "Closed").
  - `accountHolders` LinkedAccountHolder[], nullable: The list of linked account holders, including personal identifiers and KYC state data.
    - `firstName` string, nullable: The first name of the account holder.
    - `lastName` string, nullable: The last name of the account holder.
    - `userIdentifier` string, nullable: The unique user identifier for the account holder.
    - `kycStateData` KycStateData: Represents the Know Your Customer (KYC) state data for a user. Contains information about OFAC (Office of Foreign Assets Control) screening status, overall KYC status, and any pending KYC gates. Used to track regulatory compliance and the current state of user verification during onboarding or account management.
      - `ofacStatus` string, nullable: The OFAC (Office of Foreign Assets Control) screening status for the user. Typical values: "Passed", "Failed", "Pending", or other business-specific status indicators.
      - `kycStatus` string, nullable: The overall KYC (Know Your Customer) status for the user. Typical values: "Verified", "Pending", "Failed", or other business-specific status indicators.
      - `kycPendingGate` string, nullable: The name or code of any pending KYC gate or step that must be completed for full verification. Example: "DocumentVerification", "AddressCheck", or null if no gates are pending.
  - `responseDetails` ResponseDetail[], nullable: Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer: The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable: An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable: A human-readable description of the response, error, or status.
    - `url` string, nullable: A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-11-03** `28aa54bed51e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/greendot/apis/baas-apis/changes/programs/:programCode/enrollments/linkedaccount/post.md)

---

[API](https://skmtc.dev/greendot/apis/baas-apis.md) - [All operations](https://skmtc.dev/greendot/apis/baas-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/greendot/apis/baas-apis/revisions/28aa54bed51e?raw)