Get a Compliance Alert

🚧

Limited Availability

Access to the Compliance API is currently limited to approved partners. Endpoints, request/response shapes, and field names may change before reaching general availability — use against staging for early integration work and coordinate with your CorpNet account manager before relying on Compliance API calls in production-critical paths. Report issues or feedback to your account manager.

GET /v1/partners/{partnerId}/alerts/{alertId}

Returns a single compliance alert with full detail — including the prefilled complianceForms data and line-item opportunityProducts — that your application presents to the customer for review and submission.

Path Parameters

ParameterTypeRequiredDescription
partnerIdStringYesYour Account PID.
alertIdStringYesCompliance Alert identifier (returned by List Compliance Alerts).

Example

curl -s \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  "https://api.corpnet.com/v1/partners/P123456/alerts/006VB00000K3al0YAB"

Response — 200 OK

{
  "data": {
    "id": "006VB00000K3al0YAB",
    "name": "Registered Agent - DE - Sample Company LLC",
    "serviceCategory": "Registered Agent",
    "closeDate": "2025-12-31",
    "amount": 149.00,
    "description": "Annual registered agent renewal for Delaware",
    "status": "Prospecting",
    "companyName": "Sample Company LLC",
    "serviceState": "DE",
    "companyId": "a0EVB00000GPzIP2A1",
    "productPackageId": "a0X5e000001ABCD",
    "oppDueDate": "2025-12-15",
    "opportunityType": "Compliance Alert",
    "entityStatus": "Active",
    "entityType": "LLC",
    "alertType": "Registered Agent",
    "alertBody": "Your registered agent service is due for renewal.",
    "alertActualDueDate": "2025-12-31",
    "complianceForms": [
      {
        "formDataId": "a0FVB00000ABC123",
        "formDefinitions": [
          {
            "formDefinitionName": "RA_DE_Form",
            "formDefinitionId": "a0GVB00000DEF456",
            "formTitle": "Delaware Registered Agent",
            "statePicklist": "DE",
            "version": "1.0",
            "sections": {
              "EntityState": {
                "Filed_Qualification_Date": "2020-05-15",
                "EntityNumber": "7654321"
              },
              "FranchiseTaxInformation": {
                "CountofCommonStockShares": "1000",
                "CountofPreferredStockShares": "0"
              },
              "root": {
                "ForeignQualified": false
              }
            }
          }
        ]
      }
    ],
    "opportunityProducts": [
      {
        "id": "00kVB00000GHI789",
        "price": 149.00,
        "productName": "Delaware Registered Agent Service",
        "listPrice": 149.00,
        "unitPrice": 149.00,
        "quantity": 1,
        "state": "DE",
        "productFamily": "Compliance",
        "formioId": null,
        "productDisplayType": "Required"
      }
    ]
  },
  "statusCode": 200,
  "message": "Success"
}

Response Fields

FieldTypeDescription
idStringAlert identifier (alertId).
nameStringHuman-readable alert name.
serviceCategoryStringTop-level service category (Registered Agent, Annual Report, etc.).
closeDateStringTarget close date for the alert.
amountNumberTotal dollar amount for the alert.
descriptionStringFree-text alert description.
statusStringSales-stage status (Prospecting, etc.).
companyNameStringName of the company this alert is for.
serviceStateStringTwo-letter state code where the service applies.
companyIdStringCompany identifier.
productPackageIdStringIdentifier of the product package associated with this alert.
oppDueDateStringInternal opportunity due date.
opportunityTypeStringAlways Compliance Alert for this endpoint.
entityStatusStringStatus of the associated company.
entityTypeStringEntity type of the associated company.
alertTypeStringAlert classification (e.g., Registered Agent).
alertBodyStringCustomer-facing alert message.
alertActualDueDateStringThe actual statutory due date the alert tracks.
complianceFormsArrayPrefilled form data — same shape as in List Compliance Alerts.
opportunityProductsArrayLine items (products) for this alert.

Notes

  • Use this endpoint when your customer drills into a specific alert in your UI — the complianceForms payload is what you render as the editable form.
  • Submit the completed form via Submit Compliance Form Data using the same formDataId and formDefinitionId from the response.