generated from cfpb/open-source-project-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #79 from cfpb/2301-quarterly-filer-dates-update
Updated Quarterly Filing Period Dates Image
- Loading branch information
Showing
7 changed files
with
24 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.