Salt Edge Connect Sessions API

The Connect Sessions API from Salt Edge — 1 operation(s) for connect sessions.

OpenAPI Specification

salt-edge-connect-sessions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salt Edge Account Information Accounts Connect Sessions API
  description: 'Salt Edge Account Information API (v5) is an open banking aggregation

    service exposing customers, connections (linked bank accounts), accounts,

    transactions, providers (banks), consents, and account holder info. All

    requests require App-id + Secret headers, and live-mode requests also

    require a signed payload via Signature and Expires-at headers.

    '
  version: v5
  contact:
    name: Salt Edge
    url: https://docs.saltedge.com/account_information/v5/
servers:
- url: https://www.saltedge.com/api/v5
  description: Salt Edge production
security:
- appId: []
  secret: []
tags:
- name: Connect Sessions
paths:
  /connect_sessions/create:
    post:
      summary: Create a connect session
      description: Initiate a hosted connection flow for a customer.
      operationId: createConnectSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  properties:
                    customer_id:
                      type: string
                    consent:
                      type: object
                      additionalProperties: true
                    attempt:
                      type: object
                      additionalProperties: true
      responses:
        '200':
          description: Connect URL response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
      tags:
      - Connect Sessions
components:
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: App-id
      description: Salt Edge application identifier.
    secret:
      type: apiKey
      in: header
      name: Secret
      description: Salt Edge application secret key.
    signature:
      type: apiKey
      in: header
      name: Signature
      description: Base64-encoded SHA256 RSA signature (required in live mode).
    expiresAt:
      type: apiKey
      in: header
      name: Expires-at
      description: Unix-timestamp request expiration (required in live mode).