Skip to main content
← HaaS Developer Resources

Adapter API (Secure)

HaaS Data Adapter API Secure (OpenAPI Client) (2.4.0)

Download OpenAPI specification:Download

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

This is the OpenAPI specification consumed by the HaaS Data Adapter Client for Authenticated endpoints and corresponds to CDS version 1.36.0.1. Please consult the appropriate implementation guides to identify which ones must be implemented for your scenario.

Common

This contains the APIs related to the retrieval of information related to the Common namespace within the Data Standards

Get User

Essentially a simplified GetCustomer call. To be used as a replacement for GetCustomer in the Consent Flow. Also used in the Consent Management Dashboard as a way of knowing about the Power of Attorney situations that may exist.

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetUserVersion)
Enum: "V0" "V1"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

Request Body schema: application/json
required

Get User Request

version
string
Default: "V0"
userId
required
string <= 512 characters

The internal user ID of the user. This should be an ID that doesn't change over the life of the user.

principalId
required
string <= 512 characters

The internal identifier of the entity being shared via CDR. It is the ID that will be supplied to the data sharing calls for customer details, listing accounts, etc.

Responses

Request samples

Content type
application/json
{
  • "version": "V0",
  • "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567",
  • "principalId": "552375cb-9c00-4fde-a0a0-592904a55355"
}

Response samples

Content type
application/json
Example
{
  • "version": "V0",
  • "principalName": "Doe Pty Ltd",
  • "customerUType": "person",
  • "name": "First Last",
  • "lastName": "Last",
  • "firstName": "First",
  • "updatedAt": "2018-11-13T20:20:39+00:00",
  • "role": "Chief Financial Officer",
  • "vulnerable": false,
  • "authorityToOperate": [
    ]
}

Get Customer

Retrieve a specific customer based on identifier

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetCustomerVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    }
}

Banking

This contains the APIs related to the retrieval of information related to the Banking namespace within the Data Standards

Request Banking Transaction Detail List

Request Banking Transaction Detail List through an Asynchronous request

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
required
string (EnumResponseRequestBankingTransactionDetailListVersion)
Value: "V1"
Example: V1

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request Banking Transaction Detail list

version
required
string
Default: "V1"
required
object (RequestBankingTransactionDetailListDataV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    },
  • "meta": {
    }
}

Get Banking Transaction Detail List Status

Retrieve banking transaction detail action status

Authorizations:
APIKeyTokenBasedAuth
path Parameters
actionId
required
string
Example: a3d7bcf7-fea4-45a4-b350-ab4c56d47f83

Global unique identifier of an action

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
required
string (EnumResponseGetBankingTransactionDetailListStatusVersion)
Value: "V1"
Example: V1

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    },
  • "meta": {
    }
}

Retrieve Banking Transaction Detail List

Retrieve banking transaction detail records

Authorizations:
APIKeyTokenBasedAuth
path Parameters
actionId
required
string
Example: a3d7bcf7-fea4-45a4-b350-ab4c56d47f83

Global unique identifier of an action

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
required
string (EnumResponseRetrieveBankingTransactionDetailListVersionV3)
Enum: "V1" "V2" "V3"
Example: V1

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

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

List Payees

Retrieve a list of payees for a specific customer identifier

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListBankingPayeesVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

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

List Payments

Retrieve a list of payments for a specific customer

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListBankingPaymentsVersion)
Enum: "V0" "V1"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V0",
  • "data": [
    ]
}

List Banking Accounts

Retrieve a list of accounts for a specific customer based on identifier

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

accountIds
Array of strings

Filter results based on a set of account identifiers

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListBankingAccountsVersionV3)
Enum: "V0" "V1" "V2" "V3"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V0",
  • "data": [
    ]
}

List Banking Transactions

Retrieve a list of transactions based on customer and account identifiers. Transactions should be ordered according to "effective" date in descending order.

As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as:

  • Posted date/time if available, then
  • Execution date/time if available, then
  • A reasonable date/time nominated by the data holder using internal data structures
Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

accountId
required
string

Unique Account Identifier

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

transactionIds
Array of strings

Filter results based on a set of transaction identifiers

oldest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type.

If absent defaults to the following dependent on call:

  • Banking: newest-time minus 90 days
  • Energy: newest-time minus 12 months
newest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.

min-amount
string

Filter transactions to only transactions with amounts higher than or equal to this amount.

max-amount
string

Filter transactions to only transactions with amounts less than or equal to this amount.

