SEC EDGAR Filer Management API API
A set of API endpoints that allows you to verify permissions, get filer information, manage CCC, manage individuals, and manage delegations.
OpenAPI Specification
openapi: 3.0.3
info:
title: SEC EDGAR Data Company Concept Filer Management API API
description: 'The EDGAR Data API at data.sec.gov provides RESTful access to public company financial filings, XBRL structured financial data, and company metadata without requiring authentication or API keys. The API delivers JSON-formatted responses covering company submissions (filing history), XBRL financial facts across all reporting periods, single XBRL concept values over time, and cross-company comparative frames for US-GAAP and IFRS taxonomies.
'
version: 1.0.0
contact:
name: SEC EDGAR Help
url: https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany
license:
name: Public Domain
url: https://www.sec.gov/privacy.htm
termsOfService: https://www.sec.gov/privacy.htm
servers:
- url: https://data.sec.gov
description: SEC EDGAR Data API
tags:
- name: Filer Management API
description: ' A set of API endpoints that allows you to verify permissions, get filer information, manage CCC, manage individuals, and manage delegations.
'
paths:
/fm/{cik}:
get:
summary: View filer account information
description: 'The view filer account information API provides the ability to view filer information for an EDGAR account/CIK.
This API will require the following inputs: the filer API token, the user API token, and the EDGAR account/CIK
for which information is being retrieved.
The individual associated with the user API token must be a user, account administrator, delegated user, delegated
account administrator, or technical administrator of the CIK for which account information is to be viewed.
The filer API token supplied for the request must either match that CIK or the CIK of the filer API token must have delegation from that CIK.
'
operationId: View Filer Account Information
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
responses:
'200':
description: OK. The request was successful.
content:
application/json:
examples:
OK:
description: Details about a filer/entity (e.g., name, address, dba-name, foreign-name, etc.)
value:
tracking: f0bd5ef3aaf666475b7b466d46120973
locator: nfkkg
messages:
- type: INFO
content: OK
filerInfo:
- cik: '0000000000'
stateCode: TX
irsNumber: '000000000'
entityType: A
dateIncorporated: '1970-01-01 00:00:00'
sicCode: '6189'
fyEnd: '0630'
individualOrCompany: C
specialFilerType: string
legalEntityIdentifier: ABCD123456789012
repFileNum: 123-123456-12
dateModified: '2024-01-01T12:00:00Z'
entityName: Filers Inc
entityDbaName: string
entityForeignName: string
mailIsForeignAddress: 'false'
mailStreet1: 123 Broadway
mailStreet2: Suite 200
mailCity: Dallas
mailStateCode: K3
mailForeignState: Maharashtra
mailZip: '75240'
businessIsForeignAddress: false
businessStreet1: 123 Broadway
businessStreet2: Suite 200
businessCity: Dallas
businessStateCode: TX
businessForeignState: null
businessZip: '75240'
peoStreet1: string
peoStreet2: string
peoCity: string
peoStateCode: string
peoZip: string
acctName: Chris
acctPhone: 555-555-5555
acctStreet1: 123 MAIN ST. - BILLING
acctStreet2: null
acctCity: ANYTOWN
acctStateCode: TX
acctZip: '12345'
acctEmail: chris@somecompany.com
contName: James Smith
contPhone: 555-555-5555
contEmail: james@somecopany.com
mailingPhone: 555-555-5555
businessPhone: 555-555-5555
ccc: '@1B2C3d4'
confirmationDueDate: Date
singleEntityCompany: 'false'
website: www.somecompany.com
series: []
schema:
$ref: '#/components/schemas/FilerInfoResponse'
'400':
description: Bad request. The request was not successful, possibly due to invalid data
content:
application/json:
examples:
Bad request:
description: Input error (invalid data)
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
messages:
- type: ERROR
message: Invalid data
schema:
$ref: '#/components/schemas/IndividualInfoResponse'
'401':
description: Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.
content:
application/json:
examples:
Unauthorized:
description: The request does not include any valid tokens for accessing this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Unauthorized
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.
content:
application/json:
examples:
Forbidden:
description: The request had included valid tokens but that does not give access to this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Forbidden.
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error. An unexpected server-side error has occurred.
content:
application/json:
examples:
Internal server error:
description: An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.
value:
tracking: 937de162bf9f1b6e7fc2bfb1165c1998
locator: 19ab67
messages:
- type: ERROR
content: An unexpected error has occurred.
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Filer API Token and User API Token: []
servers:
- url: https://api.edgarfiling.sec.gov
description: EDGAR Filer Management API
/fm/{cik}/ccc:
post:
summary: Generate CCC
description: 'The generate CCC API allows a filer to have EDGAR randomly generate a new CCC for the filer. This API will require the filer API token, the user API token,
and the CIK of the EDGAR account for which the CCC will be generated. The individual associated with the user API token must be
an account administrator of the EDGAR account/CIK for which the CCC is to be generated. The filer API token supplied for the request
must either match the CIK of the EDGAR account for which the CCC is to be generated or the CIK of the filer API token must have
delegation from that CIK.
'
operationId: Generate CCC
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
responses:
'200':
description: OK. The request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/FilerCCCResponse'
'400':
description: Bad request. The request was not successful, possibly due to invalid data
content:
application/json:
examples:
Bad request:
description: Input error (invalid data)
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
messages:
- type: ERROR
message: Invalid data
schema:
$ref: '#/components/schemas/IndividualInfoResponse'
'401':
description: Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.
content:
application/json:
examples:
Unauthorized:
description: The request does not include any valid tokens for accessing this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Unauthorized
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.
content:
application/json:
examples:
Forbidden:
description: The request had included valid tokens but that does not give access to this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Forbidden.
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error. An unexpected server-side error has occurred.
content:
application/json:
examples:
Internal server error:
description: An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.
value:
tracking: 937de162bf9f1b6e7fc2bfb1165c1998
locator: 19ab67
messages:
- type: ERROR
content: An unexpected error has occurred.
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Filer API Token and User API Token: []
servers:
- url: https://api.edgarfiling.sec.gov
description: EDGAR Filer Management API
put:
summary: Create custom CCC
description: 'The create custom CCC API allows a filer to specify a new CCC. The API will require the following inputs: the filer API token, the user API token,
the CIK of the EDGAR account for which the custom CCC will be created, the current CCC, and the new CCC. The individual associated with
the user API token must be an account administrator of the EDGAR account/CIK for which the CCC is to be changed. The filer API token supplied for
the request must either match the CIK for which the CCC is to be changed or the CIK of the filer API token must have delegation from that CIK.
'
operationId: Create Custom CCC
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
requestBody:
description: Update CCC object (Current CCC, Replacement CCC)
content:
application/json:
examples:
Update CCC:
summary: Update CCC
description: Update CCC
value:
currentCCC: xxxxxxxx
replacementCCC: yyyyyyyy
schema:
$ref: '#/components/schemas/UpdateCCC'
required: true
responses:
'200':
description: OK. The request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/FilerCCCResponse'
'400':
description: Bad request. The request was not successful, possibly due to invalid data
content:
application/json:
examples:
Bad request:
description: Input error (invalid data)
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
messages:
- type: ERROR
message: Invalid data
schema:
$ref: '#/components/schemas/IndividualInfoResponse'
'401':
description: Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.
content:
application/json:
examples:
Unauthorized:
description: The request does not include any valid tokens for accessing this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Unauthorized
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.
content:
application/json:
examples:
Forbidden:
description: The request had included valid tokens but that does not give access to this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Forbidden.
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error. An unexpected server-side error has occurred.
content:
application/json:
examples:
Internal server error:
description: An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.
value:
tracking: 937de162bf9f1b6e7fc2bfb1165c1998
locator: 19ab67
messages:
- type: ERROR
content: An unexpected error has occurred.
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Filer API Token and User API Token: []
servers:
- url: https://api.edgarfiling.sec.gov
description: EDGAR Filer Management API
/fm/{cik}/delegationRequests:
post:
summary: Request delegation invitations
description: 'The request delegation invitations API provides the ability for an EDGAR account (for example, a filing agent) to request delegation from one
or more filers. If a filer accepts the delegation request, a delegation invitation will be sent from the filer to the EDGAR account requesting
delegation. If the delegation invitation is accepted by the EDGAR account requesting delegation, that EDGAR account will become a delegated
entity that can submit filings on behalf of the filer. This API will require the following inputs: the filer API token, the user API token,
the CIK belonging to the requesting EDGAR account that would like to become a delegated entity, and CIK(s) that will receive the delegation
request. The individual associated with the user API token must be an account administrator of the CIK requesting a delegation invitation.
The filer API token supplied for the request must match the CIK requesting a delegation invitation.
'
operationId: Request Delegation Invitations
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
requestBody:
description: List of delegation request filer/entity CIKs
content:
application/json:
examples:
Delegation request to single CIK:
summary: Delegation request single CIK
description: Delegation request to single CIK
value:
- '0000000001'
Delegation request to multiple CIKs:
summary: Delegation request to multiple CIKs
description: Delegation request to multiple CIKs
value:
- '0000000001'
- '0000000002'
schema:
type: array
items:
type: string
required: true
responses:
'200':
description: OK. The request was successful.
content:
application/json:
examples:
OK:
description: ADD DELEGATION REQUESTS OK description
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
messages:
- type: INFO
message: <<message>>
schema:
$ref: '#/components/schemas/FilerInfoResponse'
'400':
description: Bad request. The request was not successful, possibly due to invalid data
content:
application/json:
examples:
Bad request:
description: Input error (invalid data)
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
messages:
- type: ERROR
message: Invalid data
schema:
$ref: '#/components/schemas/IndividualInfoResponse'
'401':
description: Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.
content:
application/json:
examples:
Unauthorized:
description: The request does not include any valid tokens for accessing this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Unauthorized
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.
content:
application/json:
examples:
Forbidden:
description: The request had included valid tokens but that does not give access to this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Forbidden.
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error. An unexpected server-side error has occurred.
content:
application/json:
examples:
Internal server error:
description: An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.
value:
tracking: 937de162bf9f1b6e7fc2bfb1165c1998
locator: 19ab67
messages:
- type: ERROR
content: An unexpected error has occurred.
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Filer API Token and User API Token: []
servers:
- url: https://api.edgarfiling.sec.gov
description: EDGAR Filer Management API
/fm/{cik}/delegations:
post:
summary: Send delegation invitations
description: 'The send delegation invitations API provides the ability for a filer to delegate to one or more EDGAR accounts. If those EDGAR accounts accept
the delegation invitation, those EDGAR accounts will become delegated entities who can submit filings on behalf of the delegating filer.
This API will require the following inputs: the filer API token, the user API token, the delegating filer’s CIK, and a list of one or more
delegated entity CIKs that will receive the delegation invitation. The individual associated with the user API token must be an account
administrator of the CIK from which delegation invitations are to be sent. The filer API token supplied for the request must match that CIK.
'
operationId: Send Delegation Invitations
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
requestBody:
description: List of delegation filer/entity CIKs
content:
application/json:
examples:
Delegate to single CIK:
summary: Delegate to single CIK
description: Delegate to single CIK
value:
- '0000000001'
Delegate to multiple CIKs:
summary: Delegate to multiple CIKs
description: Delegate to multiple CIKs
value:
- '0000000001'
- '0000000002'
schema:
type: array
items:
type: string
required: true
responses:
'200':
description: OK. The request was successful.
content:
application/json:
examples:
OK:
description: ADD DELEGATIONS OK description
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
responses: []
messages:
- type: INFO
message: <<message>>
schema:
$ref: '#/components/schemas/FilerInfoResponse'
'400':
description: Bad request. The request was not successful, possibly due to invalid data
content:
application/json:
examples:
Bad request:
description: Input error (invalid data)
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
messages:
- type: ERROR
message: Invalid data
schema:
$ref: '#/components/schemas/IndividualInfoResponse'
'401':
description: Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.
content:
application/json:
examples:
Unauthorized:
description: The request does not include any valid tokens for accessing this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Unauthorized
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.
content:
application/json:
examples:
Forbidden:
description: The request had included valid tokens but that does not give access to this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Forbidden.
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error. An unexpected server-side error has occurred.
content:
application/json:
examples:
Internal server error:
description: An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.
value:
tracking: 937de162bf9f1b6e7fc2bfb1165c1998
locator: 19ab67
messages:
- type: ERROR
content: An unexpected error has occurred.
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Filer API Token and User API Token: []
servers:
- url: https://api.edgarfiling.sec.gov
description: EDGAR Filer Management API
get:
summary: View delegations
description: 'The view delegations API provides the ability for a filer/EDGAR account to retrieve a list of all its delegations to and from other
EDGAR accounts/CIKs. This API will require the following inputs: the filer API token, the user API token, and the EDGAR account/CIK
for which delegation information is to be retrieved. The individual associated with the user API token must be a user or an account
administrator of the CIK for which delegation information is to be retrieved. The filer API token supplied for the request must match that CIK.
'
operationId: View Delegations
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
responses:
'200':
description: OK. The request was successful.
content:
application/json:
examples:
OK:
description: GET DELEGATIONS OK description
value:
tracking: c209d91efee936e1d315d868f06f763d
locator: 47a94d
delegationsTo: []
delegationsFrom: []
messages:
- type: INFO
message: OK
schema:
$ref: '#/components/schemas/DelegationInfoResponse'
'401':
description: Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.
content:
application/json:
examples:
Unauthorized:
description: The request does not include any valid tokens for accessing this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Unauthorized
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.
content:
application/json:
examples:
Forbidden:
description: The request had included valid tokens but that does not give access to this resource.
value:
tracking: 68e8ce7c1552544bccbdccd2663dced4
locator: 19ab67
messages:
- type: ERROR
content: Forbidden.
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error. An unexpected server-side error has occurred.
content:
application/json:
examples:
Internal server error:
description: An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.
value:
tracking: 937de162bf9f1b6e7fc2bfb1165c1998
locator: 19ab67
messages:
- type: ERROR
content: An unexpected error has occurred.
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- Filer API Token and User API Token: []
servers:
- url: https://api.edgarfiling.sec.gov
description: EDGAR Filer Management API
/fm/{cik}/individuals:
post:
summary: Add individuals
description: 'The add individuals API allows for one or more individuals to be added in specific role(s) for a filer. This API will require the following
inputs: the filer API token, the user API token, the EDGAR account CIK for which individuals are to be added, a list of individuals
(identified by their names and Login.gov email addresses), and their new roles. The individual associated with the user API token must be
an account administrator of the CIK for which individuals are to be added. The filer API token supplied for the request must either match
the CIK for which individuals are to be added or the CIK of the filer API token must have delegation from that CIK.
'
operationId: Add Individuals
tags:
- Filer Management API
parameters:
- name: cik
in: path
required: true
schema:
type: string
pattern: \d{10}
requestBody:
description: List of individuals and associated roles
content:
application/json:
examples:
Add Single Individual:
# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sec/refs/heads/main/openapi/sec-filer-management-api-api-openapi.yml