POST /servicings

post

https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/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.

Poll GET /servicings with pull_id for each action's status.

Path Params

teamId

uuid

required

ID of Team

Body Params

pull_id

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*

type

enum

required

Allowed:

payload

object

required

Input required for a ServicingAction. Corresponds with the type.

consent_language

string | null

The exact wording your UI showed the consumer when they consented to policy changes on their behalf, for example I authorize Acme Insurance to update my insurance policy on my behalf. Required when the Pull holds no servicing consent, and recorded whenever it is sent. Sending it requires Consent API access, the same as POST /consent.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response Schema

400400 Response Schema

401401 Response Schema

403403 Response Schema

404404 Response Schema

409409 Response Schema