{
"openapi" : "3.0.3",
"info" : {
"contact" : {
"email" : "contact@consumerdatastandards.gov.au",
"name" : "Consumer Data Standards",
"url" : "https://consumerdatastandards.gov.au"
},
"description" : "Consumer Data Standards APIs created by the Data Standards Body (DSB), with the Data Standards Chair as the decision maker to meet the needs of the Consumer Data Right",
"license" : {
"name" : "MIT License",
"url" : "https://opensource.org/licenses/MIT"
},
"title" : "CDR Banking API",
"version" : "1.22.1"
},
"servers" : [ {
"url" : "https://data.holder.com.au/cds-au/v1"
} ],
"paths" : {
"/banking/accounts" : {
"get" : {
"description" : "Obtain a list of accounts.\n\nObsolete versions: [v1](includes/obsolete/get-accounts-v1.html)",
"operationId" : "listAccounts",
"parameters" : [ {
"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.)",
"explode" : true,
"in" : "query",
"name" : "product-category",
"required" : false,
"schema" : {
"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" ],
"type" : "string"
},
"style" : "form"
}, {
"description" : "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed",
"explode" : true,
"in" : "query",
"name" : "open-status",
"required" : false,
"schema" : {
"default" : "ALL",
"enum" : [ "ALL", "CLOSED", "OPEN" ],
"type" : "string"
},
"style" : "form"
}, {
"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",
"explode" : true,
"in" : "query",
"name" : "is-owned",
"required" : false,
"schema" : {
"type" : "boolean",
"x-cds-type" : "Boolean"
},
"style" : "form",
"x-cds-type" : "Boolean"
}, {
"description" : "Page of results to request (standard pagination)",
"explode" : true,
"in" : "query",
"name" : "page",
"required" : false,
"schema" : {
"default" : 1,
"type" : "integer",
"x-cds-type" : "PositiveInteger"
},
"style" : "form",
"x-cds-type" : "PositiveInteger"
}, {
"description" : "Page size to request. Default is 25 (standard pagination)",
"explode" : true,
"in" : "query",
"name" : "page-size",
"required" : false,
"schema" : {
"default" : 25,
"type" : "integer",
"x-cds-type" : "PositiveInteger"
},
"style" : "form",
"x-cds-type" : "PositiveInteger"
}, {
"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)",
"explode" : false,
"in" : "header",
"name" : "x-v",
"required" : true,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"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.",
"explode" : false,
"in" : "header",
"name" : "x-min-v",
"required" : false,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"explode" : false,
"in" : "header",
"name" : "x-fapi-interaction-id",
"required" : false,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"description" : "The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.",
"explode" : false,
"in" : "header",
"name" : "x-fapi-auth-date",
"required" : false,
"schema" : {
"type" : "string",
"x-conditional" : true
},
"style" : "simple",
"x-conditional" : true
}, {
"description" : "The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
"explode" : false,
"in" : "header",
"name" : "x-fapi-customer-ip-address",
"required" : false,
"schema" : {
"type" : "string"
},
"style" : "simple"
}, {
"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 Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.",
"explode" : false,
"in" : "header",
"name" : "x-cds-client-headers",
"required" : false,
"schema" : {
"type" : "string",
"x-conditional" : true,
"x-cds-type" : "Base64"
},
"style" : "simple",
"x-conditional" : true,
"x-cds-type" : "Base64"
} ],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResponseBankingAccountListV2"
}
}
},
"description" : "Success",
"headers" : {
"x-v" : {
"description" : "The [version](#response-headers) of the API end point that the data holder has responded with.",
"explode" : false,
"schema" : {
"type" : "string"
},
"style" : "simple"
},
"x-fapi-interaction-id" : {
"description" : "An **[[RFC4122]](#nref-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]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.",
"explode" : false,
"schema" : {
"type" : "string"
},
"style" : "simple"
}
}
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResponseErrorListV2"
}
}
},
"description" : "The following error codes MUST be supported: