Submit filing

POST

https://api.sureshake.com/v2/filings/{id}/submit

Path parameters

id
string
required
format: uuid

Request body JSON required

idempotencyKey
string
required
minLength: 1

Returns

200

Default Response

JSON

data
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
optional
object
- timestamp
  string
  required
  format: date-time
}

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
}

Submit filing

curl --request POST \
  --url 'https://api.sureshake.com/v2/filings/<id>/submit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "string"
}
'

const url = 'https://api.sureshake.com/v2/filings/<id>/submit';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({idempotencyKey: 'string'})
};

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

import requests

url = "https://api.sureshake.com/v2/filings/<id>/submit"

payload = { "idempotencyKey": "string" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "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"
  }
}