> ## Documentation Index
> Fetch the complete documentation index at: https://developer.karmacheck.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Case status change

> Webhook event payload and properties for the case.statuschange event.

The `case.statuschange` event is sent to the webhook whenever the status of a case changes.

Note that additional events can occur even after a case reaches a completion status. For instance, you might receive a notification when a case is complete, then receive a subsequent webhook indicating that the case reverted to a pending status because an additional service was added.

## Payload example

```json theme={null}
{
  "messageId": "d824e0f6-92fc-c05b-abd3-ebda5cd2a028",
  "event": "case.statuschange",
  "apiTrackingCode": null,
  "apiTrackingUser": null,
  "eventObject": {
    "id": "3edec2585-29fd-4e85-ae5f-b251d1007ecd",
    "crStamp": "2024-05-25T19:16:55.000Z",
    "crUserId": "dec23950-32d3-4d85-9ef1-2a77d14d9d17",
    "caseTypeId": "cde61186-4f22-45f4-9e19-429061365bce",
    "caseType": "Background Check",
    "caseStatusId": "22334455-937e-46b1-8799-887766554433",
    "caseStatus": "Complete",
    "secondaryCaseStatusId": null,
    "secondaryStatus": null,
    "resultType": "Open",
    "modStamp": "2024-05-25T19:18:11.000Z",
    "candidateId": "fe2d4d28-229b-4f4d-c1d6-fbedcb189275",
    "candidateEmail": "lee@example.com",
    "candidateGivenName": "Lee",
    "candidateFamilyName": "Johnson",
    "packageId": "d04dece1-1ea5-43fc-2832-231a5d23a08b",
    "packageName": "Basic Check",
    "packageCompanyName": null,
    "billingReferenceId": "f04dece1-1ea2-53fc-1823-231a5d23a08b",
    "groupProfileId": "dd2346e4-ed17-2c66-ce22-06ae7e372fd2",
    "resultTypeId": "8c94f0d9-57c9-4c7b-be95-5ec309cff330",
    "caseInvitationId": "d18286a6-2920-1397-bdef-8118b939305d",
    "invitationStatusId": "d1962405-dd97-48f2-bede-530c2895481f",
    "invitationStatusName": "completed",
    "invitationGivenName": "Lee",
    "invitationFamilyName": "Johnson",
    "companyId": "dde1eafd-232b-39e8-dff4-f1be061eba2c",
    "companyName": "Example Company",
    "companyCommonName": null,
    "companyLogo": null,
    "archived": 0,
    "serviceGroupId": "b3582ef5-72b7-4e48-9973-858464f01141",
    "invitationEmail": "lee@example.com",
    "isMinorCandidate": 0,
    "hasParentalConsent": 0,
    "groupName": "Default",
    "adverseActionId": null,
    "adverseActionStatusName": null,
    "adverseActionStatusId": null,
    "orderedStamp": "2024-05-25T19:16:55.000Z",
    "beginOnboardingStamp": null,
    "completedOnboardingStamp": "2024-05-25T19:16:56.000Z",
    "beginProcessingStamp": "2024-05-25T19:16:57.000Z",
    "completedInitialProcessingStamp": "2024-05-25T19:18:11.000Z",
    "completedLatestProcessingStamp": "2024-05-25T19:18:11.000Z"
  }
}
```

## `CaseEvent` eventObject properties

| Property                          | Type             | Required   | Description                                              |
| --------------------------------- | ---------------- | ---------- | -------------------------------------------------------- |
| `id`                              | `string`         | `Required` | Unique identifier of the case.                           |
| `crStamp`                         | `string`         | `Required` | Creation timestamp.                                      |
| `crUserId`                        | `string`         | `Required` | User ID that created the case.                           |
| `caseTypeId`                      | `string`         | `Required` | Case type ID.                                            |
| `caseType`                        | `string`         | `Required` | Case type name.                                          |
| `caseStatusId`                    | `string`         | `Required` | Current case status ID.                                  |
| `caseStatus`                      | `string`         | `Required` | Current case status name.                                |
| `secondaryCaseStatusId`           | `string \| null` | `Required` | Secondary status ID, when present.                       |
| `secondaryStatus`                 | `string \| null` | `Required` | Secondary status name, when present.                     |
| `resultTypeId`                    | `string`         | `Required` | Result type ID.                                          |
| `resultType`                      | `string`         | `Required` | Result type name.                                        |
| `modStamp`                        | `string`         | `Required` | Last modified timestamp.                                 |
| `candidateId`                     | `string \| null` | `Required` | Candidate ID.                                            |
| `candidateEmail`                  | `string \| null` | `Required` | Candidate email.                                         |
| `candidateGivenName`              | `string \| null` | `Required` | Candidate first name.                                    |
| `candidateFamilyName`             | `string \| null` | `Required` | Candidate last name.                                     |
| `packageId`                       | `string`         | `Required` | Package ID.                                              |
| `packageName`                     | `string`         | `Required` | Package name.                                            |
| `packageCompanyName`              | `string \| null` | `Required` | Package company name.                                    |
| `billingReferenceId`              | `string`         | `Required` | Customer billing reference ID.                           |
| `groupProfileId`                  | `string`         | `Required` | Group profile ID.                                        |
| `caseInvitationId`                | `string`         | `Required` | Invitation ID for this case.                             |
| `invitationStatusId`              | `string`         | `Required` | Invitation status ID.                                    |
| `invitationStatusName`            | `string`         | `Required` | Invitation status name.                                  |
| `invitationGivenName`             | `string`         | `Required` | Invitation first name.                                   |
| `invitationFamilyName`            | `string`         | `Required` | Invitation last name.                                    |
| `companyId`                       | `string`         | `Required` | Company ID.                                              |
| `companyName`                     | `string`         | `Required` | Company name.                                            |
| `companyCommonName`               | `string \| null` | `Required` | Company common name.                                     |
| `companyLogo`                     | `string \| null` | `Required` | Company logo URL or value.                               |
| `archived`                        | `integer`        | `Required` | Boolean integer: `1` archived, `0` not archived.         |
| `serviceGroupId`                  | `string`         | `Required` | Service group ID.                                        |
| `invitationEmail`                 | `string`         | `Required` | Invitation email address.                                |
| `isMinorCandidate`                | `integer`        | `Required` | Boolean integer: `1` minor, `0` not minor.               |
| `hasParentalConsent`              | `integer`        | `Required` | Boolean integer: `1` consent provided, `0` not provided. |
| `groupName`                       | `string`         | `Required` | Group name.                                              |
| `adverseActionId`                 | `string \| null` | `Required` | Adverse action ID.                                       |
| `adverseActionStatusName`         | `string \| null` | `Required` | Adverse action status name.                              |
| `adverseActionStatusId`           | `string \| null` | `Required` | Adverse action status ID.                                |
| `orderedStamp`                    | `string`         | `Required` | Timestamp when case was ordered.                         |
| `beginOnboardingStamp`            | `string \| null` | `Required` | Timestamp when onboarding began.                         |
| `completedOnboardingStamp`        | `string \| null` | `Required` | Timestamp when onboarding completed.                     |
| `beginProcessingStamp`            | `string \| null` | `Required` | Timestamp when processing began.                         |
| `completedInitialProcessingStamp` | `string \| null` | `Required` | Timestamp when initial processing completed.             |
| `completedLatestProcessingStamp`  | `string \| null` | `Required` | Timestamp when latest processing completed.              |