API Reference›Servicing Workspace›Credit reporting›List integration connections

List integration connections

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connectionsImplementedBearer token ·READ_SERVICING_FURNISHING

Returns connection registry rows for one purpose or for every purpose, reporting which credentials are declared and which are on file without ever revealing a value.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connections \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connections`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connections",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "integrations": [
    {
      "providerCode": "EQUIFAX",
      "purpose": "CREDIT_FURNISHING",
      "authKind": "SECRET_FIELDS",
      "connectionLabel": null,
      "connectionDetail": null,
      "declaredCredentials": [
        {
          "secretKind": "BUREAU_SFTP_PRIVATE_KEY",
          "label": "Transfer key",
          "hint": "The private key this bureau issued for file delivery.",
          "required": true
        },
        {
          "secretKind": "BUREAU_SFTP_PASSPHRASE",
          "label": "Key passphrase",
          "hint": "Only if the key is protected by one.",
          "required": false
        }
      ],
      "credentials": [],
      "displayName": "Equifax",
      "status": "DRAFT",
      "settingsVersion": 0,
      "expectedVersion": 0,
      "credentialState": "MISSING",
      "simulated": false,
      "lastConnectionTestAt": null,
      "lastConnectionTestStatus": null,
      "lastConnectionTestDetail": null,
      "lastSuccessAt": null
    }
  ]
}

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

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.
purpose optional in query	string	Narrow to one connection purpose; omit or pass ALL for every purpose. One of `EVENT_MONITORING · CREDIT_FURNISHING · ACCOUNTING_EXPORT · ALL`.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connections \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connections`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/credit-reporting/connections",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "integrations": [
    {
      "providerCode": "EQUIFAX",
      "purpose": "CREDIT_FURNISHING",
      "authKind": "SECRET_FIELDS",
      "connectionLabel": null,
      "connectionDetail": null,
      "declaredCredentials": [
        {
          "secretKind": "BUREAU_SFTP_PRIVATE_KEY",
          "label": "Transfer key",
          "hint": "The private key this bureau issued for file delivery.",
          "required": true
        },
        {
          "secretKind": "BUREAU_SFTP_PASSPHRASE",
          "label": "Key passphrase",
          "hint": "Only if the key is protected by one.",
          "required": false
        }
      ],
      "credentials": [],
      "displayName": "Equifax",
      "status": "DRAFT",
      "settingsVersion": 0,
      "expectedVersion": 0,
      "credentialState": "MISSING",
      "simulated": false,
      "lastConnectionTestAt": null,
      "lastConnectionTestStatus": null,
      "lastConnectionTestDetail": null,
      "lastSuccessAt": null
    }
  ]
}

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