SPsphereon-opensource
RouteExposures

Execute an externally initiated route exposure write

Changed on

Executes an explicitly registered external-write route exposure. The caller supplies the authenticated Party context, governed payload envelope, field mappings, governance metadata, governance metadata, optional idempotency key, and optional Party projection candidates. VDX evaluates policy server-side before any grant or throttle consumption. The response is an accepted, minimized, redacted, quarantined, or rejected governed-ingress receipt with canonical-field mapping, projection-candidate ids, policy lineage, idempotency result, payload hash, and later-use availability scope.

post/route/exposures/{exposureDescriptorId}/write

Request

Path parameters

exposureDescriptorIdstring required

Stable identifier of an externally callable route exposure descriptor.

Example:proof-vault-read-exposure

Stable identifier of a route exposure descriptor.

Request body

authMethodstring required

Auth or trust method accepted by the exposure descriptor.

payloadobject required

External payload values supplied by the caller.

idempotencyKeystring

Example request

{
  "authMethod": "bearer",
  "callerParty": {
    "partyId": "party-supplier"
  },
  "payload": {
    "supplierStatus": "valid"
  },
  "fieldMappings": [
    {
      "source": {
        "sourceFieldPath": "supplierStatus"
      },
      "target": {
        "canonicalFieldPath": "evidence.status"
      }
    }
  ],
  "governance": {
    "classification": "confidential",
    "legalBasis": "dpv:Contract",
    "purpose": "dpv:Audit",
    "auditCategory": "EXTERNAL_EXCHANGE"
  },
  "idempotencyKey": "supplier-status-1"
}

Response

Governed external-write receipt.

state'ACCEPTED' | 'MINIMIZED' | 'REDACTED' | 'QUARANTINED' | 'REJECTED' required

Result state for governed external write ingress.

runIdstring uuid

Stable identifier for a connector route or operation run.

exposureDescriptorIdstring required

Stable identifier of an externally callable route exposure descriptor.

logicalConnectionBindingIdstring required

Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance.

canonicalFieldsobject required

Canonical fields produced after mapping the external payload.

projectionCandidateIdsstring[] required
policyDecisionIdstring required
idempotencyResultstring required
payloadHashstring required
laterUseAvailabilityScopeConnectorOwnerSurface[] required

Example response

{
  "state": "ACCEPTED",
  "runId": "9a785884-63ea-4b07-9976-264a1fc595f1",
  "exposureDescriptorId": "proof-vault-read-exposure",
  "logicalConnectionBindingId": "brand-a-proof-vault",
  "canonicalFields": {
    "evidence.status": "valid"
  },
  "projectionCandidateIds": [
    "supplier-party-1"
  ],
  "policyDecisionId": "policy-external-write",
  "idempotencyResult": "accepted:supplier-status-1",
  "payloadHash": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "laterUseAvailabilityScope": [
    "FORM",
    "OID4VCI",
    "OID4VP",
    "WORKFLOW"
  ]
}

Changes

  • 60cb8c70871bRevision changes
    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the pattern ^sha256:[0-9a-f]{64}$ to the request property //

    • breaking

      added the pattern ^sha256:[0-9a-f]{64}$ to the request property //

    • breaking

      added the pattern ^sha256:[0-9a-f]{64}$ to the request property //

    • breaking

      added the pattern ^sha256:[0-9a-f]{64}$ to the request property //

    • warning

      removed the request property

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      the response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status