Vindicia · Authentication Profile

Vindicia Authentication

Authentication

Vindicia secures its APIs with apiKey, oauth2, and openIdConnect across 3 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the authorizationCode flow(s).

CompanyFintechSubscription BillingRecurring PaymentsPayment RecoverySubscription ManagementPaymentsChurn
Methods: apiKey, oauth2, openIdConnect Schemes: 3 OAuth flows: authorizationCode API key in: header

Security Schemes

MerchantApiKey apiKey
· in: header ()
ConnectOAuth2 oauth2
ConnectOIDC openIdConnect

Source

Authentication Profile

vindicia-authentication.yml Raw ↑ 
generated: '2026-07-21'
method: searched
source: https://docs.vindicia.com/bundle/b_Subscribe_REST_API_Guide/page/topics/Authentication.html
docs:
- https://docs.vindicia.com/bundle/b_Subscribe_REST_API_Guide/page/topics/Authentication.html
- https://docs.vindicia.com/bundle/b_restApiGuide/page/topics/c_apiAuthentication.html
- https://docs.vindicia.com/bundle/b_merchantOnboardingGuide/page/topics/apiKeys_c.html
- https://docs.vindicia.com/bundle/b_ConnectProductDescription/page/topics/oAuth2andOpenIDConnect_c.html
summary:
  types:
  - apiKey
  - oauth2
  - openIdConnect
  api_key_in:
  - header
  oauth2_flows:
  - authorizationCode
notes: >-
  Vindicia's Subscribe and Retain REST APIs authenticate with merchant-issued
  API keys (managed in the Merchant/Partner portal and passed on the request).
  Vindicia Connect (the identity/IDP product) additionally documents OAuth 2.0 +
  OpenID Connect with access tokens, refresh tokens, id tokens, token scopes and
  a userInfo endpoint for external/end-user authentication. Legacy CashBox
  integrations use the SOAP API. Specific header names and token formats were not
  captured verbatim (the Zoomin docs render client-side); the auth model above is
  asserted from the published documentation pages listed under docs[].
schemes:
- name: MerchantApiKey
  type: apiKey
  in: header
  sources:
  - https://docs.vindicia.com/bundle/b_merchantOnboardingGuide/page/topics/apiKeys_c.html
- name: ConnectOAuth2
  type: oauth2
  flow: authorizationCode
  sources:
  - https://docs.vindicia.com/bundle/b_ConnectProductDescription/page/topics/oAuth2_c.html
  - https://docs.vindicia.com/bundle/b_ConnectProductDescription/page/topics/tokenScopes_c.html
- name: ConnectOIDC
  type: openIdConnect
  sources:
  - https://docs.vindicia.com/bundle/b_ConnectProductDescription/page/topics/oAuth2andOpenIDConnect_c.html
  - https://docs.vindicia.com/bundle/b_ConnectProductDescription/page/topics/userInfoEndpoint_c.html