Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kanastra PIX Keys API

The PIX Keys API from Kanastra — 5 operation(s) for pix keys.

Kanastra PIX Keys API is one of 20 APIs that Kanastra publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include PIX Keys. The published artifact set on APIs.io includes an OpenAPI specification, an AsyncAPI specification, and authentication docs.

This API exposes 7 operations across 5 paths. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: https://banking.kanastra.com.br, https://banking-sandbox.kanastra.com.br.

7 operations 5 paths 0 schemas 1 DELETE2 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://banking.kanastra.com.br
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kanastra PIX Keys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT access token from POST /api/v1/auth/token. Register an ES512 public key via POST /api/v1/auth/jwks, then present a signed client assertion (privatekeyjwt)…

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

PIX Keys 7
GET
/api/v1/pix/{account_uuid}/keys
List keys
pixKeysListKeys 1 param → 200400
GET
/api/v1/pix/{account_uuid}/key/{pix_key}
Read PIX-key
pixKeysReadPixKey 2 params → 200400
DELETE
/api/v1/pix/{account_uuid}/key/{pix_key}
Exclude Key
pixKeysExcludeKey 2 params → 200400422
POST
/api/v1/pix/{account_uuid}/key
Create Document Key
pixKeysCreateDocumentKey 1 param body → 201400
PATCH
/api/v1/pix/{account_uuid}/key/{pix_key_uuid}
Approve Key with OTP Token
pixKeysApproveKeyWithOtpToken 2 params body → 200400
PUT
/api/v1/pix/{account_uuid}/key/{pix_key_uuid}
Deny with OTP Token
pixKeysDenyWithOtpToken 2 params body → 200400
PUT
/api/v1/pix/{account_uuid}/key/{pix_key_uuid}/resend-otp
Resend OTP Token
pixKeysResendOtpToken 2 params body → 202400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kanastra-pix-keys-api-openapi.yml Raw ↑

Other APIs Kanastra publishes across the network.

Kanastra Accounts API
Kanastra Amendment API
Kanastra Authentication API
Kanastra Balance API
Kanastra Bank Account Beneficiary API
Kanastra Bank Slip (Boleto) API
Kanastra CNAB API
Kanastra Commercial Note API
Kanastra Create API
Kanastra File Return API
Kanastra Guarantees API
Kanastra Issuers API