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

Administer a connection

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

Runs exactly one of ACTIVATE, PAUSE, UPDATE_SETTINGS, BIND_CREDENTIAL or SCREEN_NOW against a connection under an optimistic expectedVersion, binding only a secret-manager reference and never a raw secret.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/$PROVIDER_CODE/commands \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "operation": "BIND_CREDENTIAL",
  "expectedVersion": 3,
  "secretRef": "secretsmanager://lendeasy/watchman/api-key",
  "settings": {
    "scheduleKind": "DAILY",
    "dailyAtLocalTime": "02: 00"
  },
  "customerRef": "cust-8814",
  "reason": "Rotating the sanctions provider key after the quarterly review."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/${providerCode}/commands`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "operation": "BIND_CREDENTIAL",
  "expectedVersion": 3,
  "secretRef": "secretsmanager://lendeasy/watchman/api-key",
  "settings": {
    "scheduleKind": "DAILY",
    "dailyAtLocalTime": "02: 00"
  },
  "customerRef": "cust-8814",
  "reason": "Rotating the sanctions provider key after the quarterly review."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/{provider_code}/commands",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "operation": "BIND_CREDENTIAL",
  "expectedVersion": 3,
  "secretRef": "secretsmanager://lendeasy/watchman/api-key",
  "settings": {
    "scheduleKind": "DAILY",
    "dailyAtLocalTime": "02: 00"
  },
  "customerRef": "cust-8814",
  "reason": "Rotating the sanctions provider key after the quarterly review."
},
)

{
  "resourceId": null,
  "changes": {
    "operation": "BIND_CREDENTIAL",
    "providerCode": "WATCHMAN"
  }
}

{
  "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.

Body parameters

Field	Type	Description
operation required	string
expectedVersion optional	integer
secretRef optional	string
settings optional	object
scheduleKind	string
dailyAtLocalTime	string
customerRef optional	string
reason optional	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/$PROVIDER_CODE/commands \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "operation": "BIND_CREDENTIAL",
  "expectedVersion": 3,
  "secretRef": "secretsmanager://lendeasy/watchman/api-key",
  "settings": {
    "scheduleKind": "DAILY",
    "dailyAtLocalTime": "02: 00"
  },
  "customerRef": "cust-8814",
  "reason": "Rotating the sanctions provider key after the quarterly review."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/${providerCode}/commands`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "operation": "BIND_CREDENTIAL",
  "expectedVersion": 3,
  "secretRef": "secretsmanager://lendeasy/watchman/api-key",
  "settings": {
    "scheduleKind": "DAILY",
    "dailyAtLocalTime": "02: 00"
  },
  "customerRef": "cust-8814",
  "reason": "Rotating the sanctions provider key after the quarterly review."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/external-integrations/{provider_code}/commands",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "operation": "BIND_CREDENTIAL",
  "expectedVersion": 3,
  "secretRef": "secretsmanager://lendeasy/watchman/api-key",
  "settings": {
    "scheduleKind": "DAILY",
    "dailyAtLocalTime": "02: 00"
  },
  "customerRef": "cust-8814",
  "reason": "Rotating the sanctions provider key after the quarterly review."
},
)

{
  "resourceId": null,
  "changes": {
    "operation": "BIND_CREDENTIAL",
    "providerCode": "WATCHMAN"
  }
}

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