Generated by API Evangelist
Written by API Evangelist tooling for Citizens Financial Group's API. It is a proposal applied on top of the contract, not a document Citizens Financial Group publishes.
overlay: 1.0.0
info:
title: Citizens Information Reporting API enrichment overlay
version: 1.0.0
x-generated: '2026-09-05'
x-method: generated
x-source: API Evangelist enrichment pass 2026-09-05; every value is quoted from a Citizens-published document
named in the action description.
extends: citizens-financial-group-information-reporting-openapi.yml
actions:
- target: $.info
description: Record harvest provenance.
update:
x-apis-io-harvested: '2026-09-05'
x-apis-io-source: https://developer.citizensbank.com/product/commercial-banking/api/informationreporting-v1
- target: $.paths['/list'].get
description: Record the offset pagination contract published in the user guide.
update:
x-pagination:
style: offset
params:
- pageOffset
- pageLimit
- target: $.paths['/transactions/query'].post
description: Record the published default and maximum record counts.
update:
x-pagination:
default-records: 100
max-records: 2000
source: https://developer.citizensbank.com/content/qut/CitizensInformationReportingAPIUserGuide.pdf
x-rate-limit-error: IR-429
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.