text
string

Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListBankingTransactionsVersionV3)
Enum: "V0" "V1" "V2"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

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

List Banking Instalment Plans

Retrieve Banking Instalment Plans for a list of accounts authorised for the principal. The list of accounts to fetch plans for is supplied in the request body, allowing HaaS to act as the gatekeeper of authorised accounts and to retrieve all plans across the supplied accounts in a single call.

Filtering parameters from the upstream CDR Banking Instalment Plan endpoints (plan-status, page, page-size) are mirrored through to the data adapter via the request body.

Response data MUST be ordered according to plan creationDate in descending order.

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
required
string (EnumResponseListBankingInstalmentPlansVersion)
Value: "V1"
Example: V1

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request to list Banking Instalment Plans for a set of accounts

version
required
string
Default: "V1"
required
object (RequestListBankingInstalmentPlansDataV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

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

Energy

This contains the APIs related to the retrieval of information related to the Energy namespace within the Data Standards

List Energy Accounts

Retrieve a list of energy accounts for a specified principal

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

accountIds
Array of strings

Filter results based on a set of account identifiers

status
string (EnumAccountOpenStatusWithAllV1)
Default: "ALL"
Enum: "ALL" "CLOSED" "OPEN"

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListEnergyAccountsVersionV2)
Enum: "V1" "V2"
Example: V2

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V0",
  • "data": [
    ]
}

Get Energy Account Agreed Payment Schedule

Retrieve a list of payment schedules for a specific account

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

accountId
required
string

Unique Account Identifier

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetEnergyPaymentScheduleVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    }
}

List Energy Account Concessions

Retrieve a list of concessions for a specific account

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

accountId
required
string

Unique Account Identifier

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetEnergyConcessionsVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    }
}

List Energy Account Balances

Retrieve a list of balances for one or more account identifiers

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

accountIds
required
Array of strings

Filter results based on a set of account identifiers

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListEnergyBalancesVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    }
}

List Energy Account Invoices

Retrieve a list of invoices for one or more account identifiers

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

accountIds
required
Array of strings

Filter results based on a set of account identifiers

oldest-date
string <date>

Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListEnergyInvoicesVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    },
  • "meta": {
    }
}

List Energy Account Billing Transactions

Retrieve a list of billing transactions for one or more account identifiers

Authorizations:
APIKeyTokenBasedAuth
path Parameters
principalId
required
string <= 512 characters
Example: 552375cb-9c00-4fde-a0a0-592904a55355

Represents the Principal being accessed

query Parameters
userId
string
Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10

The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal

accountIds
required
Array of strings

Filter results based on a set of account identifiers

oldest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type.

If absent defaults to the following dependent on call:

  • Banking: newest-time minus 90 days
  • Energy: newest-time minus 12 months
newest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseListEnergyBillingsVersionV2)
Enum: "V1" "V2"
Example: V2

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V0",
  • "data": {
    },
  • "meta": {
    }
}

Auth

These endpoints relate to authorisation and authentication.

Init Login

Initiate OTP Login using a supplied username and receive a request identifier to present the supplied OTP back with. This call should not fail if the username doesn't exist, but instead return a request ID that has no possibility of succeeding. This is to avoid enumeration attacks on usernames via this interface (i.e the only way to verify a user exists is to successfully pass the right OTP).

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseInitLoginVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Initiate a login request

version
string
Default: "V0"
username
required
string

The username is the string that the customer is expected to enter at the first step of the consent flow. It could be an email, phone number or some kind of internet banking ID. The CDR mandates that the user needs to login to CDR with the same username as their digital banking channels, so what this username is depends on your existing UX.

Responses

Request samples

Content type
application/json
Example
{
  • "version": "V0",
  • "username": "customer@email.com"
}

Response samples

Content type
application/json
{
  • "version": "V0",
  • "requestId": "e5468c93-2dfc-4a27-b156-009a1067f2fb",
  • "otp": "123455"
}

Verify Login

Using a supplied request identifier and a supplied OTP verify the login and return a set of customer identifiers it is now validated for

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseVerifyLoginVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Verify a login

version
string
Default: "V0"
requestId
required
string
otpValue
required
string

Responses

Request samples

Content type
application/json
{
  • "version": "V0",
  • "requestId": "e5468c93-2dfc-4a27-b156-009a1067f2fb",
  • "otpValue": "123455"
}

Response samples

