Vezgo API

openapi: 3.1.0
info:
  title: Vezgo API
  version: '2026-10-19'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-19: 21 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Vezgo has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 19
    pages-with-code: 2
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-19'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://vezgo.com/docs/core-api/accounts
  - https://vezgo.com/docs/core-api/providers
  - https://vezgo.com/docs/core-api/transactions
  - https://vezgo.com/docs/direct-api-integration
  - https://vezgo.com/docs/vezgo-api-specs.yml
  - https://vezgo.com/docs/get-started
servers:
- url: https://api.vezgo.com
paths:
  /accounts:
    get:
      operationId: get_accounts
      tags:
      - Accounts
      summary: All the user's accounts.
      x-source: https://vezgo.com/docs/core-api/accounts
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_accounts
      tags:
      - Accounts
      summary: Connect new account
      description: POST /accounts with the credentials. If everything is valid, Vezgo returns 202 Accepted with the account object and starts
        an interactive sync.
      x-source: https://vezgo.com/docs/direct-api-integration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAccountsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAccountsResponse'
      x-evidence:
        kind: documentation
  /accounts/{id}:
    put:
      operationId: put_accounts_id
      tags:
      - Accounts
      summary: Update account credentials or answer security question
      description: Update the credentials by calling PUT /accounts/:id with the new credentials or send a security answer.
      x-source: https://vezgo.com/docs/direct-api-integration
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutAccountsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutAccountsIdResponse'
      x-evidence:
        kind: documentation
  /accounts/{id}/poll:
    get:
      operationId: get_accounts_id_poll
      tags:
      - Accounts
      summary: Poll for an account update
      description: GET /accounts/:id/poll?v={account.v} to poll for an update and act according to account.status.
      x-source: https://vezgo.com/docs/direct-api-integration
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: v
        in: query
        required: true
        schema:
          type: integer
        description: Version counter from the last account object
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountsIdPollResponse'
      x-evidence:
        kind: documentation
  /accounts/{accountId}:
    delete:
      operationId: delete_accounts_accountId
      tags:
      - Accounts
      summary: Deletes the account.
      x-source: https://vezgo.com/docs/core-api/accounts
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /accounts/{accountId}/history:
    get:
      operationId: get_accounts_accountId_history
      tags:
      - Accounts
      summary: The fiat value of each wallet over time.
      x-source: https://vezgo.com/docs/core-api/accounts
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: Start date in YYYY‑MM‑DD format.
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: End date in YYYY‑MM‑DD format.
      - name: wallet
        in: query
        required: false
        schema:
          type: string
        description: Filter to a specific wallet.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /accounts/{accountId}/kyc-data:
    get:
      operationId: get_accounts_accountId_kyc_data
      tags:
      - Accounts
      summary: The identity data the provider holds.
      x-source: https://vezgo.com/docs/core-api/accounts
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /accounts/{accountId}/transactions/{txId}:
    get:
      operationId: get_accounts_accountId_transactions_txId
      tags:
      - Accounts
      summary: One transaction.
      x-source: https://vezgo.com/docs/core-api/transactions
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      - name: txId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /auth/token:
    post:
      operationId: post_auth_token
      tags:
      - Auth
      summary: Create Users – Send a POST /auth/token request with the loginName in the header to obtain a bearer token.
      x-source: https://vezgo.com/docs/get-started
      parameters:
      - name: loginName
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier for the user (loginName).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthTokenRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAuthTokenResponse'
      x-evidence:
        kind: documentation
  /providers:
    get:
      operationId: get_providers
      tags:
      - Providers
      summary: Providers
      x-source: https://vezgo.com/docs/core-api/providers
      parameters:
      - name: unpublished
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /providers/{name}:
    get:
      operationId: get_providers_name
      tags:
      - Providers
      summary: Providers
      x-source: https://vezgo.com/docs/core-api/providers
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /transactions/{accountId}:
    get:
      operationId: get_transactions_accountId
      tags:
      - Transactions
      summary: Fetch transaction history for a specific account.
      x-source: https://vezgo.com/docs/get-started
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/accounts:
    get:
      operationId: get_v1_accounts
      tags:
      - Accounts
      summary: Get Started | Vezgo Docs
      description: Retrieve a list of all accounts.
      x-source: https://vezgo.com/docs/get-started
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/accounts/613f3f9fe9b200002a0cc768:
    get:
      operationId: get_v1_accounts_613f3f9fe9b200002a0cc768
      tags:
      - Accounts
      summary: GET /v1/accounts/613f3f9fe9b200002a0cc768
      x-source: https://vezgo.com/docs/core-api/accounts
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl https://api.vezgo.com/v1/accounts/613f3f9fe9b200002a0cc768 \\ -H 'Authorization: Bearer YOUR_USER_TOKEN' \n The account\
          \ object ​ \n A Bitcoin address with one wallet: \n { \"id\" : \"613f3f9fe9b200002a0cc768\" , \"resource_type\" : \"account\" , \"provider\"\
          \ : { \"name\" : \"bitcoin\" , \"display_name\" : \"Bitcoin\" , \"auth_type\" : \"wallet\" , \"logo\" : \"https://app.wealthica.com/images/institutions/bitcoin.pn"
  /v1/auth/token:
    post:
      operationId: post_v1_auth_token
      tags:
      - Auth
      summary: Get Started | Vezgo Docs
      description: Create a user token by providing loginName header and client credentials.
      x-source: https://vezgo.com/docs/get-started
      parameters:
      - name: loginName
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier for the user (loginName).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1AuthTokenRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1AuthTokenResponse'
      x-evidence:
        kind: documentation
  /v1/providers:
    get:
      operationId: get_v1_providers
      tags:
      - Providers
      summary: GET /v1/providers
      x-source: https://vezgo.com/docs/core-api/providers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl https://api.vezgo.com/v1/providers \n The provider object ​ \n Coinbase, shortened: \n { \"resource_type\" : \"provider\"\
          \ , \"name\" : \"coinbase\" , \"display_name\" : \"Coinbase\" , \"logo\" : \"https://app.wealthica.com/images/institutions/coinbase.png\"\
          \ , \"logo_svg\" : \"https://app.wealthica.com/images/institutions/svg/coinbase.svg\" , \"categories\" : [ \"exchange\" ] , \"auth_type\"\
          \ : \"oauth\" , \"credentials\""
  /vezgo/auth:
    post:
      operationId: post_vezgo_auth
      tags:
      - Vezgo
      summary: POST /vezgo/auth
      x-source: https://vezgo.com/docs/get-started
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVezgoAuthRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVezgoAuthResponse'
      x-evidence:
        kind: documentation
  /vezgo/callback:
    get:
      operationId: get_vezgo_callback
      tags:
      - Vezgo
      summary: Redirect URI that handles the result of the Vezgo Connect flow.
      x-source: https://vezgo.com/docs/get-started
      parameters:
      - name: account
        in: query
        required: false
        schema:
          type: string
        description: Vezgo account ID.
      - name: code
        in: query
        required: false
        schema:
          type: string
        description: Same as account (OAuth compliance).
      - name: error_type
        in: query
        required: false
        schema:
          type: string
        description: Numeric error code on failure.
      - name: message
        in: query
        required: false
        schema:
          type: string
        description: Human‑readable error message.
      - name: force
        in: query
        required: false
        schema:
          type: string
        description: True if the user explicitly closed the widget.
      - name: state
        in: query
        required: false
        schema:
          type: string
        description: Opaque app state passed through the flow.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /vezgo/connect:
    get:
      operationId: get_vezgo_connect
      tags:
      - Vezgo
      summary: Backend endpoint that renders an auto‑submitting form to start the Vezgo Connect flow.
      x-source: https://vezgo.com/docs/get-started
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /vezgo/webhooks:
    post:
      operationId: post_vezgo_webhooks
      tags:
      - Vezgo
      summary: Endpoint to receive webhook notifications from Vezgo.
      x-source: https://vezgo.com/docs/get-started
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVezgoWebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /wallet-connect/providers:
    get:
      operationId: get_wallet_connect_providers
      tags:
      - Wallet Connect
      summary: Providers
      x-source: https://vezgo.com/docs/core-api/providers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAccountsRequest:
      type: object
      properties:
        credentials:
          type: object
          description: The credentials for the new account
      required:
      - credentials
    PostAccountsResponse:
      type: object
      properties:
        account:
          type: object
          description: The created account object
    PutAccountsIdRequest:
      type: object
      properties:
        credentials:
          type: object
          description: New credentials for the account
        security_answer:
          type: string
          description: Answer to a security question or 2FA code
    PutAccountsIdResponse:
      type: object
      properties:
        account:
          type: object
          description: Account object after update, status will be syncing
    GetAccountsIdPollResponse:
      type: object
      properties:
        account:
          type: object
          description: Updated account object when status changes
    PostAuthTokenRequest:
      type: object
      properties:
        clientId:
          type: string
          description: Your Vezgo client ID.
        secret:
          type: string
          description: Your Vezgo client secret (must be kept server‑side).
      required:
      - clientId
      - secret
    PostAuthTokenResponse:
      type: object
      properties:
        token:
          type: string
          description: Bearer token for the created user.
    PostV1AuthTokenRequest:
      type: object
      properties:
        clientId:
          type: string
          description: Your Vezgo client ID.
        secret:
          type: string
          description: Your Vezgo client secret.
      required:
      - clientId
      - secret
    PostV1AuthTokenResponse:
      type: object
      properties:
        token:
          type: string
          description: Bearer token for the user.
    PostVezgoAuthRequest:
      type: object
      properties:
        clientId:
          type: string
          description: Your Vezgo client ID.
        secret:
          type: string
          description: Your Vezgo client secret.
      required:
      - clientId
      - secret
    PostVezgoAuthResponse:
      type: object
      properties:
        token:
          type: string
          description: User token returned by Vezgo.
    PostVezgoWebhooksRequest:
      type: object
      properties:
        hook:
          type: string
          description: Type of webhook event (e.g., SyncAccount, SyncError).
        user:
          type: object
          description: User information (id, loginName).
        account:
          type: object
          description: Account information (id, provider).
        error:
          type: string
          description: Error name for SyncError events.
      required:
      - hook
      - user
      - account
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Accounts
- name: Auth
- name: Providers
- name: Transactions
- name: Vezgo
- name: Wallet Connect