ServicingAction
| field | type | description | properties |
|---|---|---|---|
| servicing_action_id | string(uuid) | ID of the ServicingAction. | |
| status | Current state of the servicing action. - PROCESSING: Canopy received the request and is working on it. This includes waiting for the consumer to confirm the change.- SUBMITTED: Canopy sent the change to the carrier, and the carrier does not show it yet. When Canopy cannot check the change, the action stays in this status.- VERIFYING: The carrier shows the change. Canopy keeps checking for the updated declarations page.- VERIFIED: The carrier shows the change, and Canopy saved the updated declarations page.- VERIFIED_WITHOUT_DOCUMENT: The carrier shows the change, but no updated declarations page became available.- INTERNAL_ERROR: An error on Canopy's side stopped the action. A failed consumer login also lands here.- PROVIDER_ERROR: The carrier returned an error.- VALIDATION_ERROR: The change cannot be applied to the policy. validation_error_type says why.- UNCONFIRMED: The consumer declined the change or did not confirm it in time.- VERIFICATION_FAILED: The carrier showed something other than the requested change, or did not show the change within 14 days. | enum: PROCESSING, SUBMITTED, VERIFYING, VERIFIED, VERIFIED_WITHOUT_DOCUMENT, INTERNAL_ERROR, PROVIDER_ERROR, VALIDATION_ERROR, UNCONFIRMED, VERIFICATION_FAILED | |
| validation_error_type | string | null | Only present if status is VALIDATION_ERROR. | enum: INVALID_POLICY_NUMBER, INVALID_POLICY_TYPE, INVALID_MORTGAGEE_NAME, INVALID_MORTGAGEE_ADDRESS, DUPLICATE_MORTGAGEE_NAME, DUPLICATE_MORTGAGEE_TYPE, INVALID_MORTGAGEE_TYPE, POLICY_UNAVAILABLE_FOR_SERVICING, VEHICLE_UNAVAILABLE_FOR_SERVICING, REPLACING_VIN_NOT_FOUND, PRIMARY_DRIVER_NOT_FOUND, INVALID_VIN, INVALID_VEHICLE_ACQUISITION_DATE, REGISTERED_OWNER_NOT_FOUND, INVALID_FINANCING_COMPANY, INVALID_GARAGING_ADDRESS, GARAGING_ADDRESS_OUT_OF_STATE, CUSTOMER_SERVICE_REQUIRED, FINANCING_COMPANY_NOT_FOUND, DUPLICATE_FINANCING_COMPANY, OTHER_PARTIES_TO_NOTIFY_NOT_SUPPORTED, CANNOT_ADD_NEW_DRIVER, CANNOT_ADD_NEW_REGISTERED_OWNER, INVALID_SAFETY_RESTRAINT_DEVICE, ANTI_THEFT_DEVICE_REQUIRED, INVALID_COVERAGE_SELECTION, INVALID_PRIMARY_USE_TYPE, MULTIPLE_FINANCING_COMPANIES_NOT_ALLOWED |
| type | enum: ADD_MORTGAGEE, EDIT_MORTGAGEE, REMOVE_MORTGAGEE, ADD_VEHICLE | ||
| payload | object | Input required for a ServicingAction. Corresponds with the type. | |
| confirmation_data | object | Output provided for confirmation. Corresponds with the type. |