--- title: "Create a connector invocation binding" method: POST path: "/invocation/bindings" tags: ["ConnectorInvocationBindings"] --- # Create a connector invocation binding `POST /invocation/bindings` 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. ## Request body - ConnectorInvocationBindingCreateRequest — Request to persist a connector invocation binding. - `binding` ConnectorInvocationBinding, required — Persisted binding from an owning product/protocol lifecycle stage to a connector target, logical context, governance envelope, and execution policy. - `invocationBindingId` string, 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. - `ownerReference` string, 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. - `target` ConnectorInvocationTarget, required — Registry target selected by an invocation binding. - `routeId` string, uuid — Stable identifier for a connector route. - `connectorId` string, uuid — Stable platform identifier for a configured connector instance. - `operationBindingId` string, uuid — Stable identifier for a connector operation binding. - `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. - `subsetMapping` ConnectorSubsetMapping — Field selection, lookup, output mapping, provenance, and minimization rules used by an invocation or exposure. - `inputFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `selectedFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `producedFields` ConnectorFieldSelector[] — Fields an invocation is expected to produce for later connector or protocol stages. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `outputMappings` ConnectorFieldMapping[] - `source` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `target` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `required` boolean - `sourceProvenanceFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `qualityStatusFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `redactionProfileId` string - `minimizationProfileId` string - `logicalContext` ConnectorLogicalContext, required — Tenant, OU, brand, legal entity, channel, product, and discriminator context used to resolve a logical connector binding. - `tenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `organizationUnitId` string - `brandId` string - `legalEntityId` string - `channel` string - `productId` string - `discriminators` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `logicalConnectionBindingId` string — Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance. - `physicalConnectorInstanceId` string, uuid — Stable platform identifier for a configured connector instance. - `executionPolicy` ConnectorInvocationExecutionPolicy — Timing, retry, idempotency, and correlation policy for an invocation binding. - `timing` 'INLINE_REQUIRED' | 'INLINE_OPTIONAL' | 'DEFERRED_ASYNC' | 'DURABLE_OUTBOX' — Timing contract for connector invocation execution. - `failureEffect` 'FAIL_PROTOCOL' | 'CONTINUE_WITHOUT_EFFECT' | 'DEAD_LETTER' | 'QUARANTINE' | 'RETRY_ONLY' — How connector invocation failure affects the owning protocol, form, portal, or workflow. - `timeoutMillis` integer - `syncWaitWindowMillis` integer - `retryPolicy` RetryPolicy — Retry and dead-letter behavior for connector operations. - `maxAttempts` integer — Maximum number of attempts, including the initial attempt. Zero means no retry after the initial failure. - `backoffMillis` integer — Delay between attempts in milliseconds. Runtime implementations may apply jitter. - `deadLetterEnabled` boolean — Whether failed items should be written to the route dead-letter store when retries are exhausted. - `idempotencyKey` string - `correlationId` string - `governance` ConnectorGovernanceEnvelope — Governance metadata attached to connector records, invocations, and runs before data crosses a protocol, form, vault, dataspace, or external-exchange boundary. - `classification` string - `sensitivity` string - `specialCategory` boolean - `legalBasis` string - `purpose` string - `b2bUsagePurpose` string — B2B or dataspace usage purpose, separate from privacy legal basis and processing purpose. - `frameworkAgreementRef` string - `contractReference` string - `minimizationStatus` 'NOT_EVALUATED' | 'MINIMIZED' | 'REDACTED' | 'FULL_DATASET' | 'EXCESSIVE' - `retentionProfileId` string - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `crossBorderRestriction` 'NONE' | 'SAME_COUNTRY' | 'EEA_ONLY' | 'APPROVED_COUNTRIES' | 'CONTRACT_REQUIRED' | 'BLOCKED' - `encryptionRequirement` 'NONE' | 'IN_TRANSIT' | 'AT_REST' | 'AT_REST_AND_IN_TRANSIT' | 'CUSTOMER_MANAGED_KEY' - `dpiaRequired` boolean - `integrity` ConnectorIntegrityReference — Integrity and evidence references carried with governed connector ingress, egress, and run lineage. - `originalPayloadHash` string - `canonicalPayloadHash` string - `transformationHash` string - `evidenceRef` string - `vaultRef` string - `signatureRef` string - `sealRef` string - `timestampRef` string - `sourceAuthenticityVerdict` string - `outputManifestHash` string - `policyDecisionId` string - `relianceVerdict` 'NOT_EVALUATED' | 'RELIABLE' | 'CONDITIONAL' | 'NOT_RELIABLE' - `auditCategory` 'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG' - `vaultProfile` 'ISSUANCE_PROOF' | 'CANONICAL_SUBJECT_DATA' | 'RECEIVED_CUSTOMER_DATA' — Vault retention profile requested by a connector invocation result. - `partyAnchors` ConnectorPartyAnchorSet — Party, relationship, and projection candidates attached to connector invocation/run lineage. - `anchors` ConnectorPartyAnchor[] - `role` string - `party` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `relationships` object[] - `relationshipCandidates` object[] - `projectionCandidates` object[] - `materializationPolicy` MaterializationPolicy — Policy for retaining, caching, indexing, or mirroring data touched by connector routes. - `mode` 'NONE' | 'CACHE' | 'PERSIST' | 'MIRROR' | 'INDEX' — How, if at all, connector data may be retained or projected into platform storage. - `ttlSeconds` integer — Time to live for materialized data in seconds. - `storageResourceDescriptorId` string, uuid — Stable identifier for a described external or internal resource shape. - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. ## Response `201` Connector invocation binding created. - ConnectorInvocationBinding — Persisted binding from an owning product/protocol lifecycle stage to a connector target, logical context, governance envelope, and execution policy. - `invocationBindingId` string, 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. - `ownerReference` string, 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. - `target` ConnectorInvocationTarget, required — Registry target selected by an invocation binding. - `routeId` string, uuid — Stable identifier for a connector route. - `connectorId` string, uuid — Stable platform identifier for a configured connector instance. - `operationBindingId` string, uuid — Stable identifier for a connector operation binding. - `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. - `subsetMapping` ConnectorSubsetMapping — Field selection, lookup, output mapping, provenance, and minimization rules used by an invocation or exposure. - `inputFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `selectedFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `producedFields` ConnectorFieldSelector[] — Fields an invocation is expected to produce for later connector or protocol stages. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `outputMappings` ConnectorFieldMapping[] - `source` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `target` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `required` boolean - `sourceProvenanceFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `qualityStatusFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `redactionProfileId` string - `minimizationProfileId` string - `logicalContext` ConnectorLogicalContext, required — Tenant, OU, brand, legal entity, channel, product, and discriminator context used to resolve a logical connector binding. - `tenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `organizationUnitId` string - `brandId` string - `legalEntityId` string - `channel` string - `productId` string - `discriminators` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `logicalConnectionBindingId` string — Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance. - `physicalConnectorInstanceId` string, uuid — Stable platform identifier for a configured connector instance. - `executionPolicy` ConnectorInvocationExecutionPolicy — Timing, retry, idempotency, and correlation policy for an invocation binding. - `timing` 'INLINE_REQUIRED' | 'INLINE_OPTIONAL' | 'DEFERRED_ASYNC' | 'DURABLE_OUTBOX' — Timing contract for connector invocation execution. - `failureEffect` 'FAIL_PROTOCOL' | 'CONTINUE_WITHOUT_EFFECT' | 'DEAD_LETTER' | 'QUARANTINE' | 'RETRY_ONLY' — How connector invocation failure affects the owning protocol, form, portal, or workflow. - `timeoutMillis` integer - `syncWaitWindowMillis` integer - `retryPolicy` RetryPolicy — Retry and dead-letter behavior for connector operations. - `maxAttempts` integer — Maximum number of attempts, including the initial attempt. Zero means no retry after the initial failure. - `backoffMillis` integer — Delay between attempts in milliseconds. Runtime implementations may apply jitter. - `deadLetterEnabled` boolean — Whether failed items should be written to the route dead-letter store when retries are exhausted. - `idempotencyKey` string - `correlationId` string - `governance` ConnectorGovernanceEnvelope — Governance metadata attached to connector records, invocations, and runs before data crosses a protocol, form, vault, dataspace, or external-exchange boundary. - `classification` string - `sensitivity` string - `specialCategory` boolean - `legalBasis` string - `purpose` string - `b2bUsagePurpose` string — B2B or dataspace usage purpose, separate from privacy legal basis and processing purpose. - `frameworkAgreementRef` string - `contractReference` string - `minimizationStatus` 'NOT_EVALUATED' | 'MINIMIZED' | 'REDACTED' | 'FULL_DATASET' | 'EXCESSIVE' - `retentionProfileId` string - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `crossBorderRestriction` 'NONE' | 'SAME_COUNTRY' | 'EEA_ONLY' | 'APPROVED_COUNTRIES' | 'CONTRACT_REQUIRED' | 'BLOCKED' - `encryptionRequirement` 'NONE' | 'IN_TRANSIT' | 'AT_REST' | 'AT_REST_AND_IN_TRANSIT' | 'CUSTOMER_MANAGED_KEY' - `dpiaRequired` boolean - `integrity` ConnectorIntegrityReference — Integrity and evidence references carried with governed connector ingress, egress, and run lineage. - `originalPayloadHash` string - `canonicalPayloadHash` string - `transformationHash` string - `evidenceRef` string - `vaultRef` string - `signatureRef` string - `sealRef` string - `timestampRef` string - `sourceAuthenticityVerdict` string - `outputManifestHash` string - `policyDecisionId` string - `relianceVerdict` 'NOT_EVALUATED' | 'RELIABLE' | 'CONDITIONAL' | 'NOT_RELIABLE' - `auditCategory` 'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG' - `vaultProfile` 'ISSUANCE_PROOF' | 'CANONICAL_SUBJECT_DATA' | 'RECEIVED_CUSTOMER_DATA' — Vault retention profile requested by a connector invocation result. - `partyAnchors` ConnectorPartyAnchorSet — Party, relationship, and projection candidates attached to connector invocation/run lineage. - `anchors` ConnectorPartyAnchor[] - `role` string - `party` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `relationships` object[] - `relationshipCandidates` object[] - `projectionCandidates` object[] - `materializationPolicy` MaterializationPolicy — Policy for retaining, caching, indexing, or mirroring data touched by connector routes. - `mode` 'NONE' | 'CACHE' | 'PERSIST' | 'MIRROR' | 'INDEX' — How, if at all, connector data may be retained or projected into platform storage. - `ttlSeconds` integer — Time to live for materialized data in seconds. - `storageResourceDescriptorId` string, uuid — Stable identifier for a described external or internal resource shape. - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. ## Other responses - `400` — Validation error. - `401` — Authentication is required. --- [API](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api.md) · [All operations](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sphereon-opensource/connector-integration-profile-api/revisions/60cb8c70871b/schema)