{
"swagger" : "2.0",
"info" : {
"description" : "API sets created by the Australian Consumer Data Standards to meet the needs of the Consumer Data Right",
"version" : "1.10.0",
"title" : "Consumer Data Standards",
"contact" : {
"name" : "Consumer Data Standards",
"url" : "https://consumerdatastandards.org.au/",
"email" : "cdr-data61@csiro.au"
},
"license" : {
"name" : "MIT License",
"url" : "https://opensource.org/licenses/MIT"
}
},
"host" : "data.holder.com.au",
"basePath" : "/cds-au/v1",
"schemes" : [ "https" ],
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"paths" : {
"/banking/accounts" : {
"get" : {
"tags" : [ "Banking", "Accounts" ],
"summary" : "Get Accounts",
"description" : "Obtain a list of accounts",
"operationId" : "listAccounts",
"parameters" : [ {
"name" : "product-category",
"in" : "query",
"description" : "Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.",
"required" : false,
"type" : "string",
"enum" : [ "BUSINESS_LOANS", "CRED_AND_CHRG_CARDS", "LEASES", "MARGIN_LOANS", "OVERDRAFTS", "PERS_LOANS", "REGULATED_TRUST_ACCOUNTS", "RESIDENTIAL_MORTGAGES", "TERM_DEPOSITS", "TRADE_FINANCE", "TRANS_AND_SAVINGS_ACCOUNTS", "TRAVEL_CARDS" ]
}, {
"name" : "open-status",
"in" : "query",
"description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed",
"required" : false,
"type" : "string",
"default" : "ALL",
"enum" : [ "ALL", "CLOSED", "OPEN" ]
}, {
"name" : "is-owned",
"in" : "query",
"description" : "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts",
"required" : false,
"type" : "boolean",
"x-cds-type" : "Boolean"
}, {
"name" : "page",
"in" : "query",
"description" : "Page of results to request (standard pagination)",
"required" : false,
"type" : "integer",
"default" : 1,
"x-cds-type" : "PositiveInteger"
}, {
"name" : "page-size",
"in" : "query",
"description" : "Page size to request. Default is 25 (standard pagination)",
"required" : false,
"type" : "integer",
"default" : 25,
"x-cds-type" : "PositiveInteger"
}, {
"name" : "x-v",
"in" : "header",
"description" : "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)",
"required" : true,
"type" : "string"
}, {
"name" : "x-min-v",
"in" : "header",
"description" : "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.",
"required" : false,
"type" : "string"
}, {
"name" : "x-fapi-interaction-id",
"in" : "header",
"description" : "An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.",
"required" : false,
"type" : "string"
}, {
"name" : "x-fapi-auth-date",
"in" : "header",
"description" : "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.",
"required" : false,
"type" : "string"
}, {
"name" : "x-fapi-customer-ip-address",
"in" : "header",
"description" : "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
"required" : false,
"type" : "string"
}, {
"name" : "x-cds-client-headers",
"in" : "header",
"description" : "The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.",
"required" : false,
"type" : "string",
"x-cds-type" : "Base64"
} ],
"responses" : {
"200" : {
"description" : "Success",
"headers" : {
"x-v" : {
"type" : "string",
"description" : "The [version](#response-headers) of the API end point that the data holder has responded with."
},
"x-fapi-interaction-id" : {
"type" : "string",
"description" : "An [RFC4122](https://tools.ietf.org/html/rfc4122) UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction."
}
},
"schema" : {
"$ref" : "#/definitions/ResponseBankingAccountList"
}
},
"4xx" : {
"description" : "The following error codes MUST be supported: