Sign in

v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
ConnectorInvocationBindings

Create a connector invocation binding

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 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.

ownerSurface'OID4VCI' | 'OID4VP' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'APPLICATION' required

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.

stage'OID4VCI_START' | 'OID4VCI_AUTHORIZATION' | 'OID4VCI_PRE_AUTHORIZED' | 'OID4VCI_TOKEN' | 'OID4VCI_CREDENTIAL_REQUEST' | 'OID4VCI_DEFERRED' | 'OID4VCI_PRE_ISSUE' | 'OID4VCI_POST_ISSUANCE' | 'OID4VCI_NOTIFICATION_RECEIPT' | 'OID4VP_AFTER_VALIDATION' | 'OID4VP_PRE_REQUEST_ENRICHMENT' | 'FORM_LIFECYCLE' | 'FORM_ACTION_START' | 'FORM_ACTION_COMPLETE' | 'FORM_FIELD_LOOKUP' | 'FORM_SUBMIT' | 'PORTAL_FLOW' | 'WORKFLOW_STEP_EXECUTION' required

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

role'ENRICHMENT_SOURCE' | 'EXPORT_DESTINATION' | 'VAULT_RETENTION' | 'NOTIFICATION' | 'BIDIRECTIONAL_SYNC' | 'ROUTE_ORCHESTRATION' required

Role the connector performs for a lifecycle invocation.

exchangeMode'PLATFORM_INITIATED_PULL' | 'PLATFORM_INITIATED_PUSH' | 'EXTERNALLY_INITIATED_READ' | 'EXTERNALLY_INITIATED_WRITE' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC' required

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