{
"openapi": "3.0.1",
"info": {
"title": "Platform",
"description": "All included utility endpoints for Basiq partners",
"version": "3.0.0",
"termsOfService": "https://docs.basiq.io/en/collections/440849-privacy-terms-and-common-questions",
"license": {
"name": "Commercial",
"url": "https://basiq.io"
}
},
"servers": [
{
"url": "https://au-api.basiq.io"
}
],
"paths": {
"/users/{userId}/auth_link": {
"post": {
"tags": [
"AuthLinks"
],
"summary": "Create an auth_link",
"description": "Create a new auth_link object by making a POST request to the auth_link endpoint. The new auth_link will effectively delete previous auth_link for that user, rendering the previous URL(s) invalid.\n\nThe 'mobile' attribute is used for 2FA SMS verification and is conditionally required. If it is not specified, we will look up the mobile on the user object; if that is not specified either, you will get an error. If both are specified, the mobile number on the auth_link will take precedence.",
"operationId": "postAuthLink",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mobile": {
"type": "string"
}
}
}
}
},
"required": false
},
"responses": {
"201": {
"description": "Returns a created auth_link resource, if the operation succeeded",
"content": {
"application/json": {
"schema": {
"required": [
"mobile",
"type",
"userId",
"expiresAt"
],
"type": "object",
"properties": {
"mobile": {
"type": "string",
"description": "A user's mobile phone, used as for authentication.",
"example": 61410000000
},
"type": {
"type": "string",
"description": "Type of the response, always \"auth_link\".",
"example": "auth_link"
},
"userId": {
"type": "string",
"description": "A string that uniquely identifies the user.",
"example": "ec4ea48d"
},
"expiresAt": {
"type": "string",
"description": "The date time of auth link expiry.",
"example": "2019-11-21T04:08:50Z"
},
"links": {
"required": [
"public",
"self"
],
"type": "object",
"properties": {
"public": {
"type": "string",
"description": "Public URL of auth link.",
"example": "https://connect.basiq.io/63448be4"
},
"self": {
"type": "string",
"description": "URL of the resource",
"example": "/users/ec4ea48d/auth_link"
}
},
"x-readme-ref-name": "AuthLinkLinks"
}
},
"x-readme-ref-name": "AuthLinksPostResponseResource"
}
}
}
},
"400": {
"description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "ID value is not valid."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
}
}
}
},
"403": {
"description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"404": {
"description": "Returns error indicating that server can't find requested resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
},
"get": {
"tags": [
"AuthLinks"
],
"summary": "Retrieve an auth_link",
"description": "Returns the latest/last auth_link generated for the specified user. Returns an error otherwise.",
"operationId": "getAuthLink",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The identifier of the user.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns details of a connection.",
"content": {
"application/json": {
"schema": {
"required": [
"id",
"mobile",
"type",
"expiresAt",
"userId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Uniquely identifies the auth link.",
"example": "63448be4"
},
"mobile": {
"type": "string",
"description": "A user's mobile phone, used as for authentication.",
"example": 61410000000
},
"type": {
"type": "string",
"description": "Type of the response, always \"auth_link\".",
"example": "auth_link"
},
"userId": {
"type": "string",
"description": "A string that uniquely identifies the user.",
"example": "ec4ea48d"
},
"expiresAt": {
"type": "string",
"description": "The date time of auth link expiry.",
"example": "2019-11-21T04:08:50Z"
},
"links": {
"required": [
"public",
"self"
],
"type": "object",
"properties": {
"public": {
"type": "string",
"description": "Public URL of auth link.",
"example": "https://connect.basiq.io/63448be4"
},
"self": {
"type": "string",
"description": "URL of the resource",
"example": "/users/ec4ea48d/auth_link"
}
},
"x-readme-ref-name": "AuthLinkLinks"
}
},
"x-readme-ref-name": "AuthLinksResponseResource"
}
}
}
},
"400": {
"description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "ID value is not valid."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
}
}
}
},
"403": {
"description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"404": {
"description": "Returns error indicating that server can't find requested resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"410": {
"description": "Returns error indicating that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-no-longer-available",
"enum": [
"resource-no-longer-available"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem."
},
"title": {
"type": "string",
"description": "Title of the error"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "GoneError"
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Returns error response code indicates that the server is not ready to handle the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
},
"delete": {
"tags": [
"AuthLinks"
],
"summary": "Delete an auth_link",
"description": "Note that this action cannot be undone.
\n\nThe auth_link is a URL that directs a User to Basiq's hosted consent workflow to link banks and securely share data. When the user selects 'I have disclosed all my accounts' the auth_link is automatically deleted.
\n\nReturns an empty body if the delete succeeded. Otherwise, this call returns an error in the event of a failure.",
"operationId": "deleteAuthLink",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The identifier of the user.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Returns an empty body if the delete succeeded.",
"content": {}
},
"400": {
"description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "ID value is not valid."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
}
}
}
},
"404": {
"description": "Returns error indicating that server can't find requested resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Returns error response code indicates that the server is not ready to handle the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
},
"/events": {
"get": {
"tags": [
"Events"
],
"summary": "List all events",
"description": "Returns a list of all events that have taken place.",
"operationId": "getEvents",
"parameters": [
{
"name": "filter",
"in": "query",
"description": "Retrieves the details of all events associated with a user.\n\n**Note:** This endpoint only returns events that happened in the last 7 days.\n\n**Filtering Options:**\n- `userId`: User ID for the specific user you wish to retrieve events for. e.g., `user.id.eq(userId)`\n- `entity`: Filter events by entity type. e.g., `event.entity.eq(entity)`\n- `type`: Filter events by event type. e.g., `event.type.eq(type)`\n",
"schema": {
"type": "string",
"example": "user.id.eq(userId) OR event.entity.eq(entity), event.type.eq(type)"
}
}
],
"responses": {
"200": {
"description": "Returns details of events.",
"content": {
"application/json": {
"schema": {
"title": "EventsGetResponseResource",
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type, always \"list\".",
"example": "list"
},
"data": {
"type": "array",
"items": {
"required": [
"createdDate",
"id",
"links",
"type",
"entity",
"userId",
"dataRef",
"data",
"eventType"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type, always \"event\".",
"example": "event"
},
"id": {
"type": "string",
"description": "Event identification.",
"example": "61723"
},
"createdDate": {
"type": "string",
"description": "Date the event was created.",
"example": "2019-07-29T07:34:09Z"
},
"entity": {
"type": "string",
"description": "The entity associated with the event that has occurred",
"example": "consent",
"enum": [
"consent",
"connection"
]
},
"eventType": {
"type": "string",
"description": "The type of event that has occurred",
"example": "revoked",
"enum": [
"revoked",
"expired",
"updated",
"created",
"archived",
"deleted"
]
},
"userId": {
"type": "string",
"description": "The identifier of the user the event belongs to.",
"example": "266f5849-6ef6-4aae-accf-386470d0598e"
},
"dataRef": {
"type": "string",
"description": "URL to the data source the event occurred.",
"example": "https://au-api.basiq.io/users/266f5849-6ef6-4aae-accf-386470d0598e"
},
"data": {
"type": "string",
"description": "The data associated with the event that has been created.",
"example": [
{
"email": "max@hooli.com",
"id": "266f5849-6ef6-4aae-accf-386470d0598e",
"links": {
"self": "https://au-api.basiq.io/users/266f5849-6ef6-4aae-accf-386470d0598e"
},
"mobile": "+614xxxxxxxx",
"type": "user"
}
]
},
"links": {
"example": [
{
"self": "https://au-api.basiq.io/events/545ae104289e71bd3da34a063aaf49a5fa17ab6b8e0cab4bc56e019b7cc409e0"
}
]
}
},
"x-readme-ref-name": "EventsData"
}
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing details for connections.",
"x-readme-ref-name": "EventsGetResponseResource"
}
}
}
},
"400": {
"description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "ID value is not valid."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
},
"examples": {
"Bad Request": {
"value": {
"type": "list",
"correlationId": "ac5ah5i",
"data": [
{
"type": "error",
"title": "Parameter not valid.",
"code": "parameter-not-valid",
"detail": "ID value is not valid.",
"source": {
"parameter": "id"
}
}
]
}
},
"Invalid Filters": {
"value": {
"type": "list",
"correlationId": "ac5ah55",
"data": [
{
"type": "error",
"code": "parameter-not-valid",
"title": "Parameter value is not valid",
"detail": "The provided filter parameter is in invalid format or unsupported",
"source": {
"parameter": "filter"
}
}
]
}
}
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
}
}
}
},
"403": {
"description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"404": {
"description": "Returns error indicating that server can't find requested resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Returns error response code indicates that the server is not ready to handle the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
},
"/events/{id}": {
"get": {
"tags": [
"Events"
],
"summary": "Retrieve an event",
"description": "Returns a single event type based on the parameter input.",
"operationId": "getTypeById",
"parameters": [
{
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"in": "path",
"example": "a0fa1d01e0c9a1032e29ac74ade5f786e880ae04f4e3788144c6d13b53e5d29b"
}
],
"responses": {
"200": {
"description": "Returns the ID of an event.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"createdDate": {
"type": "string"
},
"entity": {
"type": "string"
},
"eventType": {
"type": "string"
},
"userId": {
"type": "string"
},
"dataRef": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"createdDate": {
"type": "string"
},
"id": {
"type": "string"
},
"institution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
},
"type": {
"type": "string"
}
}
},
"lastUsed": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"accounts": {
"type": "string"
},
"self": {
"type": "string"
},
"transactions": {
"type": "string"
}
}
},
"mfaEnabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "RetrieveEvent"
},
"examples": {
"Success": {
"value": {
"type": "event",
"id": "5a47115a7eed80a3b68761b725b78c75892e94cef06810ecc0e2e7b856738371",
"createdDate": "2024-04-17T23:57:17Z",
"entity": "connection",
"eventType": "updated",
"userId": "84e33255-f65f-4f05-953b-1b12e1e4d90b",
"dataRef": "https://au-api.basiq.io/users/84e33255-f65f-4f05-953b-1b12e1e4d90b/connections/8bd4f752-c218-4e41-af28-0c42ae982d35",
"data": {
"createdDate": "2024-04-17T23:57:16Z",
"id": "8bd4f752-c218-4e41-af28-0c42ae982d35",
"institution": {
"id": "AU00000",
"links": {
"self": "https://au-api.basiq.io/institutions/AU00000"
},
"type": "institution"
},
"lastUsed": "2024-04-17T23:57:17Z",
"links": {
"accounts": "https://au-api.basiq.io/users/84e33255-f65f-4f05-953b-1b12e1e4d90b/accounts?filter=institution.id.eq('AU00000')",
"self": "https://au-api.basiq.io/users/84e33255-f65f-4f05-953b-1b12e1e4d90b/connections/8bd4f752-c218-4e41-af28-0c42ae982d35",
"transactions": "https://au-api.basiq.io/users/84e33255-f65f-4f05-953b-1b12e1e4d90b/transactions?filter=institution.id.eq('AU00000')"
},
"mfaEnabled": false,
"status": "active",
"type": "connection"
},
"links": {
"self": "https://au-api.basiq.io/events/5a47115a7eed80a3b68761b725b78c75892e94cef06810ecc0e2e7b856738371"
}
}
}
}
}
}
},
"400": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Parameter not valid": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "path-parameter-not-valid",
"title": "Parameter value is not valid",
"detail": "Event Type ID parameter is not valid",
"source": {
"parameter": "eventTypeId"
}
}
]
}
}
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Unauthorized": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "unauthorized-access",
"title": "Unauthorized Access",
"detail": "You are not authorized to access this resource"
}
]
}
}
}
}
}
},
"403": {
"description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Error": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "resource-not-found",
"title": "Requested resource is not found",
"detail": "Requested event type does not exist."
}
]
}
}
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Too many requests": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "too-many-requests",
"title": "Too many requests",
"detail": "Query limit reached."
}
]
}
}
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Returns error response code indicates that the server is not ready to handle the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
},
"/events/types": {
"get": {
"tags": [
"Events"
],
"summary": "List event types",
"description": "Returns a list of event types.",
"operationId": "listEventTypes",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"count": {
"type": "integer"
},
"size": {
"type": "integer"
},
"data": {
"type": "array",
"description": "one or more events that the webhook would send messages for.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"description": "Identifer of the event type",
"example": "user.created"
},
"description": {
"type": "string",
"description": "a brief description of the event type",
"example": "when a user is created"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "EventType"
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"next": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "EventTypes"
},
"examples": {
"Success": {
"value": {
"type": "list",
"size": 15,
"count": 15,
"data": [
{
"type": "eventType",
"id": "account.updated",
"description": "when an account is updated",
"links": {
"self": "https://au-api.basiq.io/events/types/account.updated"
}
},
{
"type": "eventType",
"id": "connection.activated",
"description": "when a connection is activated",
"links": {
"self": "https://au-api.basiq.io/events/types/connection.activated"
}
},
{
"type": "eventType",
"id": "connection.created",
"description": "when a connection is created",
"links": {
"self": "https://au-api.basiq.io/events/types/connection.created"
}
},
{
"type": "eventType",
"id": "connection.deleted",
"description": "when a connection is deleted",
"links": {
"self": "https://au-api.basiq.io/events/types/connection.deleted"
}
},
{
"type": "eventType",
"id": "connection.invalidated",
"description": "when a connection is invalidated",
"links": {
"self": "https://au-api.basiq.io/events/types/connection.invalidated"
}
},
{
"type": "eventType",
"id": "consent.created",
"description": "when a consent is created",
"links": {
"self": "https://au-api.basiq.io/events/types/consent.created"
}
},
{
"type": "eventType",
"id": "consent.expired",
"description": "when a consent is expired",
"links": {
"self": "https://au-api.basiq.io/events/types/consent.expired"
}
},
{
"type": "eventType",
"id": "consent.reminder",
"description": "when a consent has been active for 90 days since the last update",
"links": {
"self": "https://au-api.basiq.io/events/types/consent.reminder"
}
},
{
"type": "eventType",
"id": "consent.revoked",
"description": "when a consent is revoked",
"links": {
"self": "https://au-api.basiq.io/events/types/consent.revoked"
}
},
{
"type": "eventType",
"id": "consent.updated",
"description": "when a consent is updated",
"links": {
"self": "https://au-api.basiq.io/events/types/consent.updated"
}
},
{
"type": "eventType",
"id": "consent.warning",
"description": "when a consent is about to expire",
"links": {
"self": "https://au-api.basiq.io/events/types/consent.warning"
}
},
{
"type": "eventType",
"id": "transactions.updated",
"description": "when transactions are updated",
"links": {
"self": "https://au-api.basiq.io/events/types/transactions.updated"
}
},
{
"type": "eventType",
"id": "user.created",
"description": "when an user is created",
"links": {
"self": "https://au-api.basiq.io/events/types/user.created"
}
},
{
"type": "eventType",
"id": "user.deleted",
"description": "when an user is deleted",
"links": {
"self": "https://au-api.basiq.io/events/types/user.deleted"
}
},
{
"type": "eventType",
"id": "user.updated",
"description": "when an user is updated",
"links": {
"self": "https://au-api.basiq.io/events/types/user.updated"
}
}
],
"links": {
"self": "https://au-api.basiq.io/events/types/"
}
}
}
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Unauthorized": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "unauthorized-access",
"title": "Unauthorized Access",
"detail": "You are not authorized to access this resource"
}
]
}
}
}
}
}
},
"403": {
"description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Too many requests": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "too-many-requests",
"title": "Too many requests",
"detail": "Query limit reached."
}
]
}
}
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Returns error response code indicates that the server is not ready to handle the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
},
"/events/types/{id}": {
"get": {
"tags": [
"Events"
],
"summary": "Retrieve an event type",
"description": "Returns a single event type based on the parameter input.",
"operationId": "getEventTypeById",
"parameters": [
{
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"in": "path",
"example": "user.created"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"description": "Identifer of the event type",
"example": "user.created"
},
"description": {
"type": "string",
"description": "a brief description of the event type",
"example": "when a user is created"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "EventType"
},
"examples": {
"Success": {
"value": {
"id": "account.updated",
"description": "when an account is updated",
"links": {
"self": "https://au-api.basiq.io/events/types/account.updated"
}
}
}
}
}
}
},
"400": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Parameter not valid": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "path-parameter-not-valid",
"title": "Parameter value is not valid",
"detail": "Event Type ID parameter is not valid",
"source": {
"parameter": "eventTypeId"
}
}
]
}
}
}
}
}
},
"401": {
"description": "Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Unauthorized": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "unauthorized-access",
"title": "Unauthorized Access",
"detail": "You are not authorized to access this resource"
}
]
}
}
}
}
}
},
"403": {
"description": "Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Error": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "resource-not-found",
"title": "Requested resource is not found",
"detail": "Requested event type does not exist."
}
]
}
}
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"examples": {
"Too many requests": {
"value": {
"type": "list",
"correlationId": "9b27dbd7-d397-428a-9eff-5048d2bed5eb",
"data": [
{
"type": "error",
"code": "too-many-requests",
"title": "Too many requests",
"detail": "Query limit reached."
}
]
}
}
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Returns error response code indicates that the server is not ready to handle the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
},
"/users/{userId}/statements": {
"post": {
"tags": [
"Statements"
],
"summary": "Create a statement",
"description": "Create a new statement by uploading an official PDF bank statement or CSV file. The server will create a job that processes the following steps:\n1. **verify-credentials**: Verify the file, validate the layout, and attempt to parse the statement.\n2. **retrieve-accounts**: Retrieve the list of accounts and their details (account number, name, balances).\n3. **retrieve-transactions**: Fetch the transactions for each account.\n\nThe status of each step can be checked by querying the Retrieve a job. \n\n> Note that this function is not supported in sandbox environments (AU00000).\n\nFor CSV file format specifications, please contact our support team.\n\n> 🚧 \n> \n> Note that the time it takes to complete the processes above will vary depending on the volume of data along with the complexity of the bank statement. As a rough guide this entire process could take anywhere between 10 - 30 secs. Upload multiple statements in parallel to provide the best user experience",
"operationId": "createStatement",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The unique identifier of the user"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"institutionId",
"statement"
],
"properties": {
"institutionId": {
"type": "string",
"description": "The identifier of the institution to which the statement relates (e.g., \"AU01001\"). **Note**: Sandbox institutions (AU00000) do not support file uploads."
},
"statement": {
"type": "string",
"format": "binary",
"description": "The official PDF bank statement or CSV file to be uploaded. CSV files must conform to the file specification provided by Basiq."
}
}
}
}
}
},
"responses": {
"202": {
"description": "Job resource created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"type",
"id",
"links"
],
"properties": {
"type": {
"type": "string",
"description": "The type of resource, always \"job\".",
"example": "job"
},
"id": {
"type": "string",
"description": "The unique identifier of the job.",
"example": "61723"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/users/cd6fbd92/accounts/319ae910"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing details for the statement upload process",
"x-readme-ref-name": "StatementUploadResource"
}
}
}
},
"400": {
"description": "Bad request due to missing or invalid parameters",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "The provided filter parameter is in invalid format or unsupported."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "userId"
},
"pointer": {
"type": "string",
"description": "Location to the object or attribute that the error relates to.",
"example": "users/userId"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
}
}
}
},
"403": {
"description": "Forbidden access due to insufficient permissions",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "userId"
},
"pointer": {
"type": "string",
"description": "Location to the object or attribute that the error relates to.",
"example": "users/userId"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "ForbiddenAccessError"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
},
"503": {
"description": "Service unavailable",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
}
}
}
}
}
}
},
"/connectors": {
"get": {
"tags": [
"Connectors"
],
"summary": "Retrieve connectors",
"description": "NOTE: This end point requires authentication.",
"operationId": "getConnectors",
"parameters": [
{
"name": "filter",
"in": "query",
"description": "Filter parameter can be used to filter connector list by connector property. This parameter should contain a comma-separated list of filter statements.\nA filter statement is composed of the entity name (in this case, it is always 'connector'), the property name (e.g., 'stage'), the filter operator (e.g., 'eq'), and the quoted string value in parentheses (e.g., \"('live')\").\nThe following list of regular expressions describes acceptable filter statements:\n• (connector).(id).(eq)\\(('[A-Z][A-Z][0-9]{5}')\\)\n• (connector).(method).(eq)\\(('web'||'open-banking'|'pdf'|'csv')\\)\n• (connector).(status).(eq|ne)\\(('operational'|'degraded-performance'|'partial-outage'|'major-outage'|'under-maintenance')\\)\n• (connector).(status).(in)\\(([\\w\\W]+)\\)\n• (connector).(stage).(eq|ne)\\(('live'|'beta'|'alpha')\\)\n• (connector).(stage).(in)\\(([\\w\\W]+)\\)\n• (connector).(scopes).(in|eq|ne)\\(([\\w\\W]+)\\)\n• (connector).(institution).(country).(eq|ne)\\(('Australia'|'New Zealand')\\)\n• (connector).(institution).(country).(in)\\(([\\w\\W]+)\\)\n• (connector).(institution).(tier).(eq|ne)\\(('1'|'2'|'3'|'4')\\)\n• (connector).(institution).(tier).(in)\\(([\\W\\d]+)\\)\n• (connector).(institution).(type).(eq|ne)\\(('Bank'|'Bank (Foreign)'|'Test Bank'|'Credit Union'|'Financial Services'|'Superannuation')\\)\n• (connector).(authorization).(type).(eq|ne)\\(('user'|'user-mfa'|'user-mfa-intermittent'|'other'|'token')\\)\n• (connector).(authorization).(type).(in)\\(([\\w\\W]+)\\)\n• (connector).(connectorEngine).(eq|ne)\\(('chrome'|'node')\\)\nMultiple filter definitions should be separated with a comma (,).\nFor example, this filter statement will keep only live tier 1 and tier 2 institutions: filter=connector.stage.eq('live'),connector.institution.tier.in('1','2')",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns data of single connector.",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"totalCount",
"data",
"links"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type identifies response data format",
"example": "list",
"x-readme-ref-name": "ResponseFormat"
},
"totalCount": {
"type": "integer",
"description": "TotalCount contains total count of connectors",
"format": "int64",
"example": 328
},
"data": {
"type": "array",
"description": "Data contains list of connectors",
"items": {
"required": [
"type",
"id",
"institution",
"method",
"stage",
"stats",
"status",
"scopes",
"authorization"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Resource type identifier. It is always \"connector\" for this model.\nconnector ConnectorEntityType",
"example": "connector",
"enum": [
"connector"
]
},
"id": {
"maxLength": 7,
"minLength": 7,
"pattern": "^[A-Z]{2}[0-9]{5}$",
"type": "string",
"description": "Institution ID",
"example": "AU00000"
},
"method": {
"type": "string",
"description": "Current Connector method",
"example": "web",
"enum": [
"web",
"open-banking",
"csv",
"pdf"
]
},
"stage": {
"type": "string",
"description": "Current Connector stage",
"example": "beta"
},
"status": {
"type": "string",
"description": "FeatureCondition type that describes an feature status for institution",
"x-readme-ref-name": "FeatureCondition"
},
"institution": {
"required": [
"type",
"name",
"shortName",
"tier",
"country",
"logo"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Institution type identifier\nBank BankInstitutionType BankInstitutionType institution type identifier for Banks\nBank (Foreign) BankForeignInstitutionType BankForeignInstitutionType institution type identifier for Foreign banks\nTest Bank TestBankInstitutionType TestBankInstitutionType institution type identifier for Test banks\nCredit Union CreditUnionInstitutionType CreditUnionInstitutionType institution type identifier for Credit union institutions\nFinancial Services FinancialServicesInstitutionType FinancialServicesInstitutionType institution type identifier for Financial service institutions\nSuperannuation SuperannuationInstitutionType SuperannuationInstitutionType institution type identifier for Superannuation institutions\nBuilding Society BuildingSociety BuildingSociety institution type identifier for Building Society institutions\nGovernment Government Government institution type identifier for Government institutions",
"example": "Bank",
"enum": [
"Bank",
"Bank (Foreign)",
"Test Bank",
"Credit Union",
"Financial Services",
"Superannuation",
"Building Society",
"Government"
]
},
"name": {
"type": "string",
"description": "Institution name",
"example": "Hooli Bank"
},
"shortName": {
"type": "string",
"description": "Institution short name",
"example": "Hooli"
},
"tier": {
"type": "string",
"description": "Institution tier identifier\n1 TierOne TierOne tier identifier for tier1 institution\n2 TierTwo TierTwo tier identifier for tier2 institution\n3 TierThree TierThree tier identifier for tier3 institution\n4 TierFour TierFour tier identifier for tier4 institution",
"example": "1",
"enum": [
"1",
"2",
"3",
"4"
]
},
"country": {
"type": "string",
"description": "Institution country name",
"example": "Australia"
},
"cdrFAQ": {
"type": "string",
"description": "A link for Data Holder (where available) to a page explaining CDR data sharing process.\n",
"example": "https://example.com/banking/help-support/open-banking.html"
},
"cdrEmail": {
"type": "string",
"description": "The email address for CDR-related inquiries.",
"example": "openbanking.dataholdersupport@example.com.au"
},
"cdrPolicy": {
"type": "string",
"description": "The URL to the CDR policy document detailing the institution's data practices and consumer rights.",
"example": "https://www.example.com.au/CDRpolicy"
},
"cdrProviderNumber": {
"type": "string",
"description": "A unique identifier assigned to the CDR institution by the CDR program.",
"example": "DHBNK000111"
},
"abn": {
"type": "string",
"description": "ABN for the Data Holder ( only available in openbanking ).",
"example": "87087651111"
},
"acn": {
"type": "string",
"description": "ACN for the Data Holder ( only available in openbanking ).",
"example": "087651111"
},
"logo": {
"required": [
"links",
"type"
],
"type": "object",
"properties": {
"colors": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "Primary primary institution color"
}
},
"description": "Colors contains institution colors type",
"x-readme-ref-name": "Colors"
},
"links": {
"required": [
"full",
"square"
],
"type": "object",
"properties": {
"full": {
"type": "string",
"description": "URL to full size logo",
"example": "https://example.com/AU00000-full.svg"
},
"square": {
"type": "string",
"description": "Square formatted logo URL",
"example": "https://example.com/AU00000.svg"
}
},
"description": "institution logo resource links",
"x-readme-ref-name": "LogoResourceLinks"
},
"type": {
"type": "string",
"description": "Resource type identifier.\nimage ImageResourceType",
"example": "image",
"enum": [
"image"
]
}
},
"description": "Institution logo resource type",
"x-readme-ref-name": "InstitutionLogoResource"
}
},
"description": "ConnectorInstitutionResource connector Institution resource type",
"x-readme-ref-name": "ConnectorInstitutionResource"
},
"scopes": {
"type": "array",
"description": "Connector scopes array",
"items": {
"type": "string",
"example": "customer.person.basic"
}
},
"authorization": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Authorization type identifier\nuser AuthorizationUser AuthorizationUser \"User\" authorization type identifier\ntoken AuthorizationToken AuthorizationToken \"Token\" authorization type identifier\nother AuthorizationOther AuthorizationOther \"Other\" authorization type identifier\nuser-mfa AuthorizationUserMfa AuthorizationUserMfa \"UserMfa\" authorization type identifier\nuser-mfa-intermittent AuthorizationUserMfaIntermittent AuthorizationUserMfaIntermittent \"UserMfaIntermittent\" authorization type identifier",
"example": "user",
"enum": [
"user",
"token",
"other",
"user-mfa",
"user-mfa-intermittent"
]
},
"meta": {
"type": "object",
"properties": {
"forgotten_password_url": {
"type": "string",
"description": "URL to institution forgotten password page",
"example": "https://example.com/forgotten-password"
},
"login_id_caption": {
"type": "string",
"description": "Login ID field caption that should be shown on UI",
"example": "User name"
},
"password_caption": {
"type": "string",
"description": "Password field caption that should be shown on UI",
"example": "Password"
},
"secondary_login_id_caption": {
"type": "string",
"description": "Secondary loginID caption that should be shown on UI",
"example": "Secondary login id"
},
"security_code_caption": {
"type": "string",
"description": "Security code caption that should be shown on UI",
"example": "Security code"
}
},
"x-readme-ref-name": "ConnectorAuthorizationMeta"
}
},
"x-readme-ref-name": "ConnectorAuthorization"
},
"stats": {
"type": "object",
"properties": {
"averageDurationMs": {
"type": "object",
"properties": {
"retrieveAccounts": {
"type": "integer",
"description": "Connector average duration in milliseconds of fetch accounts step for institution",
"format": "int64"
},
"retrieveMeta": {
"type": "integer",
"description": "Connector average duration in milliseconds of fetch metadata step for institution",
"format": "int64"
},
"retrieveTransactions": {
"type": "integer",
"description": "Connector average duration in milliseconds of fetch transactions step for institution",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total connector average duration in milliseconds",
"format": "int64"
},
"verifyCredentials": {
"type": "integer",
"description": "Connector average duration in milliseconds of verifiy credentials step for institution",
"format": "int64"
}
},
"description": "AverageDurationMs average connector duration in milliseconds per segments.\nWhen durations are not known for institution this field will be `null`."
}
},
"description": "InstitutionPerformanceStats response type for institution performance stats",
"x-readme-ref-name": "InstitutionPerformanceStats"
},
"links": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL to resource itself"
}
},
"description": "ResourceLinks contains resource links",
"x-readme-ref-name": "ResourceLinks"
}
},
"description": "Connector contains connector data.",
"x-readme-ref-name": "Connector"
}
},
"links": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL to resource itself"
}
},
"description": "ResourceLinks contains resource links",
"x-readme-ref-name": "ResourceLinks"
}
},
"description": "ConnectorsList contains list of connectors data.",
"x-readme-ref-name": "ConnectorsList"
}
}
}
},
"400": {
"description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "The provided filter parameter is in invalid format or unsupported."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "userId"
},
"pointer": {
"type": "string",
"description": "Location to the object or attribute that the error relates to.",
"example": "users/userId"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
},
"examples": {
"Invalid Filters": {
"value": {
"type": "list",
"correlationId": "ac5ah55",
"data": [
{
"type": "error",
"code": "parameter-not-valid",
"title": "Parameter value is not valid",
"detail": "The provided filter parameter is in invalid format or unsupported",
"source": {
"parameter": "filter"
}
}
]
}
}
}
}
}
},
"401": {
"description": "Returns error that indicates unauthorized access.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
}
}
}
},
"404": {
"description": "Returns error indicating that server cannot find requested resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
},
"/connectors/{connectorId}/{method}": {
"get": {
"tags": [
"Connectors"
],
"summary": "Retrieve a connector",
"description": "NOTE: This end point requires authentication.",
"operationId": "getConnector",
"parameters": [
{
"name": "connectorId",
"in": "path",
"description": "Connector ID",
"required": true,
"schema": {
"pattern": "^[A-Z]{2}[0-9]{5}$",
"type": "string"
}
},
{
"name": "method",
"in": "path",
"description": "Connector method",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns data of single connector.",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"id",
"institution",
"method",
"stage",
"stats",
"status",
"scopes",
"authorization"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Resource type identifier. It is always \"connector\" for this model.\nconnector ConnectorEntityType",
"example": "connector",
"enum": [
"connector"
]
},
"id": {
"maxLength": 7,
"minLength": 7,
"pattern": "^[A-Z]{2}[0-9]{5}$",
"type": "string",
"description": "Institution ID",
"example": "AU00000"
},
"method": {
"type": "string",
"description": "Current Connector method",
"example": "web",
"enum": [
"web",
"open-banking",
"csv",
"pdf"
]
},
"stage": {
"type": "string",
"description": "Current Connector stage",
"example": "beta"
},
"status": {
"type": "string",
"description": "FeatureCondition type that describes an feature status for institution",
"x-readme-ref-name": "FeatureCondition"
},
"institution": {
"required": [
"type",
"name",
"shortName",
"tier",
"country",
"logo"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Institution type identifier\nBank BankInstitutionType BankInstitutionType institution type identifier for Banks\nBank (Foreign) BankForeignInstitutionType BankForeignInstitutionType institution type identifier for Foreign banks\nTest Bank TestBankInstitutionType TestBankInstitutionType institution type identifier for Test banks\nCredit Union CreditUnionInstitutionType CreditUnionInstitutionType institution type identifier for Credit union institutions\nFinancial Services FinancialServicesInstitutionType FinancialServicesInstitutionType institution type identifier for Financial service institutions\nSuperannuation SuperannuationInstitutionType SuperannuationInstitutionType institution type identifier for Superannuation institutions\nBuilding Society BuildingSociety BuildingSociety institution type identifier for Building Society institutions\nGovernment Government Government institution type identifier for Government institutions",
"example": "Bank",
"enum": [
"Bank",
"Bank (Foreign)",
"Test Bank",
"Credit Union",
"Financial Services",
"Superannuation",
"Building Society",
"Government"
]
},
"name": {
"type": "string",
"description": "Institution name",
"example": "Hooli Bank"
},
"shortName": {
"type": "string",
"description": "Institution short name",
"example": "Hooli"
},
"tier": {
"type": "string",
"description": "Institution tier identifier\n1 TierOne TierOne tier identifier for tier1 institution\n2 TierTwo TierTwo tier identifier for tier2 institution\n3 TierThree TierThree tier identifier for tier3 institution\n4 TierFour TierFour tier identifier for tier4 institution",
"example": "1",
"enum": [
"1",
"2",
"3",
"4"
]
},
"country": {
"type": "string",
"description": "Institution country name",
"example": "Australia"
},
"cdrFAQ": {
"type": "string",
"description": "A link for Data Holder (where available) to a page explaining CDR data sharing process.\n",
"example": "https://example.com/banking/help-support/open-banking.html"
},
"cdrEmail": {
"type": "string",
"description": "The email address for CDR-related inquiries.",
"example": "openbanking.dataholdersupport@example.com.au"
},
"cdrPolicy": {
"type": "string",
"description": "The URL to the CDR policy document detailing the institution's data practices and consumer rights.",
"example": "https://www.example.com.au/CDRpolicy"
},
"cdrProviderNumber": {
"type": "string",
"description": "A unique identifier assigned to the CDR institution by the CDR program.",
"example": "DHBNK000111"
},
"abn": {
"type": "string",
"description": "ABN for the Data Holder ( only available in openbanking ).",
"example": "87087651111"
},
"acn": {
"type": "string",
"description": "ACN for the Data Holder ( only available in openbanking ).",
"example": "087651111"
},
"logo": {
"required": [
"links",
"type"
],
"type": "object",
"properties": {
"colors": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "Primary primary institution color"
}
},
"description": "Colors contains institution colors type",
"x-readme-ref-name": "Colors"
},
"links": {
"required": [
"full",
"square"
],
"type": "object",
"properties": {
"full": {
"type": "string",
"description": "URL to full size logo",
"example": "https://example.com/AU00000-full.svg"
},
"square": {
"type": "string",
"description": "Square formatted logo URL",
"example": "https://example.com/AU00000.svg"
}
},
"description": "institution logo resource links",
"x-readme-ref-name": "LogoResourceLinks"
},
"type": {
"type": "string",
"description": "Resource type identifier.\nimage ImageResourceType",
"example": "image",
"enum": [
"image"
]
}
},
"description": "Institution logo resource type",
"x-readme-ref-name": "InstitutionLogoResource"
}
},
"description": "ConnectorInstitutionResource connector Institution resource type",
"x-readme-ref-name": "ConnectorInstitutionResource"
},
"scopes": {
"type": "array",
"description": "Connector scopes array",
"items": {
"type": "string",
"example": "customer.person.basic"
}
},
"authorization": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Authorization type identifier\nuser AuthorizationUser AuthorizationUser \"User\" authorization type identifier\ntoken AuthorizationToken AuthorizationToken \"Token\" authorization type identifier\nother AuthorizationOther AuthorizationOther \"Other\" authorization type identifier\nuser-mfa AuthorizationUserMfa AuthorizationUserMfa \"UserMfa\" authorization type identifier\nuser-mfa-intermittent AuthorizationUserMfaIntermittent AuthorizationUserMfaIntermittent \"UserMfaIntermittent\" authorization type identifier",
"example": "user",
"enum": [
"user",
"token",
"other",
"user-mfa",
"user-mfa-intermittent"
]
},
"meta": {
"type": "object",
"properties": {
"forgotten_password_url": {
"type": "string",
"description": "URL to institution forgotten password page",
"example": "https://example.com/forgotten-password"
},
"login_id_caption": {
"type": "string",
"description": "Login ID field caption that should be shown on UI",
"example": "User name"
},
"password_caption": {
"type": "string",
"description": "Password field caption that should be shown on UI",
"example": "Password"
},
"secondary_login_id_caption": {
"type": "string",
"description": "Secondary loginID caption that should be shown on UI",
"example": "Secondary login id"
},
"security_code_caption": {
"type": "string",
"description": "Security code caption that should be shown on UI",
"example": "Security code"
}
},
"x-readme-ref-name": "ConnectorAuthorizationMeta"
}
},
"x-readme-ref-name": "ConnectorAuthorization"
},
"stats": {
"type": "object",
"properties": {
"averageDurationMs": {
"type": "object",
"properties": {
"retrieveAccounts": {
"type": "integer",
"description": "Connector average duration in milliseconds of fetch accounts step for institution",
"format": "int64"
},
"retrieveMeta": {
"type": "integer",
"description": "Connector average duration in milliseconds of fetch metadata step for institution",
"format": "int64"
},
"retrieveTransactions": {
"type": "integer",
"description": "Connector average duration in milliseconds of fetch transactions step for institution",
"format": "int64"
},
"total": {
"type": "integer",
"description": "Total connector average duration in milliseconds",
"format": "int64"
},
"verifyCredentials": {
"type": "integer",
"description": "Connector average duration in milliseconds of verifiy credentials step for institution",
"format": "int64"
}
},
"description": "AverageDurationMs average connector duration in milliseconds per segments.\nWhen durations are not known for institution this field will be `null`."
}
},
"description": "InstitutionPerformanceStats response type for institution performance stats",
"x-readme-ref-name": "InstitutionPerformanceStats"
},
"links": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL to resource itself"
}
},
"description": "ResourceLinks contains resource links",
"x-readme-ref-name": "ResourceLinks"
}
},
"description": "Connector contains connector data.",
"x-readme-ref-name": "Connector"
}
}
}
},
"400": {
"description": "Returns error that server cannot or will not process the request due to something that is perceived to be a client error.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "The provided filter parameter is in invalid format or unsupported."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "userId"
},
"pointer": {
"type": "string",
"description": "Location to the object or attribute that the error relates to.",
"example": "users/userId"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
},
"examples": {
"Invalid Filters": {
"value": {
"type": "list",
"correlationId": "ac5ah55",
"data": [
{
"type": "error",
"code": "parameter-not-valid",
"title": "Parameter value is not valid",
"detail": "The provided filter parameter is in invalid format or unsupported",
"source": {
"parameter": "filter"
}
}
]
}
}
}
}
}
},
"401": {
"description": "Returns error that indicates unauthorized access.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
}
}
}
},
"404": {
"description": "Returns error indicating that server cannot find requested resource.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "NotFoundError"
}
}
}
},
"500": {
"description": "Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "InternalServerError"
}
}
}
}
},
"security": [
{
"services_token": []
}
]
}
}
},
"components": {
"schemas": {
"job": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"partnerId": {
"type": "string"
},
"status": {
"type": "string"
},
"jobType": {
"type": "string"
},
"applicationId": {
"type": "string"
},
"created": {
"description": "date and time in ISO format of when the job request was created",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "date and time in ISO format of when the job request was updated",
"type": "string",
"format": "date-time"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"result": {
"type": "object",
"nullable": true,
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
}
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"link": {
"type": "string"
},
"self": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "job"
},
"StatementJobs": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"createdDate": {
"description": "date and time in ISO format of when the job request was created",
"type": "string",
"format": "date-time"
},
"updatedDate": {
"description": "date and time in ISO format of when the job request was updated",
"type": "string",
"format": "date-time"
},
"jobType": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"result": {
"type": "object",
"nullable": true,
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"link": {
"type": "string"
},
"self": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "StatementJobs"
},
"ReportsJob": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"partnerId": {
"type": "string"
},
"applicationId": {
"type": "string"
},
"created": {
"type": "string"
},
"updated": {
"type": "string"
},
"status": {
"type": "string"
},
"jobType": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "ReportsJob"
},
"EventTypes": {
"properties": {
"type": {
"type": "string"
},
"count": {
"type": "integer"
},
"size": {
"type": "integer"
},
"data": {
"type": "array",
"description": "one or more events that the webhook would send messages for.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"description": "Identifer of the event type",
"example": "user.created"
},
"description": {
"type": "string",
"description": "a brief description of the event type",
"example": "when a user is created"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "EventType"
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"next": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "EventTypes"
},
"Error": {
"properties": {
"type": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"x-readme-ref-name": "Error"
},
"EventType": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"description": "Identifer of the event type",
"example": "user.created"
},
"description": {
"type": "string",
"description": "a brief description of the event type",
"example": "when a user is created"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "EventType"
},
"RetrieveEvent": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"createdDate": {
"type": "string"
},
"entity": {
"type": "string"
},
"eventType": {
"type": "string"
},
"userId": {
"type": "string"
},
"dataRef": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"createdDate": {
"type": "string"
},
"id": {
"type": "string"
},
"institution": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
},
"type": {
"type": "string"
}
}
},
"lastUsed": {
"type": "string"
},
"links": {
"type": "object",
"properties": {
"accounts": {
"type": "string"
},
"self": {
"type": "string"
},
"transactions": {
"type": "string"
}
}
},
"mfaEnabled": {
"type": "boolean"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
}
}
},
"x-readme-ref-name": "RetrieveEvent"
},
"AuthLinksResponseResource": {
"required": [
"id",
"mobile",
"type",
"expiresAt",
"userId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Uniquely identifies the auth link.",
"example": "63448be4"
},
"mobile": {
"type": "string",
"description": "A user's mobile phone, used as for authentication.",
"example": 61410000000
},
"type": {
"type": "string",
"description": "Type of the response, always \"auth_link\".",
"example": "auth_link"
},
"userId": {
"type": "string",
"description": "A string that uniquely identifies the user.",
"example": "ec4ea48d"
},
"expiresAt": {
"type": "string",
"description": "The date time of auth link expiry.",
"example": "2019-11-21T04:08:50Z"
},
"links": {
"required": [
"public",
"self"
],
"type": "object",
"properties": {
"public": {
"type": "string",
"description": "Public URL of auth link.",
"example": "https://connect.basiq.io/63448be4"
},
"self": {
"type": "string",
"description": "URL of the resource",
"example": "/users/ec4ea48d/auth_link"
}
},
"x-readme-ref-name": "AuthLinkLinks"
}
},
"x-readme-ref-name": "AuthLinksResponseResource"
},
"GoneError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-no-longer-available",
"enum": [
"resource-no-longer-available"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem."
},
"title": {
"type": "string",
"description": "Title of the error"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "GoneError"
},
"BadRequestError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Parameter not valid."
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "parameter-not-valid",
"enum": [
"parameter-not-supplied",
"parameter-not-valid",
"unsupported-accept",
"invalid-content",
"institution-not-supported",
"invalid-credentials"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "ID value is not valid."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "BadRequestError"
},
"AuthLinkLinks": {
"required": [
"public",
"self"
],
"type": "object",
"properties": {
"public": {
"type": "string",
"description": "Public URL of auth link.",
"example": "https://connect.basiq.io/63448be4"
},
"self": {
"type": "string",
"description": "URL of the resource",
"example": "/users/ec4ea48d/auth_link"
}
},
"x-readme-ref-name": "AuthLinkLinks"
},
"AuthLinksPostResponseResource": {
"required": [
"mobile",
"type",
"userId",
"expiresAt"
],
"type": "object",
"properties": {
"mobile": {
"type": "string",
"description": "A user's mobile phone, used as for authentication.",
"example": 61410000000
},
"type": {
"type": "string",
"description": "Type of the response, always \"auth_link\".",
"example": "auth_link"
},
"userId": {
"type": "string",
"description": "A string that uniquely identifies the user.",
"example": "ec4ea48d"
},
"expiresAt": {
"type": "string",
"description": "The date time of auth link expiry.",
"example": "2019-11-21T04:08:50Z"
},
"links": {
"required": [
"public",
"self"
],
"type": "object",
"properties": {
"public": {
"type": "string",
"description": "Public URL of auth link.",
"example": "https://connect.basiq.io/63448be4"
},
"self": {
"type": "string",
"description": "URL of the resource",
"example": "/users/ec4ea48d/auth_link"
}
},
"x-readme-ref-name": "AuthLinkLinks"
}
},
"x-readme-ref-name": "AuthLinksPostResponseResource"
},
"ConnectionResponseResource": {
"title": "ConnectionResponseResource",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type, always \"job\".",
"example": "job"
},
"id": {
"type": "string",
"description": "Job identification.",
"example": "29523951"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing details for connection post.",
"x-readme-ref-name": "ConnectionResponseResource"
},
"EventsData": {
"required": [
"createdDate",
"id",
"links",
"type",
"entity",
"userId",
"dataRef",
"data",
"eventType"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type, always \"event\".",
"example": "event"
},
"id": {
"type": "string",
"description": "Event identification.",
"example": "61723"
},
"createdDate": {
"type": "string",
"description": "Date the event was created.",
"example": "2019-07-29T07:34:09Z"
},
"entity": {
"type": "string",
"description": "The entity associated with the event that has occurred",
"example": "consent",
"enum": [
"consent",
"connection"
]
},
"eventType": {
"type": "string",
"description": "The type of event that has occurred",
"example": "revoked",
"enum": [
"revoked",
"expired",
"updated",
"created",
"archived",
"deleted"
]
},
"userId": {
"type": "string",
"description": "The identifier of the user the event belongs to.",
"example": "266f5849-6ef6-4aae-accf-386470d0598e"
},
"dataRef": {
"type": "string",
"description": "URL to the data source the event occurred.",
"example": "https://au-api.basiq.io/users/266f5849-6ef6-4aae-accf-386470d0598e"
},
"data": {
"type": "string",
"description": "The data associated with the event that has been created.",
"example": [
{
"email": "max@hooli.com",
"id": "266f5849-6ef6-4aae-accf-386470d0598e",
"links": {
"self": "https://au-api.basiq.io/users/266f5849-6ef6-4aae-accf-386470d0598e"
},
"mobile": "+614xxxxxxxx",
"type": "user"
}
]
},
"links": {
"example": [
{
"self": "https://au-api.basiq.io/events/545ae104289e71bd3da34a063aaf49a5fa17ab6b8e0cab4bc56e019b7cc409e0"
}
]
}
},
"x-readme-ref-name": "EventsData"
},
"EventsGetResponseResource": {
"title": "EventsGetResponseResource",
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type, always \"list\".",
"example": "list"
},
"data": {
"type": "array",
"items": {
"required": [
"createdDate",
"id",
"links",
"type",
"entity",
"userId",
"dataRef",
"data",
"eventType"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type, always \"event\".",
"example": "event"
},
"id": {
"type": "string",
"description": "Event identification.",
"example": "61723"
},
"createdDate": {
"type": "string",
"description": "Date the event was created.",
"example": "2019-07-29T07:34:09Z"
},
"entity": {
"type": "string",
"description": "The entity associated with the event that has occurred",
"example": "consent",
"enum": [
"consent",
"connection"
]
},
"eventType": {
"type": "string",
"description": "The type of event that has occurred",
"example": "revoked",
"enum": [
"revoked",
"expired",
"updated",
"created",
"archived",
"deleted"
]
},
"userId": {
"type": "string",
"description": "The identifier of the user the event belongs to.",
"example": "266f5849-6ef6-4aae-accf-386470d0598e"
},
"dataRef": {
"type": "string",
"description": "URL to the data source the event occurred.",
"example": "https://au-api.basiq.io/users/266f5849-6ef6-4aae-accf-386470d0598e"
},
"data": {
"type": "string",
"description": "The data associated with the event that has been created.",
"example": [
{
"email": "max@hooli.com",
"id": "266f5849-6ef6-4aae-accf-386470d0598e",
"links": {
"self": "https://au-api.basiq.io/users/266f5849-6ef6-4aae-accf-386470d0598e"
},
"mobile": "+614xxxxxxxx",
"type": "user"
}
]
},
"links": {
"example": [
{
"self": "https://au-api.basiq.io/events/545ae104289e71bd3da34a063aaf49a5fa17ab6b8e0cab4bc56e019b7cc409e0"
}
]
}
},
"x-readme-ref-name": "EventsData"
}
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing details for connections.",
"x-readme-ref-name": "EventsGetResponseResource"
},
"ForbiddenAccessError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"source",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Forbidden Access"
},
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "forbidden-access",
"enum": [
"forbidden-access",
"no-production-access",
"access-denied"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Access to this resource is forbidden."
},
"source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
}
}
}
}
},
"x-readme-ref-name": "ForbiddenAccessError"
},
"GetUserAccount": {
"title": "UserGetAccount",
"required": [
"count",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"count": {
"type": "integer",
"description": "Count of accounts.",
"format": "int64",
"example": 7
},
"data": {
"type": "array",
"description": "Accounts data.",
"items": {
"title": "UserGetAccountData",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"account\".",
"example": "account"
},
"id": {
"type": "string",
"description": "Account identification.",
"example": "aaaf2c3b"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing account data.",
"x-readme-ref-name": "GetUserAccountData"
}
}
},
"description": "Container object containing account data.",
"x-readme-ref-name": "GetUserAccount"
},
"GetUserAccountData": {
"title": "UserGetAccountData",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"account\".",
"example": "account"
},
"id": {
"type": "string",
"description": "Account identification.",
"example": "aaaf2c3b"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing account data.",
"x-readme-ref-name": "GetUserAccountData"
},
"GetUserConnection": {
"title": "UserGetConnection",
"required": [
"count",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"count": {
"type": "integer",
"description": "Count of accounts.",
"format": "int64",
"example": 5
},
"data": {
"type": "array",
"description": "Connections data.",
"items": {
"title": "GetUserConnectionData",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"connection\".",
"example": "connection"
},
"id": {
"type": "string",
"description": "Connection identification.",
"example": "aaaf2c3b"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing connection data.",
"x-readme-ref-name": "GetUserConnectionData"
}
}
},
"description": "Container object containing connection data.",
"x-readme-ref-name": "GetUserConnection"
},
"GetUserConnectionData": {
"title": "GetUserConnectionData",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"connection\".",
"example": "connection"
},
"id": {
"type": "string",
"description": "Connection identification.",
"example": "aaaf2c3b"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing connection data.",
"x-readme-ref-name": "GetUserConnectionData"
},
"GetUserLinks": {
"title": "GetUserLinks",
"required": [
"accounts",
"auth_link",
"connections",
"self",
"transactions"
],
"type": "object",
"properties": {
"accounts": {
"type": "string",
"description": "Accounts reference url.",
"example": "https://au-api.basiq.io/users/a3dgf4567a89/accounts"
},
"connections": {
"type": "string",
"description": "Connections reference url.",
"example": "https://au-api.basiq.io/users/a3dgf4567a89/connections"
},
"self": {
"type": "string",
"description": "User self reference url.",
"example": "https://au-api.basiq.io/user/a3dgf4567a89"
},
"transactions": {
"type": "string",
"description": "Transactions reference url.",
"example": "https://au-api.basiq.io/users/a3dgf4567a89/transactions"
}
},
"description": "Object containing links to resources.",
"x-readme-ref-name": "GetUserLinks"
},
"InternalServerError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "internal-server-error",
"enum": [
"internal-server-error"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Internal Server error. Contact support."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Internal Server error."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "InternalServerError"
},
"JobsData": {
"title": "JobsData",
"required": [
"created",
"id",
"institution",
"steps",
"updated"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Value is \"job\".",
"example": "job"
},
"id": {
"type": "string",
"description": "A string that uniquely identifies the job.",
"example": "e9132638"
},
"created": {
"type": "string",
"description": "The date time when the job was created.",
"example": "2020-06-10T09:59:00Z"
},
"updated": {
"type": "string",
"description": "The date time when the job was last updated.",
"example": "2020-06-10T09:59:00Z"
},
"institution": {
"title": "Institution",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A string that uniquely identifies institution.",
"example": "AU00000"
},
"links": {
"title": "JobsLinks",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource",
"example": "https://au-api.basiq.io/jobs/61723"
},
"source": {
"type": "string",
"description": "Resource that initiated creation of this Job. For example, for operations on Connection, this is a Connection URL. This is only returned for Connection jobs and not for Statement jobs.",
"example": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
},
"description": "Links to the resources.",
"x-readme-ref-name": "JobsLinks"
},
"type": {
"type": "string",
"description": "Always \"institution\".",
"example": "institution"
}
},
"description": "Institution details.",
"x-readme-ref-name": "JobsInstitution"
},
"steps": {
"type": "array",
"description": "List of steps that need to be completed.",
"items": {
"title": "JobsStep",
"required": [
"result",
"status"
],
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Name of the step the job needs to complete.",
"example": "retrieve-accounts",
"enum": [
"verify-credentials",
"retrieve-accounts",
"retrieve-transactions",
"retrieve-statements"
]
},
"status": {
"type": "string",
"description": "Status of the job step",
"example": "success",
"enum": [
"pending",
"in-progress",
"success",
"failed"
]
},
"result": {
"title": "JobsResult",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "In case of failed job, displays error code.",
"enum": [
"success",
"user-action-required",
"system-unavailable",
"maintenance",
"connector-error",
"institution-not-found",
"institution-not-available",
"institution-disabled",
"missing-required-field",
"missing-required-field-value",
"invalid-field-value",
"invalid-csv-row",
"row-count-exceeded",
"account-data-differs",
"empty-file",
"bank-statement-invalid",
"bank-statement-new-product",
"bank-statement-parsing-error",
"bank-statement-not-supported",
"txn-after-last-updated-date",
"invalid-connection",
"unknown-error",
"job-timed-out"
]
},
"details": {
"type": "string",
"description": "In case of failed job, displays details of the error."
},
"title": {
"type": "string",
"description": "In case of failed job, displays error title."
},
"type": {
"type": "string",
"description": "In case of success, Always \"link\".",
"example": "link"
},
"url": {
"type": "string",
"description": "In case of success, URL of the updated (or created) resources."
}
},
"description": "Result object containing a list of URLs or null. Otherwise if a step failed contains an error response.",
"x-readme-ref-name": "JobsResult"
}
},
"description": "List of steps that need to be completed.",
"x-readme-ref-name": "JobsStep"
}
},
"links": {
"title": "JobsLinks",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource",
"example": "https://au-api.basiq.io/jobs/61723"
},
"source": {
"type": "string",
"description": "Resource that initiated creation of this Job. For example, for operations on Connection, this is a Connection URL. This is only returned for Connection jobs and not for Statement jobs.",
"example": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
},
"description": "Links to the resources.",
"x-readme-ref-name": "JobsLinks"
}
},
"description": "Container object, containing job details.",
"x-readme-ref-name": "JobsData"
},
"JobPostRequest": {
"required": [
"mfa-response"
],
"type": "object",
"properties": {
"mfa-response": {
"type": "array",
"description": "One time password or answer to a security question/s e.g. [\"1234\"]",
"example": [
"1234"
],
"items": {
"type": "string"
}
}
},
"x-readme-ref-name": "JobPostRequest"
},
"JobsInstitution": {
"title": "Institution",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A string that uniquely identifies institution.",
"example": "AU00000"
},
"links": {
"title": "JobsLinks",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource",
"example": "https://au-api.basiq.io/jobs/61723"
},
"source": {
"type": "string",
"description": "Resource that initiated creation of this Job. For example, for operations on Connection, this is a Connection URL. This is only returned for Connection jobs and not for Statement jobs.",
"example": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
},
"description": "Links to the resources.",
"x-readme-ref-name": "JobsLinks"
},
"type": {
"type": "string",
"description": "Always \"institution\".",
"example": "institution"
}
},
"description": "Institution details.",
"x-readme-ref-name": "JobsInstitution"
},
"JobsLinks": {
"title": "JobsLinks",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource",
"example": "https://au-api.basiq.io/jobs/61723"
},
"source": {
"type": "string",
"description": "Resource that initiated creation of this Job. For example, for operations on Connection, this is a Connection URL. This is only returned for Connection jobs and not for Statement jobs.",
"example": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
},
"description": "Links to the resources.",
"x-readme-ref-name": "JobsLinks"
},
"JobsResponseResource": {
"required": [
"data",
"links",
"size",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"list\".",
"example": "list"
},
"data": {
"type": "array",
"description": "Container object, containing job details.",
"items": {
"title": "JobsData",
"required": [
"created",
"id",
"institution",
"steps",
"updated"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Value is \"job\".",
"example": "job"
},
"id": {
"type": "string",
"description": "A string that uniquely identifies the job.",
"example": "e9132638"
},
"created": {
"type": "string",
"description": "The date time when the job was created.",
"example": "2020-06-10T09:59:00Z"
},
"updated": {
"type": "string",
"description": "The date time when the job was last updated.",
"example": "2020-06-10T09:59:00Z"
},
"institution": {
"title": "Institution",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A string that uniquely identifies institution.",
"example": "AU00000"
},
"links": {
"title": "JobsLinks",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource",
"example": "https://au-api.basiq.io/jobs/61723"
},
"source": {
"type": "string",
"description": "Resource that initiated creation of this Job. For example, for operations on Connection, this is a Connection URL. This is only returned for Connection jobs and not for Statement jobs.",
"example": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
},
"description": "Links to the resources.",
"x-readme-ref-name": "JobsLinks"
},
"type": {
"type": "string",
"description": "Always \"institution\".",
"example": "institution"
}
},
"description": "Institution details.",
"x-readme-ref-name": "JobsInstitution"
},
"steps": {
"type": "array",
"description": "List of steps that need to be completed.",
"items": {
"title": "JobsStep",
"required": [
"result",
"status"
],
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Name of the step the job needs to complete.",
"example": "retrieve-accounts",
"enum": [
"verify-credentials",
"retrieve-accounts",
"retrieve-transactions",
"retrieve-statements"
]
},
"status": {
"type": "string",
"description": "Status of the job step",
"example": "success",
"enum": [
"pending",
"in-progress",
"success",
"failed"
]
},
"result": {
"title": "JobsResult",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "In case of failed job, displays error code.",
"enum": [
"success",
"user-action-required",
"system-unavailable",
"maintenance",
"connector-error",
"institution-not-found",
"institution-not-available",
"institution-disabled",
"missing-required-field",
"missing-required-field-value",
"invalid-field-value",
"invalid-csv-row",
"row-count-exceeded",
"account-data-differs",
"empty-file",
"bank-statement-invalid",
"bank-statement-new-product",
"bank-statement-parsing-error",
"bank-statement-not-supported",
"txn-after-last-updated-date",
"invalid-connection",
"unknown-error",
"job-timed-out"
]
},
"details": {
"type": "string",
"description": "In case of failed job, displays details of the error."
},
"title": {
"type": "string",
"description": "In case of failed job, displays error title."
},
"type": {
"type": "string",
"description": "In case of success, Always \"link\".",
"example": "link"
},
"url": {
"type": "string",
"description": "In case of success, URL of the updated (or created) resources."
}
},
"description": "Result object containing a list of URLs or null. Otherwise if a step failed contains an error response.",
"x-readme-ref-name": "JobsResult"
}
},
"description": "List of steps that need to be completed.",
"x-readme-ref-name": "JobsStep"
}
},
"links": {
"title": "JobsLinks",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource",
"example": "https://au-api.basiq.io/jobs/61723"
},
"source": {
"type": "string",
"description": "Resource that initiated creation of this Job. For example, for operations on Connection, this is a Connection URL. This is only returned for Connection jobs and not for Statement jobs.",
"example": "https://au-api.basiq.io/users/ea3a81/connections/8fce3b"
}
},
"description": "Links to the resources.",
"x-readme-ref-name": "JobsLinks"
}
},
"description": "Container object, containing job details.",
"x-readme-ref-name": "JobsData"
}
},
"size": {
"type": "integer",
"description": "Size of the all the jobs.",
"format": "int64",
"example": 100
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"x-readme-ref-name": "JobsResponseResource"
},
"JobsResult": {
"title": "JobsResult",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "In case of failed job, displays error code.",
"enum": [
"success",
"user-action-required",
"system-unavailable",
"maintenance",
"connector-error",
"institution-not-found",
"institution-not-available",
"institution-disabled",
"missing-required-field",
"missing-required-field-value",
"invalid-field-value",
"invalid-csv-row",
"row-count-exceeded",
"account-data-differs",
"empty-file",
"bank-statement-invalid",
"bank-statement-new-product",
"bank-statement-parsing-error",
"bank-statement-not-supported",
"txn-after-last-updated-date",
"invalid-connection",
"unknown-error",
"job-timed-out"
]
},
"details": {
"type": "string",
"description": "In case of failed job, displays details of the error."
},
"title": {
"type": "string",
"description": "In case of failed job, displays error title."
},
"type": {
"type": "string",
"description": "In case of success, Always \"link\".",
"example": "link"
},
"url": {
"type": "string",
"description": "In case of success, URL of the updated (or created) resources."
}
},
"description": "Result object containing a list of URLs or null. Otherwise if a step failed contains an error response.",
"x-readme-ref-name": "JobsResult"
},
"JobsStep": {
"title": "JobsStep",
"required": [
"result",
"status"
],
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Name of the step the job needs to complete.",
"example": "retrieve-accounts",
"enum": [
"verify-credentials",
"retrieve-accounts",
"retrieve-transactions",
"retrieve-statements"
]
},
"status": {
"type": "string",
"description": "Status of the job step",
"example": "success",
"enum": [
"pending",
"in-progress",
"success",
"failed"
]
},
"result": {
"title": "JobsResult",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "In case of failed job, displays error code.",
"enum": [
"success",
"user-action-required",
"system-unavailable",
"maintenance",
"connector-error",
"institution-not-found",
"institution-not-available",
"institution-disabled",
"missing-required-field",
"missing-required-field-value",
"invalid-field-value",
"invalid-csv-row",
"row-count-exceeded",
"account-data-differs",
"empty-file",
"bank-statement-invalid",
"bank-statement-new-product",
"bank-statement-parsing-error",
"bank-statement-not-supported",
"txn-after-last-updated-date",
"invalid-connection",
"unknown-error",
"job-timed-out"
]
},
"details": {
"type": "string",
"description": "In case of failed job, displays details of the error."
},
"title": {
"type": "string",
"description": "In case of failed job, displays error title."
},
"type": {
"type": "string",
"description": "In case of success, Always \"link\".",
"example": "link"
},
"url": {
"type": "string",
"description": "In case of success, URL of the updated (or created) resources."
}
},
"description": "Result object containing a list of URLs or null. Otherwise if a step failed contains an error response.",
"x-readme-ref-name": "JobsResult"
}
},
"description": "List of steps that need to be completed.",
"x-readme-ref-name": "JobsStep"
},
"NotFoundError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "resource-not-found",
"enum": [
"resource-not-found"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Resource not found."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Requested resource is not found."
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "NotFoundError"
},
"ResourceLink": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
},
"Source": {
"title": "Source",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"description": "String indicating which URI query parameter caused the error.",
"example": "id"
}
},
"description": "An object containing references to the source of the error.",
"x-readme-ref-name": "Source"
},
"StatusServiceUnavailableError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "object",
"description": "Application-specific error code, expressed as a string value.",
"example": "service-unavailable"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "Service Unavailable. Try again later."
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Service Unavailable"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
}
},
"x-readme-ref-name": "StatusServiceUnavailableError"
},
"UnauthorizedError": {
"required": [
"correlationId",
"data",
"type"
],
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"description": "Unique identifier for this particular occurrence of the problem.",
"example": "ac5ah5i"
},
"data": {
"type": "array",
"description": "Error data.",
"items": {
"required": [
"code",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application-specific error code, expressed as a string value.",
"example": "unauthorized-access",
"enum": [
"unauthorized-access",
"invalid-authorization-token"
]
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence of the problem.",
"example": "You are not authorized to access this resource"
},
"title": {
"type": "string",
"description": "Title of the error",
"example": "Unauthorized Access"
},
"type": {
"type": "string",
"description": "Type of the response, always \"error\"",
"example": "error"
}
}
}
},
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
}
},
"x-readme-ref-name": "UnauthorizedError"
},
"UserGetResponse": {
"title": "UserGetResponse",
"required": [
"accounts",
"connections",
"email",
"id",
"links",
"mobile",
"name",
"firstName",
"middleName",
"lastName",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"user\".",
"example": "user"
},
"id": {
"type": "string",
"description": "User identification.",
"example": "ea3a81"
},
"email": {
"type": "string",
"description": "User email or empty.",
"format": "email",
"example": "gavin@hooli.com"
},
"mobile": {
"type": "string",
"description": "User mobile number, or empty.",
"example": 61410888666
},
"name": {
"type": "string",
"description": "Name, or empty.",
"example": ""
},
"firstName": {
"type": "string",
"description": "firstName, or empty",
"example": "Gavin"
},
"middleName": {
"type": "string",
"description": "middleName, or empty",
"example": "middleName"
},
"lastName": {
"type": "string",
"description": "lastName, or empty",
"example": "lastName"
},
"businessName": {
"type": "string",
"description": "The official name of the business.",
"example": "Manly Accounting PTY LTD"
},
"businessIdNo": {
"type": "string",
"description": "This number is used to identify a business when they’re dealing with the government, other businesses, and the public.",
"example": "16 7645 892"
},
"businessIdNoType": {
"type": "string",
"description": "Type of business ID could be ABN Or ACN.",
"enum": [
"ABN",
"ACN"
],
"example": "ABN"
},
"businessAddress": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"example": "21 Sydney Rd",
"description": "The first line of the business address."
},
"addressLine2": {
"type": "string",
"example": "",
"description": "Additional information about the business address (optional)."
},
"suburb": {
"type": "string",
"example": "Manly",
"description": "The suburb or locality where the business is located."
},
"state": {
"type": "string",
"example": "NSW",
"description": "The state or territory where the business is located."
},
"postcode": {
"type": "string",
"example": "2095",
"description": "The postal code of the business location."
},
"countryCode": {
"type": "string",
"example": "AUS",
"description": "The country code of the business location."
}
}
},
"verificationStatus": {
"type": "boolean",
"description": "Indicates if the business information provided is verified against the Australian Business Register."
},
"verificationDate": {
"type": "string",
"example": "12/01/2024",
"description": "when the verification was done."
},
"connections": {
"title": "UserGetConnection",
"required": [
"count",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"count": {
"type": "integer",
"description": "Count of accounts.",
"format": "int64",
"example": 5
},
"data": {
"type": "array",
"description": "Connections data.",
"items": {
"title": "GetUserConnectionData",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"connection\".",
"example": "connection"
},
"id": {
"type": "string",
"description": "Connection identification.",
"example": "aaaf2c3b"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing connection data.",
"x-readme-ref-name": "GetUserConnectionData"
}
}
},
"description": "Container object containing connection data.",
"x-readme-ref-name": "GetUserConnection"
},
"accounts": {
"title": "UserGetAccount",
"required": [
"count",
"data",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"list\".",
"example": "list"
},
"count": {
"type": "integer",
"description": "Count of accounts.",
"format": "int64",
"example": 7
},
"data": {
"type": "array",
"description": "Accounts data.",
"items": {
"title": "UserGetAccountData",
"required": [
"id",
"links",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Always \"account\".",
"example": "account"
},
"id": {
"type": "string",
"description": "Account identification.",
"example": "aaaf2c3b"
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "Object containing account data.",
"x-readme-ref-name": "GetUserAccountData"
}
}
},
"description": "Container object containing account data.",
"x-readme-ref-name": "GetUserAccount"
},
"links": {
"title": "GetUserLinks",
"required": [
"accounts",
"auth_link",
"connections",
"self",
"transactions"
],
"type": "object",
"properties": {
"accounts": {
"type": "string",
"description": "Accounts reference url.",
"example": "https://au-api.basiq.io/users/a3dgf4567a89/accounts"
},
"connections": {
"type": "string",
"description": "Connections reference url.",
"example": "https://au-api.basiq.io/users/a3dgf4567a89/connections"
},
"self": {
"type": "string",
"description": "User self reference url.",
"example": "https://au-api.basiq.io/user/a3dgf4567a89"
},
"transactions": {
"type": "string",
"description": "Transactions reference url.",
"example": "https://au-api.basiq.io/users/a3dgf4567a89/transactions"
}
},
"description": "Object containing links to resources.",
"x-readme-ref-name": "GetUserLinks"
}
},
"description": "User object with details if the creation succeeded.",
"x-readme-ref-name": "UserGetResponse"
},
"UserPostResponse": {
"title": "UserPostResponse",
"required": [
"id",
"links",
"mobile",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the response, always \"user\".",
"example": "user"
},
"id": {
"type": "string",
"description": "A string that uniquely identifies the user.",
"example": "e1956419"
},
"email": {
"type": "string",
"description": "The end-users email address.",
"format": "email",
"example": "gavin@hooli.com"
},
"mobile": {
"type": "string",
"description": "The end-users mobile number.",
"example": 61410888999
},
"firstName": {
"type": "string",
"description": "The end-users first name as an optional additional parameter.",
"example": "Gavin"
},
"middleName": {
"type": "string",
"description": "The end-users middle name as an optional additional parameter.",
"example": "middle name"
},
"lastName": {
"type": "string",
"description": "The end-users last name as an optional additional parameter.",
"example": "Belson"
},
"businessName": {
"type": "string",
"description": "The official name of the business.",
"example": "Manly Accounting PTY LTD"
},
"businessIdNo": {
"type": "string",
"description": "This number is used to identify a business when they’re dealing with the government, other businesses, and the public.",
"example": "16 7645 892"
},
"businessIdNoType": {
"type": "string",
"description": "Type of business ID could be ABN Or ACN.",
"enum": [
"ABN",
"ACN"
],
"example": "ABN"
},
"businessAddress": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"example": "21 Sydney Rd",
"description": "The first line of the business address."
},
"addressLine2": {
"type": "string",
"example": "",
"description": "Additional information about the business address (optional)."
},
"suburb": {
"type": "string",
"example": "Manly",
"description": "The suburb or locality where the business is located."
},
"state": {
"type": "string",
"example": "NSW",
"description": "The state or territory where the business is located."
},
"postcode": {
"type": "string",
"example": "2095",
"description": "The postal code of the business location."
},
"countryCode": {
"type": "string",
"example": "AUS",
"description": "The country code of the business location."
}
}
},
"verificationStatus": {
"type": "boolean",
"description": "Indicates if the business information provided is verified against the Australian Business Register."
},
"verificationDate": {
"type": "string",
"example": "12/01/2024",
"description": "when the verification was done."
},
"links": {
"title": "ResourceLink",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URL of the resource.",
"example": "https://au-api.basiq.io/link/a3dgf4567a89"
}
},
"description": "Link object containing a link to the resource, self reference.",
"x-readme-ref-name": "ResourceLink"
}
},
"description": "User object with details if the creation succeeded.",
"x-readme-ref-name": "UserPostResponse"
},
"createUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The end-users email address. Mandatory if mobile is not supplied.",
"example": "gavin@hooli.com"
},
"mobile": {
"type": "string",
"description": "The end-users mobile number, supplied in international format. +[country-code][mobileno]. Mandatory if email is not supplied.",
"example": "+61410888999"
},
"firstName": {
"type": "string",
"description": "The end-users first name as an optional additional parameter.",
"example": "Gavin"
},
"middleName": {
"type": "string",
"description": "The end-users middle name as an optional additional parameter.",
"example": "middle name"
},
"lastName": {
"type": "string",
"description": "The end-users last name as an optional additional parameter.",
"example": "Belson"
},
"businessName": {
"type": "string",
"description": "The official name of the business.",
"example": "Manly Accounting PTY LTD"
},
"businessIdNo": {
"type": "string",
"description": "This number is used to identify a business when they’re dealing with the government, other businesses, and the public.",
"example": "16 7645 892"
},
"businessIdNoType": {
"type": "string",
"description": "Type of business ID could be ABN Or ACN.",
"enum": [
"ABN",
"ACN"
],
"example": "ABN"
},
"businessAddress": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"example": "21 Sydney Rd",
"description": "The first line of the business address."
},
"addressLine2": {
"type": "string",
"example": "",
"description": "Additional information about the business address (optional)."
},
"suburb": {
"type": "string",
"example": "Manly",
"description": "The suburb or locality where the business is located."
},
"state": {
"type": "string",
"example": "NSW",
"description": "The state or territory where the business is located."
},
"postcode": {
"type": "string",
"example": "2095",
"description": "The postal code of the business location."
},
"countryCode": {
"type": "string",
"example": "AUS",
"description": "The country code of the business location."
}
}
},
"verificationStatus": {
"type": "boolean",
"description": "Indicates if the business information provided is verified against the Australian Business Register."
},
"verificationDate": {
"type": "string",
"example": "12/01/2024",
"description": "when the verification was done."
}
},
"x-readme-ref-name": "createUser"
},
"updateUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The end-users email address.",
"example": "gavin@hooli.com"
},
"mobile": {
"type": "string",
"description": "The end-users mobile number.",
"example": "+61410888666"
},
"firstName": {
"type": "string",
"description": "The end-users first name as an optional additional parameter.",
"example": "Malcolm"
},
"middleName": {
"type": "string",
"description": "The end-users middle name as an optional additional parameter.",
"example": "Malcom middle name"
},
"lastName": {
"type": "string",
"description": "The end-users last name as an optional additional parameter.",
"example": "Malcolm last name"
}
},
"x-readme-ref-name": "updateUser"
},
"TokenPostResponse": {
"required": [
"access_token",
"expires_in",
"token_type"
],
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "The generated access token.",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
},
"expires_in": {
"type": "integer",
"description": "Expires in 3600 seconds",
"format": "int64",
"example": 3600
},
"token_type": {
"type": "string",
"description": "This value will always be `Bearer`.",
"example": "Bearer"
}
},
"x-readme-ref-name": "TokenPostResponse"
},
"UserConsentGetResponses": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string",
"format": "uuid"
},
"created": {
"type": "string",
"format": "date-time"
},
"updated": {
"type": "string",
"format": "date-time"
},
"expiryDate": {
"type": "string",
"format": "date-time"
},
"origin": {
"type": "string"
},
"status": {
"type": "string",
"description": "active, revoked, and expired"
},
"purpose": {
"type": "object",
"additionalProperties": false,
"properties": {
"primary": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"title": "Primary",
"x-readme-ref-name": "Primary"
},
"other": {
"type": "boolean",
"nullable": true
}
},
"required": [
"primary"
],
"title": "Purpose",
"x-readme-ref-name": "Purpose"
},
"data": {
"type": "object",
"additionalProperties": false,
"properties": {
"retainData": {
"type": "boolean"
},
"initialRetrievalDays": {
"type": "integer"
},
"organisation": {
"type": "boolean",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"scope": {
"type": "string"
},
"required": {
"type": "boolean"
},
"consented": {
"type": "boolean"
},
"entity": {
"type": "string"
},
"information": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"attributeList": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"attributeList",
"description",
"name"
],
"title": "Information",
"x-readme-ref-name": "Information"
},
"purpose": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"title": "Primary",
"x-readme-ref-name": "Primary"
}
},
"required": [
"entity",
"information",
"purpose",
"required",
"scope"
],
"title": "Permission",
"x-readme-ref-name": "Permission"
}
}
},
"required": [
"permissions",
"retainData"
],
"title": "Data",
"x-readme-ref-name": "Data"
},
"revoked": {
"type": "string",
"description": "To indicate when a user consent was revoked."
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"consentPolicy": {
"type": "string"
},
"latestConsentPolicy": {
"type": "string"
}
}
}
},
"required": [
"created",
"data",
"expiryDate",
"id",
"purpose",
"status",
"type",
"updated"
],
"title": "UserConsentGetResponse",
"x-readme-ref-name": "UserConsentGetResponses"
},
"Data": {
"type": "object",
"additionalProperties": false,
"properties": {
"retainData": {
"type": "boolean"
},
"initialRetrievalDays": {
"type": "integer"
},
"organisation": {
"type": "boolean",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"scope": {
"type": "string"
},
"required": {
"type": "boolean"
},
"consented": {
"type": "boolean"
},
"entity": {
"type": "string"
},
"information": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"attributeList": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"attributeList",
"description",
"name"
],
"title": "Information",
"x-readme-ref-name": "Information"
},
"purpose": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"title": "Primary",
"x-readme-ref-name": "Primary"
}
},
"required": [
"entity",
"information",
"purpose",
"required",
"scope"
],
"title": "Permission",
"x-readme-ref-name": "Permission"
}
}
},
"required": [
"permissions",
"retainData"
],
"title": "Data",
"x-readme-ref-name": "Data"
},
"Permission": {
"type": "object",
"additionalProperties": false,
"properties": {
"scope": {
"type": "string"
},
"required": {
"type": "boolean"
},
"consented": {
"type": "boolean"
},
"entity": {
"type": "string"
},
"information": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"attributeList": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"attributeList",
"description",
"name"
],
"title": "Information",
"x-readme-ref-name": "Information"
},
"purpose": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"title": "Primary",
"x-readme-ref-name": "Primary"
}
},
"required": [
"entity",
"information",
"purpose",
"required",
"scope"
],
"title": "Permission",
"x-readme-ref-name": "Permission"
},
"Information": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"attributeList": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"attributeList",
"description",
"name"
],
"title": "Information",
"x-readme-ref-name": "Information"
},
"Primary": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"title": "Primary",
"x-readme-ref-name": "Primary"
},
"Purpose": {
"type": "object",
"additionalProperties": false,
"properties": {
"primary": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"title"
],
"title": "Primary",
"x-readme-ref-name": "Primary"
},
"other": {
"type": "boolean",
"nullable": true
}
},
"required": [
"primary"
],
"title": "Purpose",
"x-readme-ref-name": "Purpose"
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-default": "Basic NjMxMjNmMWMtZjYxMy00ZjMyLWFiYzUtYzBhZDdhYTY2YmU1OjQ3NWYwMzhkLTBlZmItNGM1ZS1iMzQ0LTAzMzYxOTkyYTRlMw=="
},
"services_token": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"security": [
{
"api_key": []
},
{
"services_token": []
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true,
"samples-enabled": true,
"samples-languages": [
"curl",
"node",
"ruby",
"javascript",
"python"
]
}
}