diff --git a/documentation/api/filing/beta-platform.md b/documentation/api/filing/beta-platform.md index 92d8a8d7..0a0318b2 100644 --- a/documentation/api/filing/beta-platform.md +++ b/documentation/api/filing/beta-platform.md @@ -7,54 +7,19 @@ The [HMDA Beta Platform](https://ffiec.beta.cfpb.gov/filing) is a test environme ## Authorization

-Please note: Starting on January 1st 2025, for the 2025 HMDA Filling season, all users will be required to authenticate using Login.gov. In order to integrate with the HMDA Platform using Login.gov please contact HMDA Help (hmdahelp@cfpb.gov). +The HMDA Beta Platform is for test purposes only. Any data submitted WILL NOT be considered as evidence of regulatory compliance. For official Submissions, please visit https://ffiec.cfpb.gov/filing. -

- -To simulate filing of HMDA data using the Beta Filing API, a _bearer_ authorization token is required for all Beta Filing API calls. To acquire an authorization token use the `/auth` endpoint with your username and password as payload. - -For local development, no authorization is needed. See [One-line Local Development Environment (No Auth)](https://github.com/cfpb/hmda-platform#one-line-local-development-environment-no-auth) for more info. - -

-Please note: The HMDA Beta Platform is for test purposes only. Any data submitted WILL NOT be considered as evidence of regulatory compliance. For official Submissions, please visit https://ffiec.cfpb.gov/filing. +Please note: Starting on January 1st 2025, for the 2025 HMDA Filling season, all users will be required to authenticate using Login.gov.

-Request - -``` -TOKEN=$(curl -s 'https://ffiec.beta.cfpb.gov/auth/realms/hmda2/protocol/openid-connect/token' ---header 'Content-Type: application/x-www-form-urlencoded' ---data-urlencode 'client_id=hmda2-api' ---data-urlencode 'grant_type=password' ---data-urlencode 'username=xxxx' ---data-urlencode 'password=xxx' | jq .""access_token"" | tr -d '"') && echo $TOKEN -``` - - | | ----|--- -Method | `POST` -URL | `https://ffiec.beta.cfpb.gov/auth/realms/hmda2/protocol/openid-connect/token` -Payload | client_id=hmda2-api
grant_type=password
username=```{{username}}@{{bank_domain}}```
password=`{{password}}` - -### Error Messages +### Getting a Bearer Token -error | error_description | explanation ----|---|--- -invalid_grant | Account is not fully set up | Either the `password` needs to be reset or the `email` needs to be verified.. -invalid_grant | Account disabled | Please contact HMDA Help (hmdahelp@cfpb.gov) in order to re-enable the account. -invalid_grant | Invalid user credentials | The `username` or `password` provided is incorrect. +In lieu of directly getting a token from an API call you will be required to go through the HMDA UI and obtain a Bearer Token via the HMDA User account page. -### Password Policy +In the top right of the UI, click your name. It will take you to the Profile page. Scroll to the bottom and hover over the `Developer Settings` and click the `Copy Auth Token` option, it will copy the Bearer Token to your clipboard which can then be used for API calls. -- Users must reset their password every 90 days. This 90 days is from when the account's password was last set. -- Passwords must: - - Be at least 12 characters - - Have at least 1 uppercase character - - Have at least 1 lowercase character - - Have at least 1 numerical character - - Have at least 1 special character - - Not be the same as your username +![LoginGov HMDA Auth Token](/img/api/login_gov_token.gif) ## Postman Collection diff --git a/documentation/api/filing/platform.md b/documentation/api/filing/platform.md index 57821573..2f8f4bc2 100644 --- a/documentation/api/filing/platform.md +++ b/documentation/api/filing/platform.md @@ -7,52 +7,18 @@ This API powers the [HMDA Filing application](https://ffiec.cfpb.gov/filing/) ## Authorization

-Please note: Starting on January 1st 2025, for the 2025 HMDA Filling season, all users will be required to authenticate using Login.gov. In order to integrate with the HMDA Platform using Login.gov please contact HMDA Help (hmdahelp@cfpb.gov). - +Please note: Starting on January 1st 2025, for the 2025 HMDA Filling season, all users will be required to authenticate using Login.gov.

-To file HMDA data using the Filing API, a _bearer_ authorization token is required for all Filing API calls. To acquire an authorization token use the `/auth` endpoint with your username and password as payload. - -For local development, no authorization is needed. See [One-line Local Development Environment (No Auth)](https://github.com/cfpb/hmda-platform#one-line-local-development-environment-no-auth) for more info. - - -Request - -``` -TOKEN=$(curl -s 'https://ffiec.cfpb.gov/auth/realms/hmda2/protocol/openid-connect/token' ---header 'Content-Type: application/x-www-form-urlencoded' ---data-urlencode 'client_id=hmda2-api' ---data-urlencode 'grant_type=password' ---data-urlencode 'username=xxxx' ---data-urlencode 'password=xxx' | jq .""access_token"" | tr -d '"') && echo $TOKEN -``` - - | | ----|--- -Method | `POST` -URL | `https://ffiec.cfpb.gov/auth/realms/hmda2/protocol/openid-connect/token` -Payload | client_id=hmda2-api
grant_type=password
username=`{{username}}@{{bank_domain}}`
password=`{{password}}` - -### Error Messages - -error | error_description | explanation ----|---|--- -invalid_grant | Account is not fully set up | Either the `password` needs to be reset or the `email` needs to be verified.. -invalid_grant | Account disabled | Please contact HMDA Help (hmdahelp@cfpb.gov) in order to re-enable the account. -invalid_grant | Invalid user credentials | The `username` or `password` provided is incorrect. +Follow the [Login.gov FAQ](/documentation/faq/login-gov-quick-reference) on creating a new HMDA User account via the HMDA Login.gov UI and go through the process of new user registration. -### Password Policy +### Getting a Bearer Token -- Users must reset their password every 90 days. This 90 days is from when the account's password was last set. -- Passwords must: - - Be at least 12 characters - - Have at least 1 uppercase character - - Have at least 1 lowercase character - - Have at least 1 numerical character - - Have at least 1 special character - - Not be the same as your username +In lieu of directly getting a token from an API call you will be required to go through the HMDA UI and obtain a Bearer Token via the HMDA User account page. +In the top right of the UI, click your name. It will take you to the Profile page. Scroll to the bottom and hover over the `Developer Settings` and click the `Copy Auth Token` option, it will copy the Bearer Token to your clipboard which can then be used for API calls. +![LoginGov HMDA Auth Token](/img/api/login_gov_token.gif) ## Postman Collection diff --git a/documentation/faq/data-collection-timelines.md b/documentation/faq/data-collection-timelines.md index 96cc0f11..27fcec27 100644 --- a/documentation/faq/data-collection-timelines.md +++ b/documentation/faq/data-collection-timelines.md @@ -43,6 +43,10 @@ See below for information on HMDA Annual Filing period dates: ![](https://raw.githubusercontent.com/cfpb/hmda-frontend/master/src/documentation/markdown/images/annual_filing.png) +If March 1 falls on a Saturday or Sunday, what is the filing deadline for submission of HMDA data? + +As stated in Section 1003.5(a)(1)(iii) when the last day for submission falls on a Saturday or Sunday, a submission shall be considered timely if it is submitted on the next succeeding Monday. For example, submissions of 2019 HMDA data were considered timely if received on or before Monday, March 2, 2020. + ## Quarterly Filing Period Dates Beginning January 1, 2020, the 2015 HMDA Final Rule requires quarterly reporting for financial institutions that reported a combined total of at least 60,000 applications and covered loans, excluding purchased covered loans, for the preceding calendar year. Thus, in addition to their annual data submission, these larger-volume reporters will submit HMDA data for each of the first three quarters of the year on a quarterly basis. Further information can be found in Regulation C, 12 CFR 1003.5(a)(1)(ii). diff --git a/documentation/faq/filing-faq.md b/documentation/faq/filing-faq.md index a188efa7..a90146fb 100644 --- a/documentation/faq/filing-faq.md +++ b/documentation/faq/filing-faq.md @@ -79,7 +79,7 @@ If using two separate systems to create your LAR File, please combine all entrie ## Submission ### If March 1 falls on a Saturday or Sunday, what is the filing deadline for submission of HMDA data? -As stated in Section 1003.5(a)(1)(iii) when the last day for submission falls on a Saturday or Sunday, a submission shall be considered timely if it is submitted on the next succeeding Monday. For example, submissions of 2019 HMDA data were considered timely if received on or before Monday, March 2, 2020. +As stated in Section 1003.5(a)(1)(iii) when the last day for submission falls on a Saturday or Sunday, a submission shall be considered timely if it is submitted on the next succeeding Monday. For example, submissions of 2019 HMDA data were considered timely if received on or before Monday, March 2, 2020. ### When is the filing period? The **Annual filing** period is between January 1 and March 1 of each year. The HMDA Filing Platform for each filing period opens January 1st. The submission deadline is March 1st. diff --git a/fig_versioned_docs/version-2025/tables/version-log.json b/fig_versioned_docs/version-2025/tables/version-log.json index dd9765ac..25d29b47 100644 --- a/fig_versioned_docs/version-2025/tables/version-log.json +++ b/fig_versioned_docs/version-2025/tables/version-log.json @@ -3,6 +3,12 @@ "Date": "July 2024", "Version": "1.0", "Section": "", - "Changes": "Original Document
Changes from 2024 FIG:

1. Section 1 and 1.2, Section 3.4, Table 1, Section 4.2.1, and Section 5.32. Section 2.23. Section 3.4 Table 24. Section 4.2.25. Section 5.3, Table 36. Section 5.3, Table 57. Section 5.3, Table 78. Section 5.3, Table 99. Section 5.3, Table 1010. Section 6.1 Frequently Asked Questions 11. Section 6.2 HMDA Help" + "Changes": "Original Document
Changes from 2024 FIG:

1. Section 1 and 1.2, Section 3.4, Table 1, Section 4.2.1, and Section 5.32. Section 2.23. Section 3.4 Table 24. Section 4.2.25. Section 5.2, Table 36. Section 5.3, Table 57. Section 5.3, Table 78. Section 5.3, Table 99. Section 5.3, Table 1010. Section 6.1 Frequently Asked Questions 11. Section 6.2 HMDA Help" + }, + { + "Date": "December 2024", + "Version": "1.1", + "Section": "", + "Changes": "Updated Version Log number 5 with the correct section number, which displays the 2025 revised and new edits." } ] diff --git a/static/img/api/login_gov_token.gif b/static/img/api/login_gov_token.gif new file mode 100644 index 00000000..8a1bbb26 Binary files /dev/null and b/static/img/api/login_gov_token.gif differ diff --git a/static/img/filing/quarterly_filing.png b/static/img/filing/quarterly_filing.png index eb8a9952..090a7c82 100644 Binary files a/static/img/filing/quarterly_filing.png and b/static/img/filing/quarterly_filing.png differ