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

AZA Finance Documents API

The Documents API from AZA Finance — 2 operation(s) for documents.

AZA Finance Documents API is one of 16 APIs that AZA Finance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.2, at version 1.0.

Requests are made against 2 base URLs: https://api-sandbox.transferzero.com/v1, https://api.transferzero.com/v1.

3 operations 2 paths 7 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0
Base URL
https://api.transferzero.com/v1
Authentication
API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

AZA Finance Documents API declares 4 security schemes for authenticating requests. An API key is passed in the header as Authorization-Key (AuthorizationKey). An API key is passed in the header as Authorization-Secret (AuthorizationSecret). An API key is passed in the header as Authorization-Nonce (AuthorizationNonce). An API key is passed in the header as Authorization-Signature (AuthorizationSignature). By default, every request must be authenticated.

  • AuthorizationKey — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields
  • AuthorizationSecret — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields
  • AuthorizationNonce — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields
  • AuthorizationSignature — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields

Paths & Operations 3

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

Documents 3
GET
/documents
Getting a list of documents
get-documents 2 params → 200401500
POST
/documents
Creating a document
post-documents body → 201401422500
GET
/documents/{Document ID}
Fetching a document
get-document 1 param → 200401404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Document (15 properties), Pagination (5 properties), DocumentListResponse (2 properties), DocumentRequest (1 property). Each schema is shown below with its type and property counts.

Document
object
15 properties 2 required
DocumentResponse
object
1 property
PaginationMeta
object
1 property
ValidationErrorDescription
object
The description of the error
1 property
DocumentRequest
object
1 property
Pagination
object
5 properties
DocumentListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aza-finance-documents-api-openapi.yml Raw ↑

Other APIs AZA Finance publishes across the network.

AZA Finance Account Debits API
AZA Finance Account Validation API
AZA Finance Accounts API
AZA Finance API Logs API
AZA Finance Currency Info API
AZA Finance dlocal balance API
AZA Finance Logs API
AZA Finance Mandates API
AZA Finance Payin Methods API
AZA Finance Payment Methods API
AZA Finance Payout Methods API
AZA Finance Recipients API