API Reference›Servicing Workspace›Servicing administration›Remove an integration credential

Remove an integration credential

DELETEhttps://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/{providerCode}/{secretKind}ImplementedBearer token ·MANAGE_SERVICING_INTEGRATION_SECRET

Destroys one stored credential and reports the removal, treating the absence of a credential as success rather than an error.

Request

curl -X DELETE https://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/$PROVIDER_CODE/$SECRET_KIND \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/${providerCode}/${secretKind}`, {
  method: "DELETE",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey },
});

requests.delete(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/{provider_code}/{secret_kind}",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
)

{
  "resourceId": 412,
  "changes": {
    "secretKind": "BUREAU_SFTP_PRIVATE_KEY",
    "removed": true
  }
}

{
  "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.
secretKind required in path	string	Stable opaque secretKind 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 DELETE https://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/$PROVIDER_CODE/$SECRET_KIND \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/${providerCode}/${secretKind}`, {
  method: "DELETE",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey },
});

requests.delete(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/integration-credentials/{provider_code}/{secret_kind}",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
)

{
  "resourceId": 412,
  "changes": {
    "secretKind": "BUREAU_SFTP_PRIVATE_KEY",
    "removed": true
  }
}

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