Account

Get sub-accounts

Get sub-accounts for a given account and program

get/account/{AccountIdentifier}/program/{ProgramCode}/subaccounts

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/program/:ProgramCode/subaccounts/get.ts
A function with typed inputs. Its response is checked against the schema.

AccountIdentifierstring required

Account identifier

ProgramCodestring required

Ref.Data.PROGRAM

Any program code. Ref.Data.PROGRAM

List of sub-accounts

codestring required

Unique identifier.

namestring required

Name of the Sub-Account in the registry.

subAccountTypestring required

Type of registry sub-account. Ref.Data.SUBACCOUNT_REGISTRY_TYPE

activeboolean required

True/False.

publicboolean required

True/False.

complianceStatusstring

Flag for whether sub-account is for compliance retirement activity. Ref.Data.COMPLIANCE_STATUS

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