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 Feb 7, 2024
·
31 revisions
-
GET /v1/filing/{period_name}
- Returns all Filing JSON for a period, based on the LEIs in the user access token -
POST /v1/filing/{lei}/filings/{id}
- Post updates to filing object, expected body contains Filing JSON object. Updates may be Filing Task state change, or Filing contact information. -
POST /v1/filing/{lei}/filings/{filing_id}/sign
- 'Signs' the Filing based on passed in filing id. Returns a Filing JSON with confirmation ID and updated task states.
- 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