API Reference›Servicing Workspace›External signals›Test a connection

Test a connection

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/{providerCode}/connection-testsImplementedBearer token ·ADMIN_SERVICING_INTEGRATION

Probes the provider, records the attempt against the connection, and activates nothing; the body is ignored and a simulated lane reports that a simulator answered rather than a vendor.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/$PROVIDER_CODE/connection-tests \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/${providerCode}/connection-tests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey },
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/{provider_code}/connection-tests",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
)

{
  "resourceId": null,
  "changes": {
    "operation": "CONNECTION_TEST",
    "providerCode": "WATCHMAN",
    "passed": true,
    "simulated": true,
    "detail": "The in-process simulator answered. No vendor was contacted."
  }
}

{
  "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.
providerCode required in path	string	Stable opaque providerCode identifier.
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.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/$PROVIDER_CODE/connection-tests \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/${providerCode}/connection-tests`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey },
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/{provider_code}/connection-tests",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
)

{
  "resourceId": null,
  "changes": {
    "operation": "CONNECTION_TEST",
    "providerCode": "WATCHMAN",
    "passed": true,
    "simulated": true,
    "detail": "The in-process simulator answered. No vendor was contacted."
  }
}

{
  "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": []
}