generated from cfpb/open-source-project-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Endpoints ‐ Submissions
jcadam14 edited this page May 3, 2024
·
19 revisions
-
GET /v1/filing/institutions/{lei}/filings/{period_code}/submissions
- returns all Submission JSON objects for the passed in lei and period code- Returns 204 NO_CONTENT if submission list is empty for LEI and period
-
GET /v1/filing/institutions/{lei}/filings/{period_code}/submissions/latest
- returns the most current Submission JSON object for the passed in lei and period code- See sequence Sequences ‐ Get Submission
- Returns 204 NO_CONTENT if no submission for LEI and period
-
GET /v1/filing/institutions/{lei}/filings/{period_code}/submissions/{id}
- return specific Submission JSON object for passed in submission id- See sequence Sequences ‐ Get Submission
- Returns 204 NO_CONTENT if no submission for LEI and period
-
POST /v1/filing/institutions/{lei}/filings/{period_code}/submissions
- Uploads a submission file. This will generate and return a new Submission JSON- See sequence Sequences ‐ Post Submission
- See sequence Sequences ‐ Validate Submission
-
PUT /v1/filing/institutions/{lei}/filings/{period_code}/submissions/{id}/accept
- Accepts a Submission. This will return the updated Submission JSON -
GET /v1/filing/institutions/{lei}/filings/{period_code}/submissions/latest/report
- returns a csv format report file for the latest Submission validation results. -
GET /v1/filing/institutions/{lei}/filings/{period_code}/submissions/{submission_id}/report
- - returns a csv format report file for the Submission validation results for the passed in id.
- 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