POST /servicings

Used to run ServicingActions on a completed Pull without involving the consumer again. Servicing starts as soon as the Pull holds a servicing consent: one the consumer gave in the hosted widget, or one you attest here with consent_language. A request with neither fails with SERVICING_CONSENT_REQUIRED. While a batch of the same category is still being worked on the Pull, a new request returns 409 SERVICING_IN_PROGRESS instead of starting a second one, so a retried request never submits the change twice.

Subscribe a webhook to SERVICING_STATUS_UPDATED to hear about each action as its status changes, including verification and work by Canopy's servicing team. Each batch also ends with one COMPLETE (every change reached the carrier) or ERROR (data.servicing_action_ids names the actions that did not). These webhooks carry the servicing Pull's pull_id and pull_type: SERVICING, so match them to your request by servicing_action_id, or poll GET /servicings with the original pull_id.

In sandbox, each action's carrier_policy_number picks its outcome: SANDBOX-VALIDATION-ERROR, SANDBOX-VERIFICATION-FAILED, SANDBOX-VERIFIED-WITHOUT-DOCUMENT, or any other value for VERIFIED. Each step takes a few seconds.

Path Params
uuid
required

ID of Team

Body Params
uuid
required

ID of the completed Pull to service.

servicing_actions
array of objects
required
length between 1 and 10

Actions from one servicing category (mortgagee, vehicle, or lienholder) per request.

servicing_actions*
enum
required
Allowed:
payload
object
required

Input required for a ServicingAction. Corresponds with the type.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json