easyship.account.verification.changed

📘

Only available for Easyship Enterprise API

Triggered when a company's Easyship identity verification (KYC) record is created, or transitions to requested, approved, marked_for_review, declined, manual_declined, or canceled. This event is only sent for Enterprise webhooks (registered on an organization, not an individual company).

Payload

Default version (v2023_01)

{
  "event_type": "easyship.account.verification.changed",
  "resource_type": "company_kyc_verification",
  "resource_id": "f3a1c2e4-5b6d-4a7e-8c9f-0123456789ab",
  "timestamp": "2025-01-15T10:30:00+00:00",
  "company_kyc_verification": {
    "easyship_company_id": "ES-123456",
    "message": "Your Easyship account verification is complete. You can now resume shipping!"
  }
}

v2024_09 and later

{
  "event_type": "easyship.account.verification.changed",
  "resource_type": "company_kyc_verification",
  "resource_id": "f3a1c2e4-5b6d-4a7e-8c9f-0123456789ab",
  "timestamp": "2025-01-15T10:30:00+00:00",
  "data": {
    "easyship_company_id": "ES-123456",
    "message": "Your Easyship account verification is complete. You can now resume shipping!"
  }
}

Fields

FieldTypeDescription
event_typestringAlways easyship.account.verification.changed
resource_typestringAlways company_kyc_verification
resource_idstringID of the company_kyc_verification record
timestampstringISO 8601 timestamp of when the event was generated
company_kyc_verification / dataobjectVerification details (data in v2024_09+, company_kyc_verification on the default version)
easyship_company_idstringThe Easyship company ID whose verification state changed
messagestringHuman-readable message describing the current verification state, suitable for displaying to the merchant