generated from cfpb/open-source-project-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Endpoints ‐ Filings
jcadam14 edited this page Oct 9, 2024
·
31 revisions
-
GET /v1/filing/institutions/{lei}/filings/{period_code}
- Returns Filing JSON for the passed in LEI and period code.- See sequence Sequences ‐ Get Filing
- If no filing started, returns a
204 NO_CONTENT
-
403 FORBIDDEN
if the user is not associated with the requested LEI
-
POST /v1/filing/institutions/{lei}/filings/{period_code}
- Returns newly created Filing JSON for the passed in LEI and period code.- No body is expected here. The new filing object is constructed from the lei and period in the path.
-
409 CONFLICT
code is returned if a POST is made for an existing Filing -
403 FORBIDDEN
if the user is not associated with the requested LEI
-
PUT /v1/filing/institutions/{lei}/filings/{period_code}/sign
- 'Signs' the Filing based on passed in filing id. Returns a Filing JSON with confirmation ID.- See sequence Sequences ‐ Sign Filing
-
403 FORBIDDEN
if the user is not associated with the requested LEI, if there is no latest Submission in the CERTIFIED state, or if the Contact Info is not complete.
-
PUT /v1/filing/institutions/{lei}/filings/{period_code}/institution-snapshot-id
- Updates the institution_snapshot_id in the Filing object. Expects a SnapshotUpdate JSON and returns the updated Filing JSON-
403 FORBIDDEN
if the user is not associated with the requested LEI
-
-
PUT /v1/filing/institutions/{lei}/filings/{period_code}/is-voluntary
- Updates the is_voluntary field in the Filing object. Expects a Voluntary JSON and returns the updated Filing JSON-
403 FORBIDDEN
if the user is not associated with the requested LEI
-
- Filing Period JSON
- Filing JSON
- SnapshotUpdate JSON
- Contact Info JSON
- Submission JSON
- Validation JSON
- Voluntary JSON
- Sequences ‐ Get Filing Periods
- Sequences ‐ Get Filing
- Sequences ‐ Create New Filing
- Sequences ‐ Update Filing
- Sequences ‐ Get Submission
- Sequences ‐ Post Submission
- Sequences ‐ Validate Submission
- Sequences ‐ Get Contact Info
- Sequences ‐ Update Contact Info
- Sequences ‐ Sign Filing
- Sequences ‐ Verify LEI is Active