DOdoola
Required Actions

List a company's required actions

Changed on

Every required action for the company, most recently changed first, including ones already resolved or rejected. Use this to reconcile after missing webhooks. Histories are omitted here; read a single action for those.

get/v1/partner/companies/{companyId}/required-actions

Request

  • Base URL
    https://api.test.doola.com
  • URL
    https://api.test.doola.com/v1/partner/companies/{companyId}/required-actions
  • Auth
    API key in header Authorization

Path parameters

companyIdstring required

doola company ID (KSUID).

Response

OK

requiredActionIdstring
doolaCompanyIdstring
actionCode'FORMATION_NAME_OPTIONS_EXHAUSTED' | 'FORMATION_SIGNATURE_SS4_RESET' | 'FORMATION_SIGNATURE_FORM8821_REQUIRED' | 'FORMATION_FOUNDER_ADDRESS_REQUIRED'

What is needed

actionNamestring

Human-readable label for the action

status'created' | 'delivered' | 'delivery_failed' | 'submitted' | 'rejected' | 'resolved'
reasonstring

Human-readable explanation you can surface to your user

requestedFieldIdsstring[]

Field ids to send back when resolving, named as GET /compliance/annual-reports/requirements names them. Empty when closing the action needs something other than field values.

openboolean
awaitingResponseboolean

True while doola is waiting for you to act on this action; false once you have submitted a resolution or the action is closed

updatedAtstring date-time

When this action last changed

Example response

[
  {
    "requiredActionId": "31pLdpvMh4OfO90moxLgLT8AuQr",
    "doolaCompanyId": "31pLD0Tq2lm2FsgRBoHv4x3BpzZ",
    "actionCode": "FORMATION_NAME_OPTIONS_EXHAUSTED",
    "actionName": "New company names needed",
    "status": "delivered",
    "reason": "All submitted company name options were rejected by the state. Submit new options.",
    "requestedFieldIds": [
      "address"
    ],
    "history": [
      {
        "status": "delivered",
        "submittedPayload": {
          "actionCode": "FORMATION_NAME_OPTIONS_EXHAUSTED",
          "nameOptions": [
            {
              "name": "Acme Holdings",
              "entityTypeEnding": "LLC"
            }
          ],
          "addresses": [
            {
              "provider": "customer",
              "type": "business"
            }
          ],
          "companyDetails": {
            "address": {
              "provider": "customer",
              "type": "business"
            },
            "mailingAddress": {
              "provider": "customer",
              "type": "business"
            },
            "physicalAddress": {
              "provider": "customer",
              "type": "business"
            }
          }
        }
      }
    ]
  }
]

Changes