The communication object

The Communications API records all Check-owned communications with an end user across various communication methods (email, text, etc.).

Communications can be created by Check through our Direct To Employer Communications offering, or can be triggered automatically by Check's notifications system.

{
      "id": "cmn_MrFrw0F82NSJjyw10Erk",
      "company": "com_zH8Gq33iBkFj5o0GKjTw",
      "recipient_type": "company_email",
      "recipient": "com_zH8Gq33iBkFj5o0GKjTw",
      "type": "email",
      "originator": "check",
      "email": {
        "to": [
          "[email protected]"
        ],
        "from": "[email protected]",
        "cc": [
          "[email protected]"
        ],
        "reply_to": "[email protected]",
        "subject": "Check <> Example Coffee",
        "no_reply": false
      },
      "notification": null,
      "created_at": "2024-01-19 17:04:15+00"
}

{
      "id": "cmn_MrFrw0F82NSJjyw10Erk",
      "company": "com_zH8Gq33iBkFj5o0GKjTw",
      "recipient_type": "company_email",
      "recipient": "com_zH8Gq33iBkFj5o0GKjTw",
      "type": "email",
      "originator": "check",
      "email": {
        "to": [
          "[email protected]"
        ],
        "from": "[email protected]",
        "cc": [
          "[email protected]"
        ],
        "reply_to": "[email protected]",
        "subject": "Check <> Example Coffee",
        "no_reply": false
      },
      "notification": {
        "id": "ntf_oQkuvGaD5xJmZXphKySd",
        "topic": "ready_for_payroll"
      },
      "created_at": "2024-01-19 17:04:15+00"
}

Attribute	Description
`id` string	Unique identifier of the communication.
`company` string	ID of the company that this communication relates to.
`recipient_type` enum	Type of communication recipient. Can be `company_email`, `employee_email`, `contractor_email`.
`recipient` string	ID of the intended recipient of the communication
`type` string	Type of communication. Can be `email` or `text`.
`originator` string	Party that originated the message. Can be `check` or `company`.
`email` email object	Metadata about the email type, recipients, and senders, if applicable.
`notification` object	Metadata about the associated `Notification` (if it exists).
`created_at` string	The time when the communication was created.