Get chain

GET

https://api.sureshake.com/v2/filings/chain/{entityId}/{schemaType}

Path parameters

entityId
string
required
format: uuid

schemaType
string
required

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- schemaType
  income_statement
  or
  balance_sheet
  or
  cash_flow_statement
  or
  statement_of_financial_condition
  or
  accounts_receivable_aging
  or
  accounts_payable_aging
  +5 more
  required
- schemaVersion
  string
  required
- reportingPeriodId
  string
  required
  format: uuid
- status
  draft
  or
  submitted
  or
  verified
  or
  amended
  required
- content
  map of
  unknown
  required
- contentHash
  string
  or null
  required
- chainHash
  string
  or null
  required
- previousFilingId
  string
  or null
  required
  format: uuid
- idempotencyKey
  string
  or null
  required
- verificationTier
  L0
  or
  L1
  or
  L2
  required
- verificationMeta
  map of
  unknown
  or null
  required
- createdBy
  string
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- submittedAt
  string
  or null
  required
  format: date-time
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Get chain

curl --request GET \
  --url 'https://api.sureshake.com/v2/filings/chain/<entityId>/<schemaType>'

const url = 'https://api.sureshake.com/v2/filings/chain/<entityId>/<schemaType>';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
      "schemaType": "income_statement",
      "schemaVersion": "string",
      "reportingPeriodId": "4d3a574f-0d14-4aef-b0da-4f1f86c93716",
      "status": "draft",
      "content": {
        "property1": null,
        "property2": null
      },
      "contentHash": "string",
      "chainHash": "string",
      "previousFilingId": "9fc03ee5-508d-4b05-b0f6-b18b684875ec",
      "idempotencyKey": "string",
      "verificationTier": "L0",
      "verificationMeta": {
        "property1": null,
        "property2": null
      },
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "submittedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}