Servicings

Per-borrower servicing relationship hubs. Only applicable to v3 of the protocol — earlier protocol versions do not expose servicings.

List servicings

get

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.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

organizationIdstring · uuid · max: 36Optional

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

networkIdstring · max: 50Optional

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

limitinteger · min: 1 · max: 100OptionalDefault: 20

offsetintegerOptionalDefault: 0

Responses

200

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/servicings

HTTPcURLJavaScriptPython

GET /v3/servicings HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "servicings": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "networkId": "eip155:8453",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "status": {
        "closed": true,
        "isDefaulted": true,
        "breachLevel": "NONE"
      },
      "asset": {
        "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "decimals": 1
      },
      "organization": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "text",
        "slug": "text",
        "header": "text",
        "description": "text",
        "overview": "text",
        "links": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "label": "text",
            "linkText": "text",
            "iconUrl": "text",
            "url": "text"
          }
        ]
      },
      "relatedAddresses": {
        "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
        "trustee": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
      },
      "collateral": [
        {
          "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "advanceRateBps": 8000,
          "value": "text",
          "valueUsd": "1234.56",
          "level": "NONE"
        }
      ],
      "facilities": [
        {
          "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "facilityId": "123e4567-e89b-12d3-a456-426614174000",
          "organizationId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "capacity": {
        "totalAdvancedValue": "text",
        "totalDrawn": "text",
        "totalCommitted": "text",
        "remainingDrawCapacity": "text",
        "remainingOriginationCapacity": "text"
      },
      "covenants": [
        {
          "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
          "level": "NONE"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Get servicing by ID

get

Get a single Servicing by ID. Only applicable to v3 of the protocol. Authentication is required.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Path parameters

idstring · uuidRequired

Servicing ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

Responses

200

Default Response

application/json

idstring · uuidRequired

Servicing unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000

addressstringRequired

Servicing contract address

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequired

CAIP-2 network identifier

Example: eip155:8453

organizationIdstring · uuid · nullableRequired

Borrower organization ID

Example: 550e8400-e29b-41d4-a716-446655440000

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/servicings/{id}

HTTPcURLJavaScriptPython

GET /v3/servicings/{id} HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:8453",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "status": {
    "closed": true,
    "isDefaulted": true,
    "breachLevel": "NONE"
  },
  "asset": {
    "token": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "decimals": 1
  },
  "organization": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "text",
    "slug": "text",
    "header": "text",
    "description": "text",
    "overview": "text",
    "links": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "linkText": "text",
        "iconUrl": "text",
        "url": "text"
      }
    ]
  },
  "relatedAddresses": {
    "borrower": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "trustee": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
  },
  "collateral": [
    {
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "advanceRateBps": 8000,
      "value": "text",
      "valueUsd": "1234.56",
      "level": "NONE"
    }
  ],
  "facilities": [
    {
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "facilityId": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "capacity": {
    "totalAdvancedValue": "text",
    "totalDrawn": "text",
    "totalCommitted": "text",
    "remainingDrawCapacity": "text",
    "remainingOriginationCapacity": "text"
  },
  "covenants": [
    {
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "level": "NONE"
    }
  ]
}