v1

latestOpenAPI 3.0.1Private2026-07-2212926.5 KB
bridge

Revoke TEFCA synthetic patient connections

Run this command to reset a TEFCA synthetic test patient's connections.

<Badge color="green">TEFCA</Badge> This helper endpoint is only available while using test API credentials and is designed for clearing your TEFCA IAS sandbox before running another end-to-end scenario.

<Warning> Authenticate with HTTP Basic auth using your organization public id and private key that are configured for **Test API Mode**. Requests made with live credentials will be rejected. </Warning>

The request body must include an email value for one of the test synthetic patients documented in the TEFCA IAS Developer Guide. All current connections for that synthetic patient are revoked so you can start a fresh flow.

post/bridge/vault_connection/revoke

Request body

emailstring email required

Email address for one of the synthetic TEFCA IAS test patients listed in the TEFCA IAS Developer Guide.

Example request

{
  "email": "dogbeaker@aol.com"
}

Response

Revoke operation completed.

successboolean

Example response

{
  "success": true,
  "data": {
    "request_id": "f5d19ee8-6d53-4d17-b7f8-368d1fa41506",
    "revoked": [
      "vault_conn_12345"
    ]
  }
}