API Reference›Servicing Plane›Interactions›Start a human outbound call

Start a human outbound call

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/calls/outboundImplementedBearer token ·SEND_SERVICING_INTERACTION

Creates the interaction evidence, runs the execution-time compliance gate immediately before dial, and dials through the configured telephony gateway only when the decision allows. The result is always 201 with persisted evidence: status is DIALING, BLOCKED, or FAILED, and failureCode is present unless the call is dialing. Collections calls must name the case-linked loan, and the contact point must be a verified eligible phone.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/calls/outbound \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": 1001,
  "customerRef": "123",
  "loanRef": "456",
  "contactPointRef": "phone-1",
  "reasonCode": "PAYMENT_FAILURE",
  "recordingRequested": false
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/calls/outbound`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": 1001,
  "customerRef": "123",
  "loanRef": "456",
  "contactPointRef": "phone-1",
  "reasonCode": "PAYMENT_FAILURE",
  "recordingRequested": false
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/calls/outbound",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "caseId": 1001,
  "customerRef": "123",
  "loanRef": "456",
  "contactPointRef": "phone-1",
  "reasonCode": "PAYMENT_FAILURE",
  "recordingRequested": false
},
)

{
  "callId": 7001,
  "interactionId": 3003,
  "contactAttemptId": 9401,
  "decisionId": 6117,
  "status": "DIALING",
  "gatewayCode": "VOICE_GATEWAY_PRIMARY",
  "dialAuthorized": true,
  "resourceId": 7001
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
caseId required	integer	Stable opaque servicing case identifier.
customerRef required	string
loanRef optional	string
contactPointRef required	string
reasonCode required	string	Configured structured reason code.
recordingRequested optional	boolean

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/calls/outbound \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": 1001,
  "customerRef": "123",
  "loanRef": "456",
  "contactPointRef": "phone-1",
  "reasonCode": "PAYMENT_FAILURE",
  "recordingRequested": false
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/calls/outbound`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": 1001,
  "customerRef": "123",
  "loanRef": "456",
  "contactPointRef": "phone-1",
  "reasonCode": "PAYMENT_FAILURE",
  "recordingRequested": false
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/calls/outbound",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "caseId": 1001,
  "customerRef": "123",
  "loanRef": "456",
  "contactPointRef": "phone-1",
  "reasonCode": "PAYMENT_FAILURE",
  "recordingRequested": false
},
)

{
  "callId": 7001,
  "interactionId": 3003,
  "contactAttemptId": 9401,
  "decisionId": 6117,
  "status": "DIALING",
  "gatewayCode": "VOICE_GATEWAY_PRIMARY",
  "dialAuthorized": true,
  "resourceId": 7001
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}