Account

Search for account

get/account/{AccountIdentifier}

Request

Base URL
https://sandbox.preprod.connect.xpansiv.com/app/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/account/:AccountIdentifier/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

AccountIdentifierstring required

Account identifier

Query parameters

includestring

Comma-separated values from optional response fields

Response

Account found

idinteger required

identifierstring required

noOfUsersinteger required

statusstring required

Ref.Data.ACCOUNT_STATUS

maxUsersnumber required

childAccountsAccount[] required circular

Example response

{
  "identifier": "0980A123",
  "status": "APPROVED",
  "organization": {
    "legalName": "RVCMC Sub Default",
    "structure": "PRIVATELY_OWNED_CORP",
    "type": "BROKER"
  },
  "services": [
    {
      "status": "APPROVED",
      "type": "ACX",
      "attributes": {
        "retirementSubaccountCodes": {
          "ACR": [
            "12345"
          ],
          "CAR": [],
          "VCS": [
            "43134",
            "32141"
          ]
        },
        "linkedRegistryAccountIds": {
          "ACR": "098765",
          "CAR": null,
          "VCS": "567890"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.