Retrieve Facsimile

Retrieves facsimile data from the FFIEC Central Data Repository API for the requested financial institution.

Usage

get_facsimile(
  user_id = Sys.getenv("FFIEC_USER_ID"),
  bearer_token = Sys.getenv("FFIEC_BEARER_TOKEN"),
  reporting_period_end_date,
  fi_id_type = c("ID_RSSD", "FDICCertNumber", "OCCChartNumber", "OTSDockNumber"),
  fi_id
)

Arguments

user_id

(String) The UserID for authenticating against the FFIEC API

bearer_token

(String) The Bearer Token for authenticating against the FFIEC API

reporting_period_end_date

(String) The reporting period end date, formatted as "MM/DD/YYYY"

fi_id_type

(String) The type of identifier being provided; one of `c("ID_RSSD", "FDICCertNumber", "OCCChartNumber", "OTSDockNumber")`; default is "ID_RSSD"

fi_id

(String) The financial institution's identifier (can also be supplied as an integer instead of a string)

Value

A tibble containing the facsimile data.

References

https://cdr.ffiec.gov/public/Files/SIS611_-_Retrieve_Public_Data_via_Web_Service.pdf

Examples

if (FALSE) { # \dontrun{
# Assume you have set the following environment variables:
# - FFIEC_USER_ID
# - FFIEC_BEARER_TOKEN

# Retrieve facsimile data for reporting period 2025-03-31 for instutition
# with ID RSSD "480228"
get_facsimile(
  reporting_period_end_date = "03/31/2025",
  fi_id = 480228
)

# Retrieve facsimile data for reporting period 2025-03-31 for instutition
# with FDIC Cert Number "3510"
get_facsimile(
  reporting_period_end_date = "03/31/2025",
  fi_id_type = "FDICCertNumber",
  fi_id = "3510"
)

} # }