How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Citizens Information Reporting API

The Citizens Information Reporting API lets an authenticated consumer retrieve the authorized account list, deposit account balances and transaction history for Citizens Bank checking and savings accounts. It is the only paginated surface Citizens publishes - required pageOffset and pageLimit on the account list, and a nextKey cursor with a 100-record default and a 2000-record maximum on transactions.

Citizens Information Reporting API is one of 11 APIs that Citizens Financial Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account, Balances, Banking, Reporting, and Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 1.0.16.

Requests are made against a single base URL, https://apis.citizensbank.com/v1/information-reporting.

3 operations 3 paths 17 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.16
Base URL
https://apis.citizensbank.com/v1/information-reporting
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Citizens Information Reporting API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-IBM-Client-Id (client-id). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Information Reporting 3
POST
/balance/query
Get accounts balances for a authorized Non human Account system identifier
getAccountDetails 3 params body → 200206400401404500
GET
/list
Get accounts list for a authorized Non human Account system identifier
getAccountList 5 params → 200400401404500
POST
/transactions/query
Get the list of transaction(s) of the requested Account.
getTransactions 3 params body → 200204400401404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are TransactionDetail (11 properties), AccountListResponseData (6 properties), BalanceInquiryResponseData (6 properties), BalanceInquiryResponseData2 (6 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
4 properties 3 required
AccountDetailRequest
object
Represents the request for account details.
2 properties 1 required
AccountListResponseData
object
Represents the response data containing the API status and additional data.
6 properties
BalanceInquiryResponseData
object
Represents the response data containing the API status and additional data.
6 properties
BalanceInquiryResponseData2
object
Represents the response data containing the API status and additional data.
6 properties
Account
object
6 properties
AccountDetail
AccountListQueryResponse
object
4 properties
AccountTransactionRequest
object
Represents the request for account details.
6 properties 1 required
AccountTransactionResponse
object
Represents the response data containing the API status and additional data.
6 properties
TransactionDetail
object
11 properties
AuthorizationHeader
string
ErrorResponse_errorDetails
object
3 properties 2 required
TransactionDetail_inner_baiMemo_memoDetails
object
2 properties
TransactionDetail_inner_baiMemo
object
2 properties
AccountTransactionResponse_data
object
2 properties
TransactionDetail_memoDetails
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

citizens-financial-group-information-reporting-openapi.yml Raw ↑

Other APIs Citizens Financial Group publishes across the network.

Citizens Open Banking API
Citizens Accounts API
Citizens Statements API
Citizens Payments API
Citizens Account Validation API
Citizens Account Transfer API
Citizens Authorize API
Citizens ATM Locator API
Citizens Branch Locator API
Citizens Pay API
Where this information came from

This is an independent, third-party profile of Citizens Information Reporting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.