openapi: 3.2.0
info:
title: Atlar API (v2) OAuth API
description: Atlar API (v2)
version: '0.1'
contact:
email: support@atlar.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.txt
servers:
- url: https://api.atlar.com
tags:
- name: OAuth
description: OAuth 2.0 endpoints.
x-displayName: OAuth
paths:
/iam/v2/oauth2/token:
post:
summary: Create OAuth 2.0 access token
description: 'This endpoint is an OAuth 2.0 token endpoint and can be used by a client to obtain an access token.
Use programmatic access user credentials as OAuth 2.0 client credentials.
Use the access key as client identifier (`client_id`).
Use the secret as client password (`client_secret`).
This endpoint supports authentication using HTTP Basic auth.
Supported grant types:
client_credentials for programmatic access users.
authorization_code (with PKCE) and
refresh_token for MCP CIMD clients.'
security:
- basicAuth: []
tags:
- OAuth
requestBody:
description: OAuth 2.0 request parameters.
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
grant_type:
type: string
enum:
- client_credentials
- authorization_code
- refresh_token
client_id:
type: string
client_secret:
type: string
code:
description: Authorization code returned by the authorization endpoint. Required for `grant_type=authorization_code`.
type: string
code_verifier:
description: PKCE code verifier matching the `code_challenge` sent at the authorization endpoint. Required for `grant_type=authorization_code`.
type: string
refresh_token:
description: Refresh token previously issued by this endpoint. Required for `grant_type=refresh_token`.
type: string
required:
- grant_type
responses:
'200':
description: Successful OAuth 2.0 access token response.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2AccessTokenResponse'
'400':
description: Invalid access token request.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2ErrorResponse'
'401':
description: Client authentication failed.
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2ErrorResponse'
operationId: postIamV2Oauth2Token
x-operation-id-source: derived
components:
schemas:
OAuth2ErrorResponse:
description: OAuth 2.0 error response.
externalDocs:
url: https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
type: object
properties:
error:
description: OAuth 2.0 error code. See a RFC 6749 for details.
type: string
enum:
- invalid_request
- invalid_client
- invalid_grant
- unauthorized_client
- unsupported_grant_type
error_description:
description: Human readable description of the error.
type: string
example: unsupported grant type
required:
- error
additionalProperties: false
OAuth2AccessTokenResponse:
description: Successful OAuth 2.0 access token response.
externalDocs:
url: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.3
type: object
properties:
access_token:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.Xi9Rplok2DNmNGBPC1CMxUY-ZBkzY-g-sxqzKkWjViU
token_type:
type: string
example: Bearer
expires_in:
description: The lifetime in seconds of the access token.
type: integer
format: int64
example: 299
refresh_token:
description: 'Opaque OAuth 2.0 refresh token
that the client can use to obtain a new access token. Only present when the authorization server
issued one for the grant.
'
type: string
required:
- access_token
- token_type
additionalProperties: false
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Atlar Accounting API
tags:
- Documents
- GL Entities
- GL Accounts
- name: Atlar Analytics API
tags:
- Forecasted Transactions
- name: Atlar Connectivity API
tags:
- Connections
- name: Atlar Payments API
tags:
- Credit Transfers
- Direct Debits
- External Accounts
- Counterparties
- Mandates
- Events (webhooks)
- Regulatory Reporting
- name: Atlar Financial Data API
tags:
- Accounts
- Transactions
- Pending Transactions
- Entities
- Investments
- name: Atlar IAM API
tags:
- OAuth
- Audit logs
- name: Atlar Platform API
tags:
- Webhooks
x-provenance:
method: searched
source: https://docs.atlar.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.atlar.com/reference/delete_accounting-v2beta-documents-id.md
- https://docs.atlar.com/reference/delete_analytics-v2beta-forecasted-transactions-id.md
- https://docs.atlar.com/reference/delete_financial-data-v2-entities-id-1.md
- https://docs.atlar.com/reference/delete_payments-v2-counterparties-id-1.md
- https://docs.atlar.com/reference/delete_payments-v2-external-accounts-id-1.md
- https://docs.atlar.com/reference/delete_platform-v2beta-webhooks-id-keys-kid.md
- https://docs.atlar.com/reference/delete_platform-v2beta-webhooks-id.md
- https://docs.atlar.com/reference/get_accounting-v2beta-documents-batch.md
- https://docs.atlar.com/reference/get_accounting-v2beta-documents-id.md
- https://docs.atlar.com/reference/get_accounting-v2beta-documents.md
- https://docs.atlar.com/reference/get_accounting-v2beta-gl-accounts-id.md
- https://docs.atlar.com/reference/get_accounting-v2beta-gl-accounts.md
- https://docs.atlar.com/reference/get_accounting-v2beta-gl-entities-id.md
- https://docs.atlar.com/reference/get_accounting-v2beta-gl-entities.md
- https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions-id-events.md
- https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions-id.md
- https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions.md
- https://docs.atlar.com/reference/get_connectivity-v2beta-connections-1.md
- https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-1.md
- https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-id-bank-statements-1.md
- https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-id-content-1.md
- https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-rid-bank-statements-id-content-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-accounts-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-accounts-id-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-accounts-id-balances-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-entities-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-entities-id-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-id-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-id-events-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-transactions-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-transactions-id-1.md
- https://docs.atlar.com/reference/get_financial-data-v2-transactions-id-events.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-accounts-id-end-of-day-summaries.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-internal-transfers-id.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-internal-transfers.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-id-holdings.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-id.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-activities-id.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-activities.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-positions-id.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-positions.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-id.md
- https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios.md
- https://docs.atlar.com/reference/get_iam-v2beta-audit-log-entries.md
- https://docs.atlar.com/reference/get_payments-v2-counterparties-1.md
- https://docs.atlar.com/reference/get_payments-v2-counterparties-id-1.md
- https://docs.atlar.com/reference/get_payments-v2-counterparties-id-events-1.md
- https://docs.atlar.com/reference/get_payments-v2-credit-transfers-1.md
- https://docs.atlar.com/reference/get_payments-v2-credit-transfers-id-1.md
- https://docs.atlar.com/reference/get_payments-v2-credit-transfers-id-events-1.md
- https://docs.atlar.com/reference/get_payments-v2-direct-debits-1.md
- https://docs.atlar.com/reference/get_payments-v2-direct-debits-id-1.md
- https://docs.atlar.com/reference/get_payments-v2-direct-debits-id-events-1.md
- https://docs.atlar.com/reference/get_payments-v2-external-accounts-1.md
- https://docs.atlar.com/reference/get_payments-v2-external-accounts-id-1.md
- https://docs.atlar.com/reference/get_payments-v2-mandates-1.md
- https://docs.atlar.com/reference/get_payments-v2-mandates-id-1.md
- https://docs.atlar.com/reference/get_payments-v2-mandates-id-events-1.md
- https://docs.atlar.com/reference/get_payments-v2-regulatory-reporting-codes.md
- https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-1.md
- https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-id-1.md
- https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-id-results-1.md
- https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches-id-results.md
- https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches-id.md
- https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches.md
- https://docs.atlar.com/reference/get_platform-v2beta-webhooks-id-keys.md
- https://docs.atlar.com/reference/get_platform-v2beta-webhooks-id.md
- https://docs.atlar.com/reference/get_platform-v2beta-webhooks.md
- https://docs.atlar.com/reference/patch_accounting-v2beta-documents-id.md
- https://docs.atlar.com/reference/patch_accounting-v2beta-gl-accounts-id.md
- https://docs.atlar.com/reference/patch_accounting-v2beta-gl-entities-id.md
- https://docs.atlar.com/reference/patch_analytics-v2beta-forecasted-transactions-id.md
- https://docs.atlar.com/reference/patch_financial-data-v2-accounts-id-1.md
- https://docs.atlar.com/reference/patch_financial-data-v2-entities-id-1.md
- https://docs.atlar.com/reference/patch_financial-data-v2-transactions-id-1.md
- https://docs.atlar.com/reference/patch_financial-data-v2beta-pending-transactions-id.md
- https://docs.atlar.com/reference/patch_payments-v2-counterparties-id-1.md
- https://docs.atlar.com/reference/patch_payments-v2-credit-transfers-id-1.md
- https://docs.atlar.com/reference/patch_payments-v2-external-accounts-id-1.md
- https://docs.atlar.com/reference/patch_platform-v2beta-webhooks-id.md
- https://docs.atlar.com/reference/post_accounting-v2beta-documents.md
- https://docs.atlar.com/reference/post_accounting-v2beta-gl-accounts.md
- https://docs.atlar.com/reference/post_accounting-v2beta-gl-entities.md
- https://docs.atlar.com/reference/post_analytics-v2beta-forecasted-transactions.md
- https://docs.atlar.com/reference/post_connectivity-v2beta-connections-cid-reports.md
- https://docs.atlar.com/reference/post_financial-data-v2-entities-1.md
- https://docs.atlar.com/reference/post_iam-v2-oauth2-token.md
- https://docs.atlar.com/reference/post_payments-v2-counterparties-1.md
- https://docs.atlar.com/reference/post_payments-v2-credit-transfers-1.md
- https://docs.atlar.com/reference/post_payments-v2-credit-transfers-id-approve-1.md
- https://docs.atlar.com/reference/post_payments-v2-credit-transfers-id-reject-1.md
- https://docs.atlar.com/reference/post_payments-v2-direct-debits-1.md
- https://docs.atlar.com/reference/post_payments-v2-direct-debits-id-approve-1.md
- https://docs.atlar.com/reference/post_payments-v2-direct-debits-id-reject-1.md
- https://docs.atlar.com/reference/post_payments-v2-external-accounts-1.md
- https://docs.atlar.com/reference/post_payments-v2-mandates-1.md
- https://docs.atlar.com/reference/post_payments-v2-mandates-id-cancel-1.md
- https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-1.md
- https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-id-approve.md
- https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-id-reject.md
- https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches-id-approve.md
- https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches-id-reject.md
- https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches.md
- https://docs.atlar.com/reference/post_platform-v2beta-webhooks-id-keys.md
- https://docs.atlar.com/reference/post_platform-v2beta-webhooks.md
merge:
pages: 106
deduped: 3049
conflicts_kept_first: 0