Skip to main content
← HaaS Developer Resources

Management API (HaaS)

Management API (HaaS) (1.36.0.0)

Download OpenAPI specification:Download

Biza.io: hello@biza.io URL: https://biza.io/ License: Commercial

This is the OpenAPI specification consumed by Consumer Dashboard Clients

Accounts

Accounts Management

List Principal Accounts

List Principal Accounts for a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

account-type
Array of strings (EnumDashboardRealmAccountTypeV1)
Items Enum: "SINGLE" "JOINT" "BUSINESS"
Example: account-type=SINGLE

Filter on a specific Account Type (if not provided no filter will be applied)

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get Specific Account

Get the details for a specific Account in the context of a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List Grants for Specific Account

List Grants related to a specific Account in the context of a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

status
Array of strings (EnumGrantStatus)
Items Enum: "INITIALISE" "ACTIVE" "REVOKED" "EXPIRED"
Example: status=ACTIVE

Filter on a specific grant status

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Admin

Admin Endpoints

Service Health Status

Retrieve health check summary

Authorizations:
APIKeyTokenBasedAuth
header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

DOMS

Disclosure Option Management Service Management

List DOMS Requests for a specific Principal

Lists all DOMS requests related to the specific Principal

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

isCreator
boolean

Filter DOMS requests by those created by this user

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get DOMS Request

Get a DOMS request by the request identifier

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

requestId
required
string <uuid>

ID of the specific sharing request

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

List DOMS Requests for a Specific Account

Lists all DOMS requests related to a specific Account for a specific Principal

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

isCreator
boolean

Filter DOMS requests by those created by this user

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create DOMS Request for an Account for a specific User

Creates a DOMS change request for a specific Account from a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Request Body schema: application/json
required

Create DOMS Request

required
object (CreateDOMSRequestV1)
action
required
string (EnumDOMSRequestProposalV1)
Enum: "PRE_APPROVAL" "NON_DISCLOSURE"

Account Sharing Statuses

Value Description
PRE_APPROVAL The account currently allows any party to establish a sharing arrangement
NON_DISCLOSURE No party is allowed to establish a sharing arrangement
userId
string (UserIdV1)

ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Handle DOMS Request for an Account

Provides a method of responding to a DOMS request

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

requestId
required
string <uuid>

ID of the specific sharing request

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Request Body schema: application/json
required
required
object (UpdateDOMSRequestV1)
action
required
string (EnumDOMSDecisionV1)
Enum: "APPROVED" "DENIED"
userId
string (UserIdV1)

ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Grants

Grants Management

List Grants Deprecated

Lists Grants (Arrangements) for a specific User

Note: This endpoint is intended for eventual migration to /{principalId}/grant.

We recommend considering migrating to this alternative URL at your convenience but have not currently defined any retirement date.

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

status
Array of strings (EnumGrantStatus)
Items Enum: "INITIALISE" "ACTIVE" "REVOKED" "EXPIRED"
Example: status=ACTIVE

Filter on a specific grant status

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List Grants

Lists Grants (Arrangements) for a specific Principal in the context of a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

status
Array of strings (EnumGrantStatus)
Items Enum: "INITIALISE" "ACTIVE" "REVOKED" "EXPIRED"
Example: status=ACTIVE

Filter on a specific grant status

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get Grant

Get details for a specific Grant

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "grantId": "f924e6a6-248b-4034-9885-25f8805964cd",
  • "grantType": "CDR_SHARING_ARRANGEMENT_V1",
  • "softwareProduct": {
    },
  • "status": "ACTIVE",
  • "created": "2021-01-01T12:30:00Z",
  • "expiry": "2021-01-02T12:30:00Z",
  • "principalId": "e4ddb46f-ff94-42a4-bba3-0a36be4de5ee",
  • "userId": "2753c9cc-316f-42c1-97c8-4ae38d119fe2",
  • "accounts": [
    ],
  • "scopes": [
    ],
  • "cx_scopes": [
    ],
  • "private": false,
  • "latestTokenTime": "2021-01-01T15:30:00Z"
}

