Servicings

List servicings

List enabled Servicings (per-borrower relationship hubs). Only applicable to v3 of the protocol. Authentication is required. Users see servicings for borrowers they have access to.

get/v3/servicings

Request

Base URL: https://api.creditcoop.xyz
URL: https://api.creditcoop.xyz/v3/servicings
Auth: one of:
- API key in header x-api-key
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)

Query parameters

organizationIdstring uuid

Filter by borrower organization ID. Example: 550e8400-e29b-41d4-a716-446655440000

networkIdstring

Filter by network ID (CAIP-2 blockchain ID), e.g., eip155:1 (Ethereum), eip155:8453 (Base)

limitinteger

offsetinteger

expandstring[]

Comma-separated list of fields to expand. Valid values: "status" (includes the cross-default status (closed, isDefaulted, worst breach level)), "asset" (includes the accounting unit (asset token + decimals) every raw amount is denominated in), "organization" (includes full organization object with links), "related-addresses" (includes the borrower and trustee addresses), "collateral" (includes the collateral pool with advance rates, raw value and USD value), "facilities" (includes the facilities bound to this servicing), "capacity" (includes the shared borrowing-base aggregates (advanced value, drawn, committed, remaining)), "covenants" (includes the per-covenant breach levels behind the cross-default status).

Response

Default Response

Example response

{
  "servicings": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:8453",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "asset": {
        "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      },
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      },
      "relatedAddresses": {
        "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "trustee": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      },
      "collateral": [
        {
          "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "advanceRateBps": 8000,
          "decimals": 6,
          "valueUsd": "1234.56",
          "asset": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "collateralToken": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "owner": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
        }
      ],
      "facilities": [
        {
          "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
        }
      ],
      "covenants": [
        {
          "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "cureWindow": "86400",
          "kind": "GreaterThanCovenant",
          "defaultedSince": "0",
          "params": {
            "target": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
            "callData": "0x18160ddd",
            "threshold": "100000000000",
            "expectedHash": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
            "facility": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
            "signer": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
            "attestationWindow": "604800",
            "deployedAt": "1712345678",
            "servicer": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.