Get attribute snapshot

{
  "snapshot_id": "8a7b6c5d4e3f2a1b0c9d8e7f",
  "version": 2,
  "status": "final",
  "created_at": "2024-04-10T14:45:02.684432+00:00",
  "payload": {
    "schema_version": "attributes.v1",
    "periods": [
      "2022",
      "2023"
    ],
    "attributes": {
      "tax_return_tax_gross_receipts": {
        "label": "Gross receipts",
        "unit": "money",
        "basis": "tax",
        "values": {
          "2022": "2210500.00",
          "2023": "2450000.00"
        },
        "documents": {
          "2022": [
            {
              "document_id": "7b6a59483726150493827160",
              "extraction_version": 1
            }
          ],
          "2023": [
            {
              "document_id": "123abc456def7890a1b2c3d4",
              "extraction_version": 1
            }
          ]
        }
      },
      "tax_return_tax_ebitda": {
        "label": "EBITDA (tax basis)",
        "unit": "money",
        "basis": "tax",
        "values": {
          "2022": "372800.00",
          "2023": "410250.00"
        },
        "documents": {
          "2022": [
            {
              "document_id": "7b6a59483726150493827160",
              "extraction_version": 1
            }
          ],
          "2023": [
            {
              "document_id": "123abc456def7890a1b2c3d4",
              "extraction_version": 1
            }
          ]
        }
      }
    },
    "ratios": {
      "tax_return_current_ratio": {
        "label": "Current ratio (Schedule L)",
        "unit": "ratio",
        "basis": "tax_return_tax",
        "values": {
          "2022": "1.6120",
          "2023": "1.7345"
        }
      }
    },
    "tables": {},
    "inputs": {
      "addbacks": [
        {
          "label": "Officer compensation",
          "direction": "add",
          "years": [
            "2023"
          ],
          "amount": {
            "2023": "185000.00"
          }
        }
      ],
      "dscr_configs": [
        {
          "name": "Standard DSCR",
          "numerator": "Adjusted EBITDA"
        }
      ],
      "hidden_rows": 0,
      "custom_visuals": 0,
      "custom_tables": 0
    }
  },
  "manifest": {
    "documents": [
      {
        "document_id": "7b6a59483726150493827160",
        "document_type": "1120s",
        "fiscal_year": 2022,
        "period_end": "2022-12-31",
        "extraction_version": 1
      },
      {
        "document_id": "123abc456def7890a1b2c3d4",
        "document_type": "1120s",
        "fiscal_year": 2023,
        "period_end": "2023-12-31",
        "extraction_version": 1
      }
    ],
    "inputs_summary": {
      "addbacks": 1,
      "dscr_configs": 1,
      "hidden_rows": 0,
      "custom_visuals": 0,
      "custom_tables": 0
    },
    "entity": {
      "key": "business:acme corporation",
      "name": "Acme Corporation"
    },
    "built_at": "2024-04-10T14:45:00Z",
    "builder_version": "8cb1de79f"
  },
  "spread_board_id": "0c9d8e7f6a5b4c3d2e1f0a9b",
  "finalized_at": "2024-04-10T14:45:02.684432+00:00",
  "finalized_by": "Avery Morgan",
  "finalized_by_external_user_id": null
}

Retrieves one attribute snapshot by id, with its payload. A snapshot under another loan returns a 404.

Requires the spreads:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

loan_idstringRequired

The loan's id.

snapshot_idstringRequired

The snapshot's id.

Response headers

X-Request-IDstringOptional

Correlation ID for this request. Quote it in support tickets.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

snapshot_idstring

versioninteger

Per-loan version number, counting up across every status.

statusenum

final (what an analyst approved at finalize), machine (the same loan built from the documents alone, with no analyst input) or draft (the latest autosave).

Allowed values:

created_atdatetime

payloadany

The figures, in the attributes.v1 payload schema: the fiscal periods, the named attributes and ratios keyed over them, and the analyst inputs that shaped them. Stored opaque and returned as stored; the name-by-name catalog is on the Spreads page in the API docs.

manifestany

What the payload was built from: the documents it drew on, a count-level summary of the analyst inputs, the entity scope, and when it was built. Stored opaque, documented alongside the payload on the Spreads page.

spread_board_idstring or nullOptional

The saved spread these values were taken from, when one is known.

finalized_atdatetime or nullOptional

When the analyst finalized. Set on final snapshots only.

finalized_bystring or nullOptional

Display name of the analyst who finalized the spread (final and machine snapshots); null on drafts and for callers who may not see names.

finalized_by_external_user_idstring or nullOptional

The external_user_id your embed session named for the analyst who finalized. It is your own identifier for that user, not a person’s name, so it is returned to every caller and a backend can join it to its own user table. Null on drafts, and null when the finalize happened in the SpreadSpace workspace or under an embed session that named no user.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response headers

Response

Errors