v1

latestOpenAPI 3.1.02026-08-061838260.7 KB

Filer Management API

Filing credentials verification

The filing credentials verification API provides the ability to view filing credentials for an EDGAR account/CIK. The API GET method requires the filer API token and the user API token in the header along with the relevant CIK in the path of the URL. The individual associated with the user API token must be a user, account administrator, delegated user, or delegated account administrator of the CIK for which the filing credentials are to be verified. The filer API token supplied for the request must either match the CIK for which filing credentials are to be verified or the CIK of the filer API token must have delegation from that CIK.

get/fm/{cik}/verify

Path parameters

cikstring required

Response

OK. The request was successful.

trackingstring

A universal tracking identifier that can be used by applications to keep track of individual requests sent to the EDGAR API. The tracking identifier correlates all actions taken in the course of a single request. If seeking support from the EDGAR Help Desk this will be a useful piece of information to provide.

locatorstring

A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.

canFileboolean

boolean value describing if a filing can be made or not with the provided user api token, filer api token and cik

confirmationDueDatestring date-time

filerApiTokenExpirationDatestring date-time

userApiTokenExpirationDatestring date-time

Example response

{
  "messages": [
    {
      "content": "The Filer API Key making this request will expire in less than two weeks."
    }
  ],
  "confirmationDueDate": "2022-03-10T12:15:50-04:00",
  "filerApiTokenExpirationDate": "2022-03-10T12:15:50-04:00",
  "userApiTokenExpirationDate": "2022-03-10T12:15:50-04:00"
}