Skip to content

Commit

Permalink
Merge pull request #79 from cfpb/2301-quarterly-filer-dates-update
Browse files Browse the repository at this point in the history
Updated Quarterly Filing Period Dates Image
  • Loading branch information
Michaeldremy authored Dec 31, 2024
2 parents d61b5f3 + 0b4bf2a commit bbf7f7b
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 83 deletions.
47 changes: 6 additions & 41 deletions documentation/api/filing/beta-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,54 +7,19 @@ The [HMDA Beta Platform](https://ffiec.beta.cfpb.gov/filing) is a test environme
## Authorization

<p style={{ background: '#ffe4c4', paddingLeft: '10px', paddingTop: '10px', paddingBottom: '10px' }}>
<b><u>Please note:</u></b> 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 <b>HMDA Beta Platform</b> is for <b>test purposes only</b>. Any data submitted <b>WILL NOT</b> be considered as evidence of regulatory compliance. For official Submissions, please visit <a href='https://ffiec.cfpb.gov/filing'>https://ffiec.cfpb.gov/filing</a>.

</p>

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.

<p style={{ background: '#ffe4c4', paddingLeft: '10px', paddingTop: '10px', paddingBottom: '10px' }}>
<b><u>Please note:</u></b> The <b>HMDA Beta Platform</b> is for <b>test purposes only</b>. Any data submitted <b>WILL NOT</b> be considered as evidence of regulatory compliance. For official Submissions, please visit <a href='https://ffiec.cfpb.gov/filing'>https://ffiec.cfpb.gov/filing</a>.
<b><u>Please note:</u></b> Starting on January 1st 2025, for the 2025 HMDA Filling season, all users will be required to authenticate using Login.gov.

</p>

<b>Request</b>

```
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 <br/> grant_type=password <br/> username=```{{username}}@{{bank_domain}}``` <br/> 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 ([email protected]) 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

Expand Down
46 changes: 6 additions & 40 deletions documentation/api/filing/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,52 +7,18 @@ This API powers the [HMDA Filing application](https://ffiec.cfpb.gov/filing/)
## Authorization

<p style={{ background: '#ffe4c4', paddingLeft: '10px', paddingTop: '10px', paddingBottom: '10px' }}>
<b><u>Please note:</u></b> 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 ([email protected]).

<b><u>Please note:</u></b> Starting on January 1st 2025, for the 2025 HMDA Filling season, all users will be required to authenticate using Login.gov.
</p>

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.


<b>Request</b>

```
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 <br/> grant_type=password <br/> username=`{{username}}@{{bank_domain}}` <br/> 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 ([email protected]) 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

Expand Down
4 changes: 4 additions & 0 deletions documentation/faq/data-collection-timelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a target="_blank" rel="noopener noreferrer" href="https://www.consumerfinance.gov/policy-compliance/rulemaking/regulations/1003/5/#a-1">Section 1003.5(a)(1)(iii)</a> 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 <a target="_blank" rel="noopener noreferrer" href="https://www.consumerfinance.gov/rules-policy/regulations/1003/5/#a-1-ii">Regulation C, 12 CFR 1003.5(a)(1)(ii)</a>.
Expand Down
2 changes: 1 addition & 1 deletion documentation/faq/filing-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
<a target="_blank" rel="noopener noreferrer" href="https://www.consumerfinance.gov/policy-compliance/rulemaking/regulations/1003/5/#a-1">As stated in Section 1003.5(a)(1)(iii)</a> 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 <a target="_blank" rel="noopener noreferrer" href="https://www.consumerfinance.gov/policy-compliance/rulemaking/regulations/1003/5/#a-1">Section 1003.5(a)(1)(iii)</a> 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 <a target="_blank" rel="noopener noreferrer" href="https://ffiec.cfpb.gov/documentation/faq/data-collection-timelines#annual-filing-period-dates">January 1 and March 1</a> of each year. The <a target="_blank" rel="noopener noreferrer" href="https://ffiec.cfpb.gov/filing">HMDA Filing Platform</a> for each filing period opens January 1st. The submission deadline is March 1st.
Expand Down
8 changes: 7 additions & 1 deletion fig_versioned_docs/version-2025/tables/version-log.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"Date": "July 2024",
"Version": "1.0",
"Section": "",
"Changes": "<strong>Original Document</strong><br /><strong>Changes from 2024 FIG:</strong><br /><br /><strong>1. Section 1 and 1.2, Section 3.4, Table 1, Section 4.2.1, and Section 5.3</strong><ul><li>Updated Calendar Year values</li></ul><strong>2. Section 2.2</strong><ul><li>Removed Self Service Knowledge Portal and added HMDA's Frequently Asked Questions and its weblink</li><li>Removed Federal Reserve Board's email address for technical HMDA questions collected in or before 2016 and added National Archives and Records Administration’s email address</li></ul><strong>3. Section 3.4 Table 2</strong><ul><li>Updated examples for Application Date and Action Taken Date</li><li>Added footnote to Ethnicity of Applicant or Borrower: 1 and Race of Applicant or Borrower: 1</li></ul><strong>4. Section 4.2.2</strong><ul><li>Updated examples for Application Date and Action Taken Date</li><li>Updated the Census Tract description</li></ul><strong>5. Section 5.3, Table 3</strong><ul><li>Updated 2025 New and Revised Edits</li></ul><strong>6. Section 5.3, Table 5</strong><ul><li>Updated edit V695</li></ul><strong>7. Section 5.3, Table 7</strong><ul><li>Updated edit Q616</li><li>Updated edit Q621</li><li>Updated edit Q646</li><li>Updated edit Q651</li></ul><strong>8. Section 5.3, Table 9</strong><ul><li>Updated edit Q647</li></ul><strong>9. Section 5.3, Table 10</strong><ul><li>Changed edit S303 to edit Q303 and updated edit Q303</li></ul><strong>10. Section 6.1 Frequently Asked Questions</strong><ul><li>Removed Self Service Knowledge Portal and added HMDA's Frequently Asked Questions and its weblink</li></ul> <strong>11. Section 6.2 HMDA Help</strong><ul><li>Removed Federal Reserve Board's email address for technical HMDA questions collected in or before 2016 and added National Archives and Records Administration’s email address</li></ul>"
"Changes": "<strong>Original Document</strong><br /><strong>Changes from 2024 FIG:</strong><br /><br /><strong>1. Section 1 and 1.2, Section 3.4, Table 1, Section 4.2.1, and Section 5.3</strong><ul><li>Updated Calendar Year values</li></ul><strong>2. Section 2.2</strong><ul><li>Removed Self Service Knowledge Portal and added HMDA's Frequently Asked Questions and its weblink</li><li>Removed Federal Reserve Board's email address for technical HMDA questions collected in or before 2016 and added National Archives and Records Administration’s email address</li></ul><strong>3. Section 3.4 Table 2</strong><ul><li>Updated examples for Application Date and Action Taken Date</li><li>Added footnote to Ethnicity of Applicant or Borrower: 1 and Race of Applicant or Borrower: 1</li></ul><strong>4. Section 4.2.2</strong><ul><li>Updated examples for Application Date and Action Taken Date</li><li>Updated the Census Tract description</li></ul><strong>5. Section 5.2, Table 3</strong><ul><li>Updated 2025 New and Revised Edits</li></ul><strong>6. Section 5.3, Table 5</strong><ul><li>Updated edit V695</li></ul><strong>7. Section 5.3, Table 7</strong><ul><li>Updated edit Q616</li><li>Updated edit Q621</li><li>Updated edit Q646</li><li>Updated edit Q651</li></ul><strong>8. Section 5.3, Table 9</strong><ul><li>Updated edit Q647</li></ul><strong>9. Section 5.3, Table 10</strong><ul><li>Changed edit S303 to edit Q303 and updated edit Q303</li></ul><strong>10. Section 6.1 Frequently Asked Questions</strong><ul><li>Removed Self Service Knowledge Portal and added HMDA's Frequently Asked Questions and its weblink</li></ul> <strong>11. Section 6.2 HMDA Help</strong><ul><li>Removed Federal Reserve Board's email address for technical HMDA questions collected in or before 2016 and added National Archives and Records Administration’s email address</li></ul>"
},
{
"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."
}
]
Binary file added static/img/api/login_gov_token.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/filing/quarterly_filing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bbf7f7b

Please sign in to comment.