CHcheckhq

List requirements

Changed on

Get a paginated list of all requirements for a company.

get/requirements

Request

Query parameters

category'company_provided_documents' | 'required_tax_id' | 'failed_payroll_debit'

Filter by requirement categories

requirement'signatory_identity_verification' | 'signatory_authorization_verification' | 'company_identity_verification' | 'federal_ein_verification' | 'company_financial_verification' | 'state_registration_verification' | 'bank_account_verification' | 'tax_parameters_fed' | 'tax_parameters_al' | 'resolve_funding_failure'

Filter by requirement names

status'open' | 'pending' | 'closed' | 'failed' | 'resolved'

Filter by requirement statuses

companystring

Filter by companies

Response

200

nextunknown
previousunknown

Example response

{
  "results": [
    {
      "id": "req_lstqlstqlstqlstqlstql",
      "company": "com_yvgimu7i60cwfod0jhaft",
      "requirement": "company_identity_verification",
      "categories": [
        "company_provided_documents"
      ],
      "status": "open",
      "guidance": {
        "document_options": [
          {
            "name": "articles_of_incorporation",
            "label": "Articles of Incorporation (Company registration document)"
          }
        ]
      }
    }
  ]
}

Changes