Skip to content
Logo

Bridge compatibility

Bridge is an independent product. Seismic Orchestration does not use it under the hood. The compat layer mirrors Bridge's API shape so teams already integrated with Bridge can swap base URLs and keep most code unchanged.

For the endpoints we implement, paths, field names, auth header, error envelope, and pagination follow Bridge's conventions. Best-effort, not a contract. For inconsistencies or missing endpoints, let us know.

Base URLs

EnvironmentBase URL
Sandboxhttps://orchestration.seismictest.net/api/compat/bridge/v0
ProductionComing soon.

The trailing /v0 mirrors Bridge's own path versioning.

Authentication

Bridge-style Api-Key header. No Bearer prefix, no refresh dance.

curl https://orchestration.seismic.systems/api/compat/bridge/v0/customers \
  -H "Api-Key: seismic_sandbox_…"

Throughout the Bridge-compat pages we assume two environment variables in the curl snippets:

export BASE_URL="https://orchestration.seismictest.net/api/compat/bridge/v0"
export SEISMIC_ORCHESTRATION_API_KEY="seismic_sandbox_…"

The same SEISMIC_ORCHESTRATION_API_KEY works against the native API: one key, two surfaces.

Missing or invalid keys return 401 in Bridge's exact shape:

{
  "code": "required",
  "location": "header",
  "name": "Api-Key",
  "message": "Missing Api-Key header"
}

Errors

Bridge's envelope isn't uniform across endpoints. We mirror their shape per endpoint. The common cases:

Most 4xx: flat code / message, optional source:

{
  "code": "bad_customer_request",
  "message": "fields missing from customer body.",
  "source": { "location": "body", "key": ["first_name", "ssn"] }
}

Auth errors (401): add location + name:

{
  "code": "invalid",
  "location": "header",
  "name": "Api-Key",
  "message": "Invalid Api-Key header"
}

5xx unexpected: nested under errors[]:

{
  "errors": [
    {
      "code": "unexpected",
      "message": "An unexpected error occurred, you may try again later"
    }
  ]
}

Branch on code when you need programmatic handling. Treat an unknown code at a given status as a generic failure of that HTTP class.

What's implemented

The compat layer covers the endpoints the native API already supports. Every Bridge endpoint not listed here returns 501 not_implemented. See Not implemented for the exhaustive list.

Customers

Associated Persons

KYC Links

External Accounts

Transfers

Exchange Rates

Shared schemas: field definitions reused across endpoints.

No SDK

Bridge doesn't ship an official SDK. The compat layer doesn't either. Use the same HTTP client you use against api.bridge.xyz. New integrations should use the native SeismicOrchestrationClient: quote fan-out, itemized fees, typed error codes, full TypeScript types.

Versioning

  • The v0 in the path is Bridge's version, not ours. We track Bridge's breaking changes on a best-effort basis.
  • Additive Bridge changes (new optional fields, new enum values) flow through. Unknown fields are not stripped.

Feedback

If you run into:

  • A field we accept but handle differently than Bridge
  • An endpoint that returns 501 and you need it
  • An error shape that doesn't match Bridge's

Email support with the request body (redact secrets) and what you expected.