List outstanding requirements

Returns requirements — data inputs, documents, or registrations needed before filings can proceed.

Filter by businessId for a business-wide view (all categories), or by personId to see what a specific worker is missing. At least one of businessId or personId must be provided.

Requirements are generated automatically based on the business’s jurisdictions and workforce composition. They update dynamically as workers are added or laws change.

GET /v1/statutory/requirements

List outstanding requirements

cURL

curl --request GET \
  --url https://api.cadanapay.com/v1/statutory/requirements \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "category": "business_registration",
      "status": "outstanding",
      "name": "SAT Employer RFC",
      "description": "A valid RFC is required to file ISR returns with the Servicio de Administración Tributaria (SAT)",
      "affectedField": "taxId",
      "resourceType": "business",
      "resourceId": "bus_abc123",
      "resolutionGuide": "Submit via PUT /v1/statutory/businesses/{id}/fields/{countryCode}",
      "affectedPersons": [
        {
          "personId": "per_01ABC",
          "personName": "María García López",
          "missingField": "taxId",
          "missingFieldLabel": "RFC (Registro Federal de Contribuyentes)"
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

businessId · string

Filter by business. Required unless personId is provided.

personId · string

Filter by person. Returns only worker_data requirements where this person appears in affected_persons. Useful for building per-worker onboarding or compliance views.

countryCode · string

Filter by jurisdiction (ISO 3166-1 alpha-2)

status · enum<string>

Available options: outstanding, satisfied, waived

category · enum<string>

Available options: business_registration, business_document, business_tax_parameter, worker_data

Response

200 - application/json

List of requirements

data · object[]

Show child attributes