Joint Account API

Create Joint Account

This API changes an individual account to become a joint account.

Route

POST /programs/{ProgramCode}/accounts/{AccountIdentifier}/AccountHolder

Route Parameters

Headers

Request

{
  "requestPhysicalCard": boolean,
  "currency": "string",
  "termsAcceptances": [
    {
      "termsIdentifier": "string",
      "termsAcceptanceDateTime": "string",
      "termsAcceptanceFlag": true
    }
  ],
  "userProfile": {
    "version": "string",
    "ephemeralPublicKey": "string",
    "publicKeyHash": "string",
    "data": "string"
  }
}

Allowed termsIdentifier values

Sample Request

{
  "requestHeader": {
    "requestId": "8a218080-cd0b-e948-18cb-8ec919a0b3d4"
  },
  "userProfile": {
    "version": "EC_v1",
    "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE3ju/a8kC8G8IIzIbhWtfNmkkOs+DmCAp1vCqnX2FrmpyWiRwLt+q4slTf40ICGWCbK4tcon1aGLcS6R3TkMxTw==",
    "publicKeyHash": "PiRV5ko8JYGxAtcNb9WV4aVg7aXIp8EsstmeUqqWzT8=",
    "data": "kFNmPZi3KoR3pSV7EO3I1/M4Ss4zd5Zhia2dJhI9DGu03d5M9pwrMSVlmG21NqvR9cN9pSi592dgkQOmQhY01nU/IzV1FnKcdVmnhManjtsrwAe4u2S464gAraBtTWaVMbnHirTEJDE4WgKu/kIh+FpCE8kuzf/A+6XRJdsUraF/iu38fn+IzkwIGqiIjyAc92TM7hTA/pPToRL4dXhi/9dpBsr3F+6kjKbezoC9cMlHQMBG+Ulzb7R3ksLihfiI586X2EXYQ197zb1cZ3P4qcAr3a3tyKx1/6XJs8i+hB5mZHWy0108/XBi4RGg3et8H+h4RtVogqNMptw4oxzNR72UxAg65+LqZZx96M+ITPme33Jgjz2LWk3G3X4cx4Zox60PHh4siWPCW4OvuwtnuqpL/EldWavhR6ZVPoM1DU5p/VCnIPZy4Ilvh3XJFv0hmsOHDZnRQvrceH88KU/iyD3yweUtQbhJOIl0ZpL2KSuSMi42/kv0aOnYKgPTdCjgqJd99Sb1UBtpmqi3JU3OITTWjvUNjaZe0k3EuncTYfBDLsHXbCbORqRkMaMIgoCenhFF1g2bBBiQ6Yn/47cxthZBMmdpNkhsO+YDNNuxdghwR3Eqm2VMDa/HgkiDSgZEoisUWO6LfcMlcPC6Mb/fwWt1rKkIeQnQroFTTBhd8qxdH/Dxmmxpx3WlD8TtrLVB9eJ5VU7oNmmv1QYPTROuyFMgKg=="
  },
  "productMaterialType": "pvc",
  "requestPhysicalCard": false,
  "currency": "USD",
  "termsAcceptances": [
    {
      "termsIdentifier": "termsAndConditions",
      "termsAcceptanceDateTime": "2025-01-16T05:53:52.184Z",
      "termsAcceptanceFlag": true
    },
    {
      "termsIdentifier": "privPlcy",
      "termsAcceptanceDateTime": "2025-01-16T05:53:52.184Z",
      "termsAcceptanceFlag": true
    },
    {
      "termsIdentifier": "daa",
      "termsAcceptanceDateTime": "2025-01-16T05:53:52.184Z",
      "termsAcceptanceFlag": true
    },
    {
      "termsIdentifier": "eca",
      "termsAcceptanceDateTime": "2025-01-16T05:53:52.184Z",
      "termsAcceptanceFlag": true
    }
  ]
}

Sample Encrypted User Data

📘

This object is to be serialized as a string, and then encrypted using the public key provided by Green Dot Corporation.

{
  "DateOfBirth": "1988-02-02",
  "FirstName": "Second JWFA0ur4",
  "MiddleName": "Second",
  "LastName": "Second HSFrUNde",
  "Addresses": [
    {
      "AddressLine1": "16506 Cornell Rd",
      "AddressLine2": "SUITE 652",
      "City": "Cincinnati",
      "State": "OH",
      "ZipCode": "40983",
      "Type": "home",
      "IsDefault": true,
      "IsVerified": true
    }
  ],
  "email": {
    "emailAddress": "[email protected]",
    "isDefault": true,
    "IsVerified": true
  },
  "phoneNumbers": [
    {
      "number": "2153415457",
      "type": "Mobile",
      "isDefault": true,
      "IsVerified": true
    }
  ],
  "ssn": "103553311"
}    

Response

{
  "accountIdentifier": "16c6252f-0677-4fcd-8983-9d5375316a14",
  "status": "normal",
  "accountHolders": [
    {
      "firstName": "First IlVSPY4",
      "lastName": "First KqNGAL4",
      "userIdentifier": "e2c747de-8798-441f-9b8c-970d2ccfd406",
      "kycStateData": {
        "ofacStatus": "passed",
        "kycStatus": "passed",
        "kycPendingGate": "healthy"
      }
    },
    {
      "firstName": "Second Srb77Y6z",
      "lastName": "Second VLaHlcXE",
      "userIdentifier": "ae7a58b0-9ae1-44de-b163-e91aec6023f1",
      "kycStateData": {
        "ofacStatus": "passed",
        "kycStatus": "passed",
        "kycPendingGate": "healthy"
      }
    }
  ],
  "accountStatusReasons": [
    "healthy"
  ],
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "API operation was successful.",
      "url": "http://tbd"
    }
  ]
}

Unencrypted User Data Parameters

Related APIs Affected by Joint Accounts

Get Enrollment

This is an existing API and no contract changes, but will return two account holders for a joint account.

Get Account

This is an existing API and no contract changes, but will return two account holders for a joint account.

Get Payment Instruments

This is an existing API and no contract changes, but will return two account holders' payment instruments for a joint account.

ACH Transfer

This is an existing API and no contract changes for non-Joint Accounts, but has an added request validation on joint accounts. When the transfer type is achPull / achOut for joint accounts, userIdentifier field is required. If this field is missing, this property will get an error response.

Add BillPay Payment

This is an existing API, wherein the property userIdentifier is now added in the request body. When calling add BillPay payment for joint accounts, userIdentifier is required only for Joint Accounts and, if missing, this property will get error response.

Get Transaction

This is an existing API that for joint accounts has a response that is enhanced to include the userIdentifier who initiated the transaction.

WebHooks

For joint account, there is one more property userIdentifier to the webhooks request payload posted in certain scenarios. See link for more.