BridgeSessionsV1

Create a bridge session.

Changed on

Creates a short lived bridge session for a customer. The session carries the client secret the Bridge widget needs to start, and the redirect url the customer returns to once the widget is done. Send an Idempotency-Key header to make retries safe.

post/v1/bridge/sessions

Request

  • Base URL
    https://sandbox.straddle.com
  • URL
    https://sandbox.straddle.com/v1/bridge/sessions
  • Auth
    HTTP bearer

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Idempotency-Keystring

Optional client generated value to use for idempotent requests.

Request body

customer_idstring uuid required

The unique identifier of the customer the session is created for.

redirect_urlstring required

Absolute https url the customer is returned to when the bridge flow finishes. Carried through to the session as given.

Response

Created

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Changes