Enrollment Statuses

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-enrollment-statuses-schema.json",
  "title": "Enrollment Statuses",
  "description": "A list of enrollment status information for one or more MIDs.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-ship-enrollment-openapi.yml#/components/schemas/EnrollmentStatuses",
  "type": "object",
  "properties": {
    "MIDs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EnrollmentStatus"
      }
    }
  },
  "$defs": {
    "EnrollmentStatus": {
      "title": "Enrollment Status",
      "type": "object",
      "properties": {
        "MID": {
          "type": "string",
          "description": "The MID to which the information in this object applies.",
          "pattern": "^(\\d{6}|\\d{9})$"
        },
        "program": {
          "type": "string",
          "description": "The program (Outbound or USPS Returns) in which the MID is enrolled. If the MID is enrolled in both programs, two objects will be returned, one for each program.\n\nNote:\n- `OUTBOUND` and `RETURNS` are obsolete.  The API will return either `Outbound` or `USPS Returns` instead.\n- `NONE` is obsolete.  The API will return a `404 - Not Found` error if the MID is not found.\n",
          "enum": [
            "Outbound",
            "USPS Returns",
            "OUTBOUND",
            "RETURNS",
            "NONE"
          ]
        },
        "startDate": {
          "type": "string",
          "description": "The date on which the MID's enrollment began.",
          "format": "date"
        },
        "epsAccountNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The EPS account number tied to the MID, if found and available."
        }
      },
      "additionalProperties": false,
      "description": "USPS Ship enrollment information for a single MID."
    }
  }
}