Content type
application/json
{
  • "version": "V0",
  • "principalIds": [
    ],
  • "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}

Get Username Attributes

Accept a digital service identifier (Username) and return relevant details to conduct operations without already knowing the User Principal.

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetUsernameAttributesVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Lookup User Attributes

version
string
Default: "V0"
username
required
string

The username is the string that the customer is expected to enter at the first step of the consent flow. It could be an email, phone number or some kind of internet banking ID. The CDR mandates that the user needs to login to CDR with the same username as their digital banking channels, so what this username is depends on your existing UX.

Responses

Request samples

Content type
application/json
Example
{
  • "version": "V0",
  • "username": "customer@email.com"
}

Response samples

Content type
application/json
{
  • "version": "V0",
  • "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567",
  • "otpType": "MOBILE",
  • "emailAddresses": [ ],
  • "phoneNumbers": [ ]
}

Get User Principals

Accept a previously supplied user identifier and provide back a response containing a list of principals

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

x-haas-v
string (EnumResponseGetUserPrincipalsVersion)
Value: "V0"
Example: V0

Supported Response Version

Request Body schema: application/json
required

Lookup User Principals

version
string
Default: "V0"
userId
required
string <= 512 characters

The internal user ID of the user. This should be an ID that doesn't change over the life of the user.

Responses

Request samples

Content type
application/json
{
  • "version": "V0",
  • "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}

Response samples

Content type
application/json
{
  • "version": "V0",
  • "principalIds": [
    ],
  • "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}

Admin

These endpoints are related to the retrieval of information related to admin

Get 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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetHealthVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

Responses

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    }
}

Get Endpoint Metadata

Retrieve the endpoint metadata of the endpoints that this adapter supports

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-max-v
required
string
Example: V6

Supported Response Version

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V3",
  • "data": {
    }
}

Get Closed Principals (Optional)

Retrieve a list of principalIds that have recently closed all of their accounts and should have sharing arrangements revoked.

Authorizations:
APIKeyTokenBasedAuth
query Parameters
since
string <date-time>

Filters the list to records that are newer than the timestamp

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetClosedPrincipalsVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

Responses

Response samples

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

Notification

This contains the APIs related to the sending of notification information to the Data Holder

Get User Notification Information

Takes a userId and returns back the name and email that should be used when sending email notifications to that user. There are places where HaaS needs to obtain the name & email of a userId but we don't have a principalId present.

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

x-haas-v
string (EnumResponseGetUserNotificationInfoVersion)
Value: "V0"
Example: V0

Supported Response Version

Request Body schema: application/json
required

Lookup User Attributes

version
string
Default: "V0"
userId
required
string <= 512 characters

The internal user ID of the user. This should be an ID that doesn't change over the life of the user.

Responses

Request samples

Content type
application/json
{
  • "version": "V0",
  • "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}

Response samples

Content type
application/json
{
  • "version": "V0",
  • "name": "First Last",
  • "email": "demo@example.com"
}

Send Notification

Send a batch of notifications.

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseSendNotificationVersion)
Value: "V0"
Example: V0

Supported Response Version

Request Body schema: application/json
required

Content of the Notification Request

version
string
Default: "V0"
Array of objects (AdapterNotificationV1)

List of Notifications to be sent as a batch.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "version": "V0",
  • "data": {
    }
}

Device

This contains the APIs related to the retrieval of information related to devices

Retrieve FRMP Details

Retrieve a list of FRMP details for specified NMIs

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
required
string
Example: holder-auth

The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them.

x-haas-v
string (EnumResponseGetFRMPDetailsVersion)
Value: "V0"
Example: V0

Supported Response Version

x-haas-performance-tier
string (EnumXHaaSPerformanceTierV1)
Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL"
Example: HIGH_PRIORITY

This indicates which performance tier according to the Data Standards the request originates

Request Body schema: application/json
required

Lookup FRMP Details using a set of NMI

version
string
Default: "V0"
principalId
required
string <= 512 characters

The internal identifier of the entity being shared via CDR. It is the ID that will be supplied to the data sharing calls for customer details, listing accounts, etc.

nmi
required
Array of strings

An array of NMIs

oldestDate
required
string <date>

Constrain the request to records with effective date at or after this date.

Responses

Request samples

Content type
application/json
Example
{
  • "version": "V0",
  • "principalId": "552375cb-9c00-4fde-a0a0-592904a55355",
  • "nmi": [
    ],
  • "oldestDate": "2022-01-03"
}

Response samples

Content type
application/json
{
  • "version": "V0",
  • "nmi1": [
    ],
  • "nmi2": [
    ]
}