Delete Grant

Revokes a specific Grant immediately triggering notification actions to related parties

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List Grant Logs

Returns logs about every event that modifies this grant.

Examples are:

  • Access token issuance (i.e: the ADR is requesting a data sharing session)
  • Dashboard api modifications
  • Amending consent with the user
  • Revocation
Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

eventType
Array of strings (EnumGrantEventTypeV1)
Items Enum: "GRANT_ACCESS_TOKEN_ISSUANCE_EVENT" "GRANT_AMENDMENT_EVENT" "GRANT_CODE_CLAIMED_EVENT" "GRANT_CREATION_EVENT" "GRANT_HELD_VIA_REGISTER_UPDATE_EVENT" "GRANT_ID_TOKEN_ISSUANCE_EVENT" "GRANT_REACTIVATED_VIA_REGISTER_UPDATE_EVENT" "GRANT_REFRESH_TOKEN_ISSUANCE_EVENT" "GRANT_REVOKED_BY_ADMIN_EVENT" "GRANT_REVOKED_BY_DASHBOARD_EVENT" "GRANT_REVOKED_BY_RECIPIENT_EVENT" "GRANT_REVOKED_VIA_CLOSED_PRINCIPAL_POLL_EVENT" "GRANT_REVOKED_VIA_REGISTER_UPDATE_EVENT" "GRANT_REVOKED_VIA_USER_INELIGIBLE_EVENT"
Example: eventType=GRANT_AMENDMENT_EVENT

Filter on specific grant event types

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

List Grant Accounts

List the Account identifiers that an End User has given during the Grant (Arrangement) establishment process

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Withdraw joint account sharing approval

For joint account owner to withdraw sharing approval on the joint account from a specific Grant that was created by another joint account owner.

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

accountId
required
string

ID of the specific account

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Grant Consents

Consent Management related to Grants

List Grant Consents

While a grant is the top level data structure that has tokens issued against it, consents are the individual temporal histories of that grant as it changes over it's lifespan. As a grant is modified, the current consent is terminated and a new consent is created to reflect the new state.

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a new Grant Consent

Creates a new consent and modifies the existing state of the grant to reflect. If the content of this request matches the existing arrangement state then the previous consent response is returned.

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

grantId
required
string <uuid>

ID of the specific grant

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Request Body schema: application/json
required
grantConsentType
required
string (EnumGrantConsentTypeV1)
Default: "CDR_SHARING_ARRANGEMENT_V1"

Grant Types

Value Description
CDR_SHARING_ARRANGEMENT_V1 A CDR Sharing Arrangement
userId
required
string

The User Identifier who executed the consent

scopes
required
Array of strings (EnumCDRScopesV1) unique
Items Enum: "openid" "profile" "common:customer.basic:read" "common:customer.detail:read" "bank:accounts.basic:read" "bank:accounts.detail:read" "bank:transactions:read" "bank:regular_payments:read" "bank:payees:read" "energy:accounts.basic:read" "energy:accounts.detail:read" "energy:accounts.concessions:read" "energy:accounts.paymentschedule:read" "energy:billing:read" "energy:electricity.servicepoints.basic:read" "energy:electricity.servicepoints.detail:read" "energy:electricity.der:read" "energy:electricity.usage:read"

This is a list of scopes related to CDR Sharing Arrangements.

accountIds
required
Array of strings unique
expiry
required
string <date-time>

The new expiry time of the underlying Grant

Responses

Request samples

Content type
application/json
{
  • "grantConsentType": "CDR_SHARING_ARRANGEMENT_V1",
  • "userId": "5529e377-b8aa-42c3-8f65-b30aae26e555",
  • "scopes": [
    ],
  • "accountIds": [
    ],
  • "expiry": "2021-01-01T12:30:00Z"
}

Response samples

