v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Account

Get Account Details

This endpoint allows the retrieval of detailed information about a specific account. If the GET request is successful, the following response message will be returned along with a 200 HTTP status code.

Note:UpgradeKycStateData will be return when customer upgrade their account to DDA

get/programs/{programCode}/accounts/{accountIdentifier}

Path parameters

programCodestring required

Partner program code for the account.

accountIdentifierstring required

Unique account identifier (UID or GUID).

Query parameters

extendstring

Optional. Set to "privatePaymentInstrumentData" to include sensitive payment instrument data.

Headers

X-GD-RequestIdstring required

Unique request tracking identifier (X-GD-RequestId header).

Response

prospectIdentifierstring nullable

The unique identifier for the prospect, if the account is in a prospect state.

Example response

{
  "prospectIdentifier": "04679c97-03d2-4671-9abe-87c912e7b6ec",
  "account": {
    "accountHolders": [
      {
        "user": {
          "firstName": "KxvPpGkR",
          "lastName": "wdhOmlUP",
          "dobStatus": "matched",
          "last4Identity": "9640",
          "identityType": "ssn",
          "userIdentifier": "d87885e7-641a-4fd8-bcce-ac42e90bc93f",
          "peerTransferAcceptPreference": "manual",
          "status": "active",
          "isPrimaryAccountHolder": true,
          "kycStateData": {
            "ofacStatus": "passed",
            "kycStatus": "passed",
            "kycPendingGate": "healthy"
          }
        },
        "accountHolderIdentifier": "abf4953d-723b-4702-88fe-829e4d6b24a2"
      }
    ],
    "accountIdentifier": "e1b9223a-dd1e-49a1-ad51-54bb843198ee",
    "accountReferenceNumber": "WOE4239372",
    "productCode": "50001",
    "currency": "USD",
    "status": "normal",
    "statusReasons": [
      "healthy"
    ],
    "accountStatusChangedDateTime": "2022-02-03T03:01:08.477Z",
    "directDepositInformation": {
      "accountNumber": "101014742460823",
      "routingNumber": "096017418"
    },
    "termsAcceptances": [
      {
        "termsIdentifier": "privPlcy",
        "termsAcceptanceDateTime": "2022-02-03T03:01:02.427Z",
        "termsAcceptanceFlag": false
      },
      {
        "termsIdentifier": "daa",
        "termsAcceptanceDateTime": "2022-02-03T03:01:02.427Z",
        "termsAcceptanceFlag": true
      },
      {
        "termsIdentifier": "eca",
        "termsAcceptanceDateTime": "2022-02-03T03:01:02.427Z",
        "termsAcceptanceFlag": true
      }
    ],
    "accountCycleDay": 2
  },
  "responseDetails": [
    {
      "code": 0,
      "subCode": 0,
      "description": "Success",
      "url": "http://tbd"
    }
  ]
}