citizens warehouse

Anonymised Data Warehouse data

Please note: Access to the Anonymised Data Warehouse is restricted to the participants of the Hackathon

1. Logout here https://citizensbank.openbankproject.com/ if you are using one of the provided default users

2. Register a username / password that will be used in your App to get access to the anonymised datawarehouse data.

3. Login here as that user https://citizensbank-explorer.openbankproject.com/

4. Get the user_id of this user using the API / API Explorer https://citizensbank-explorer.openbankproject.com/?version=4.0.0&ignoredefcat=true#OBPv3_0_0-getCurrentUser

5. Send us your Full Name, Project Name, email and the user_id(s) that should access this data via Slack - Or just come and see us.

6. **Come and see a member of the Open Bank Project / TESOBE team.

7. Once we have granted you access we will notify you on Slack

8. Now you can use the end point documented at Search Warehouse

Available indices in the warehouse:

accounts (141013 records)

Summaries for the Customer accounts in index customer

Fields	Description
"ACCOUNT_ID"	unique identifier
"DATA_DATE"
"LAST_DEPOSIT_DATE"	Last deposited date
"LAST_MONETARY_ACTIVITY_DATE"	Last transaction Date
"LAST_STATEMENT_DATE"	Last statement date
"LAST_WITHDRAWAL_DATE"	Last withdrawal Date
"MINIMUM_BALANCE_DATE_MTD"	Month To date Min Balance
"NON_SUFFICIENT_FUNDS_NUMBER_OF_DAYS_ITD"
"NON_SUFFICIENT_FUNDS_NUMBER_OF_ITEMS_MTD"
"NON_SUFFICIENT_FUNDS_NUMBER_OF_TIMES_MTD"
"OVERDRAFT_NUMBER_OF_DAYS_MTD"
"OVERDRAFT_NUMBER_OF_TIMES_MTD"
"OVERDRAFT_THIS_TIME_NUMBER_OF_DAYS"
"OVERDRAFT_TOTAL_NUMBER_OF_DAYS"
"TOTAL_NUMBER_OF_STOPPED_ITEMS"
"UNAVAILABLE_FUNDS_NUMBER_OF_DAYS_MTD"
"UNAVAILABLE_FUNDS_NUMBER_OF_ITEMS_MTD"
"NUMBER_OF_CREDITS_THIS_CYCLE"	Total number of Credits this month
"NUMBER_OF_DEBITS_THIS_CYCLE"	Total Number of debits this month
"AGGREGATE_NUMBER_OF_DAYS_LYTD"
"AGGREGATE_NUMBER_OF_DAYS_MTD"
"AGGREGATE_NUMBER_OF_DAYS_YTD"
"NUMBER_OF_DEPOSITS_MTD"
"NUMBER_OF_WITHDRAWALS_MTD"
"ACCRUAL_BALANCE"
"AGGREGATE_BALANCE_MTD"
"AGGREGATE_BALANCE_YTD"
"AGGREGATE_OVERDRAFT_AMOUNT_MTD"
"AVERAGE_BALANCE_LAST_YEAR"
"DDA_BALANCE"	Balance amount
"HOLD_AMOUNT_BALANCE"	hold amount
"LAST_DEPOSIT_AMOUNT"	last deposit amount
"LAST_MONETARY_ACTIVITY_AMOUNT"
"MAXIMUM_BALANCE_MTD"
"MINIMUM_BALANCE_MTD"
"MAXIMUM_BALANCE_CTD"
"AMOUNT_OF_DEPOSITS_MTD"
"AMOUNT_OF_WITHDRAWALS_MTD"
"MAXIMUM_BALANCE_THIS_CYCLE"
"MINIMUM_BALANCE_LYTD"
"MINIMUM_BALANCE_YTD"
}

customers (22046 records)

Customer accounts

Fields	Description
"ACCOUNT_ID"	unique identifier
"CUSTOMER_ID"	unique identifier
"ACCOUNT_OPEN_DATE"	date the account was opened
"ACCOUNT_RATE_PCT"	interest rate
"ACCOUNT_STATUS"	account status
"CUSTOMER_AGE"	customer age
"DDA_BALANCE_AMT"	account balance
"AVERAGE_BALANCE_LAST_3_MO_AMT"	average balance for the last 3 months
"AVERAGE_BALANCE_LAST_12_MO_AMT"	average balance for the last 12 months
"PRODUCT_CD"	product code, see product code mapping
"PRODUCT_TYPE_NM"	product name
"PORTFOLIO_TYPE_NM"
"ACCOUNT_CLOSE_DT"	date of account closing
"CUSTOMER_STATE_NM"	state of the account holder
"CUSTOMER_ZIP_CODE_NUM"	zip code
"DATA_DATE"
"ORIGINAL_FICO_SCR"
"CC_AVAILABLE_BALANCE_AMT"	available balance amount
"CREDIT_LIMIT_AMT"	Credit limit amount
"CHARGED_OFF_IND"

transactions (1090845 records)

Fields	Description
"ACCOUNT_ID"	unique identifier for the account
"TRANSACTION_DT"	transaction date
"TRANSACTION_CODE"	transaction code
"TRANSACTION_TYPE"
"TRANSACTION_AMT"
"TRANSACTION_DESCRIPTION"

transactionscredit (40947 records)

Fields	Description
"ACCOUNT_ID"
"TRANSACTION_CODE"
"TRANSACTION_TYPE"
"TRANSACTION_AMOUNT"
"TRANSACTION_DATE"
"TRANSACTION_DESCRIPTION"

Individuals Using OBP v4.0.0

• Get default 10 records:

https://citizensbank.openbankproject.com/obp/v4.0.0/search/warehouse/accounts

{
    "query": {
        "match_all": {}
    }
}

• Get first 0 - 1000 records:

https://citizensbank.openbankproject.com/obp/v4.0.0/search/warehouse/accounts

{
    "size": 1000,
    "from": 0,
    "query": {
        "match_all": {}
    }
}

• Get the next "page" from 1000 - 2000 records:

https://citizensbank.openbankproject.com/obp/v4.0.0/search/warehouse/accounts

{
    "size": 1000,
    "from": 2000,
    "query": {
        "match_all": {}
    }
}

For more information about Elastic Search query syntax see

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax