Api referenceWorkspaces

Submit Evidence Envelope

Reference for Submit Evidence Envelope in the Hyperoru v1 API, including request, response, and authentication details.

POST/v1/workspaces/{workspace_id}/evidence-envelopes

Submit Evidence Envelope. Returns a typed response and a request ID for operational support.

Authorization

hyperoru_session<token>

Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.

In: cookie

Path Parameters

workspace_id*Workspace Id
Formatuuid

Header Parameters

Idempotency-Key*Idempotency-Key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/evidence-envelopes" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "authority": "string",    "collection_method": "string",    "envelope_id": "cd819e97-5425-4178-8fcc-567f1dc109ce",    "expires_at": "2019-08-24T14:15:22Z",    "idempotency_key": "stringst",    "issued_at": "2019-08-24T14:15:22Z",    "records": [      {        "confidence": 0,        "content_sha256": "string",        "evidence_id": "5360afe2-6320-4611-b2b1-06edeee7fc1e",        "kind": "string",        "observed_at": "2019-08-24T14:15:22Z",        "provider": "string",        "source_ref": "string",        "source_type": "code",        "subject_key": "string",        "summary": "string"      }    ],    "signature": {      "key_id": "string",      "value": "stringstringstringstringstringstringstri"    },    "source": {      "external_id": "string",      "kind": "code",      "observed_at": "2019-08-24T14:15:22Z",      "provider": "string",      "revision": "string"    },    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"  }'
{
  "receipt": {
    "accepted_at": "2019-08-24T14:15:22Z",
    "accepted_count": 0,
    "connector_run_id": "5eefb999-32aa-4c58-8359-61266d11f7ec",
    "created_at": "2019-08-24T14:15:22Z",
    "envelope_id": "cd819e97-5425-4178-8fcc-567f1dc109ce",
    "error_codes": [
      "string"
    ],
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "idempotency_key": "string",
    "issued_at": "2019-08-24T14:15:22Z",
    "mcp_ingestion_id": "e483dfbe-1f30-4fa8-8989-0c8f1530c157",
    "observed_at": "2019-08-24T14:15:22Z",
    "payload_sha256": "string",
    "producer_id": "48627843-6f79-4314-844d-c75457b8ae79",
    "record_count": 0,
    "rejected_count": 0,
    "schema_version": "string",
    "signature_key_id": "string",
    "signed_envelope_sha256": "string",
    "source_external_id": "string",
    "source_kind": "string",
    "source_provider": "string",
    "source_revision": "string",
    "status": "accepted",
    "submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
    "updated_at": "2019-08-24T14:15:22Z",
    "validation_errors": [
      {}
    ],
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
  },
  "replayed": false
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}

List Evidence Envelopes

Previous Page

Get Evidence Envelope Schema

Next Page