Content type
application/json
{
  • "grantConsentId": "f1ddcf6f-1f63-4f3a-a937-12052d776212",
  • "created": "2021-01-01T12:30:00Z",
  • "superceded": "2021-01-01T15:30:00Z",
  • "details": {
    }
}

Notifications

Notifications

Get Notification Preferences for an Account

Get Notification Preferences for a specific Account for a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Notification Preferences for an Account

Update Notification Preferences for a specific Account for a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Request Body schema: application/json
required

Update the notifications

required
object (UpdateNotificationPreferencesV1)

Describes the notification preferences currently specified for the target entity.

required
object (DashboardNotificationFrequencyV1)
required
object (DashboardNotificationFrequencyV1)
dataSharingNotApproved
required
boolean
required
object (DashboardNotificationFrequencyV1)
userId
string (UserIdV1)

ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Secondary User Instructions

Secondary User Instruction Management

List Secondary User Instructions for an Account

List Secondary User Instructions for an Account for a specific User

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

status
string (EnumSecondaryUserSharingStatusV1)
Enum: "ENABLED" "DISABLED"
Example: status=DISABLED

Filter on a specific Secondary User sharing status

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Update Secondary User Instruction

Update Secondary User Instruction status

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

accountId
required
string

ID of the specific account

secondaryUserUserId
required
string

User ID of the Secondary User

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Request Body schema: application/json
required

Update Secondary User Request

required
object (UpdateSecondaryUserV1)
status
required
string (EnumSecondaryUserSharingStatusV1)
Enum: "ENABLED" "DISABLED"
userId
string (UserIdV1)

ID of the specific user requested. Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

User

User Management

Get User

Get User Details for a specific User in the context of a specific Principal

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string

ID of the specific Principal requested

query Parameters
userId
string

ID of the specific user requested.

Note: This SHOULD be supplied, even if it is the same value as principalId. This field will be made mandatory at a later date however, if omitted, userId is currently assumed to be the same as principalId.

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-haas-realm-name
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dashboard

Admin functions for the biza consumer dashboard

Dashboard SSO Request

Requests a signed JWT for use for logging into the biza consumer dashboard with a trusted user and (optionally) principal.

This request object can be given to dashboard to create a link that will log the user into the dashboard. E.g: https://dashboard.biza.io/sso?request=$requestObjectJwt

Only required if using the Biza Consent Dashboard and wanting to login via a prompt free single sign on. Calls to this must be secured by an appropriate authentication mechanism for your digital portal.

Authorizations:
APIKeyTokenBasedAuth
header Parameters
x-haas-realm-name
required
string (DioRealmName)
Example: biza-holder

Represents the authorisation realm name context for the call being made.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json
required
required
object (CreateDashboardSsoRequestV1)
userId
required
string

The userId being logged into dashboard

principalId
string

The principal being logged into dashboard. This is optional. If selected, the dashboard will only show grants and accounts for that user and principal. If omitted, Dashboard will show a principal selector on the first page to allow the user to select a principal that they are acting upon in the dashboard. If the user only has one principal, then no principal selector will be shown.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "jwt": "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJodHRwczpcL1wvaWRwLnNhbmRib3hcL3NhbmRib3gtZGFzaGJvYXJkLWF1dGgiLCJzdWIiOiIwOGMzMWEyYTkwMTZkNmM1MTdhOTU1NjIyMjhhMzdjMDowOGMzMWEyYTkwMTZkNmM1MTdhOTU1NjIyMjhhMzdjMCIsIm5iZiI6MTY2MTEwNDc2MywiaXNzIjoiYml6YS1kYXNoYm9hcmQiLCJleHAiOjE2NjExMDQ5MTMsImlhdCI6MTY2MTEwNDc5M30.vsAgJ1cHKEGBuJ54h8taPC2iK0l1ItBA2XQjaIZGq_3KQfYuU5ctsdnUgu6NRXUWL9bsYLaS5gnbkzw6nbd6zw"
}