ConnectorInvocationBindings

Create a connector invocation binding

Changed on Jul 17, 2026

Creates or replaces a durable invocation binding for a product or protocol lifecycle stage. The stored binding carries the physical or logical connector target, subset mapping, governance metadata, Party anchors, materialization policy, and execution policy that the runtime will attach to resulting connector runs.

post/invocation/bindings

Request

Base URL
https://api.example.com/api/connector/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sphereon-opensource/apis/connector-integration-profile-api/docs/invocation/bindings/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "binding": {
    "invocationBindingId": "issuer-config-1:credential-request:hr-profile",
    "ownerSurface": "OID4VCI",
    "ownerReference": "issuer-config-1",
    "stage": "OID4VCI_CREDENTIAL_REQUEST",
    "role": "ENRICHMENT_SOURCE",
    "target": {
      "routeId": "1e8ff011-2274-4f16-a7dd-bf0b4fd5262f"
    },
    "exchangeMode": "PLATFORM_INITIATED_PULL",
    "dataDirection": "INBOUND",
    "initiationSide": "PLATFORM",
    "logicalContext": {
      "tenantId": "acme",
      "organizationUnitId": "nl-ops",
      "brandId": "brand-a"
    },
    "logicalConnectionBindingId": "brand-a-hr-profile",
    "physicalConnectorInstanceId": "8a7f09af-7ac9-4d96-91f9-a2a252f4aa4b"
  }
}

Response

Connector invocation binding created.

invocationBindingIdstring required

Stable identifier of the domain invocation binding that caused a connector call.

Product, protocol, form, portal, workflow, or application surface that owns a connector invocation binding.

ownerReferencestring required

Owner-specific reference such as issuer configuration id, verifier profile id, form id, portal flow id, or workflow id.

Product or protocol lifecycle stage at which a connector invocation can run.

Role the connector performs for a lifecycle invocation.

Explicit exchange quadrant. Data direction and initiation side remain separate axes in run responses.

dataDirection'INBOUND' | 'OUTBOUND' | 'BIDIRECTIONAL'

Direction of data movement relative to the platform operating the connector.

initiationSide'PLATFORM' | 'EXTERNAL' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC'

Side that initiated the exchange.

logicalConnectionBindingIdstring

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

physicalConnectorInstanceIdstring uuid

Stable platform identifier for a configured connector instance.

vaultProfile'ISSUANCE_PROOF' | 'CANONICAL_SUBJECT_DATA' | 'RECEIVED_CUSTOMER_DATA'

Vault retention profile requested by a connector invocation result.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example response

{
  "invocationBindingId": "issuer-config-1:credential-request:hr-profile",
  "ownerSurface": "OID4VCI",
  "ownerReference": "issuer-config-1",
  "stage": "OID4VCI_CREDENTIAL_REQUEST",
  "role": "ENRICHMENT_SOURCE",
  "target": {
    "routeId": "1e8ff011-2274-4f16-a7dd-bf0b4fd5262f"
  },
  "exchangeMode": "PLATFORM_INITIATED_PULL",
  "dataDirection": "INBOUND",
  "initiationSide": "PLATFORM",
  "logicalContext": {
    "tenantId": "acme",
    "organizationUnitId": "nl-ops",
    "brandId": "brand-a"
  },
  "logicalConnectionBindingId": "brand-a-hr-profile",
  "physicalConnectorInstanceId": "8a7f09af-7ac9-4d96-91f9-a2a252f4aa4b"
}

Changes

Jul 17, 202660cb8c70871b Revision changes
- breaking
  removed the enum value EXTERNALLY_INITIATED_READ_FROM_VDX of the request property /
- breaking
  removed the enum value EXTERNALLY_INITIATED_WRITE_INTO_VDX of the request property /
- breaking
  removed the enum value INTO_VDX of the request property /
- breaking
  removed the enum value OUT_OF_VDX of 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 ///
- breaking
  added the pattern ^sha256:[0-9a-f]{64}$ to the request property ///
- warning
  added the new EXTERNALLY_INITIATED_READ enum value to the response property for the response status
- warning
  added the new EXTERNALLY_INITIATED_WRITE enum value to the response property for the response status
- warning
  added the new INBOUND enum value to the response property for the response status
- warning
  added the new OUTBOUND enum value to the response property for the response status
- info
  added the new optional request property /
- info
  added the new EXTERNALLY_INITIATED_READ enum value to the request property /
- info
  added the new EXTERNALLY_INITIATED_WRITE enum value to the request property /
- info
  added the new INBOUND enum value to the request property /
- info
  added the new OUTBOUND enum value to the request property /
- info
  added the optional property to the response with the status
- info
  removed the EXTERNALLY_INITIATED_READ_FROM_VDX enum value from the response property for the response status
- info
  removed the EXTERNALLY_INITIATED_WRITE_INTO_VDX enum value from the response property for the response status
- info
  removed the INTO_VDX enum value from the response property for the response status
- info
  removed the OUT_OF_VDX enum value from the response property for the response status
- info
  the // response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status
- info
  the // response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status
- info
  the // response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status
- info
  the // response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status

Operation history