AZLO API API Reference

Introduction

The Azlo API currently allows clients access to select resources that Azlo makes available for account information and basic reporting. These services are intended to be used in conjunction with an Azlo account, or through select partner applications as approved by Azlo. Additional transactional services will be available in future releases. Feedback and suggestions on these services are welcome! If you run into any questions, please contact us at info@azlo.com.

If you already have a Azlo account, you're all set to use the basic APIs. Sample requests and responses are provided here, and some code libraries will be available in the future based on customer demand. Azlo APIs are currently available only in the United States. We are working to make them available in additional countries soon.

Azlo provides a collection of APIs to help you build integrations for a number of basic use cases. Additional use cases will be added soon. Current use cases include:

  • Accounts: Customers can GET the details of their accounts including balance and account/routing numbers

  • Transactions: Customers can GET a list of the transactions for an account with dates, types, and amounts

Azlo API uses the standard HTTP methods in order to handle requests. Communication with all endpoints in Azlo API will be over HTTPS.

HTTP Verb Action
POST Create
GET Read
PUT Update
DELETE Delete

Note : In Azlo we use PUT as a PATCH would be normally used, for partial updates

Requests and responses in this API are formatted in JSON and samples are provided next to the endpoint verbiage. Generic examples are provided below.

A request example:

  {
     "email": "user@email.com",
     "password": "userpassword%",
     "device_fingerprint": "3251e671c56c1726f834f4214eb60699"
  }

A response example:

  {
     "result": {
       "code": 200,
       "info": "User authenticated"
     },
     "access_token": "J1qK1c18UUGJFAzz9xnH56584l4",
     "refresh_token": "NmeiqiJljk42oqi4jllmfnFFdnc",
     "access_type": "ONBOARDING",
     "expiration_time_ms": 852447839
  }

The Azlo API uses common HTTP response codes to indicate successes and failures.

  • 2XX codes will indicate success
  • 4XX will indicate a controlled error, usually bad parameters or trying to do something not allowed for that customer
  • 5XX codes will indicate an unexpected server error
Code Message Description Actions
400 Bad Request Missing paramaters in the request: Fix request parameters
401 Unauthorized Invalid API Key Request new API key or use proper API key
403 Forbidden Forbidden Request resource you have access to
404 Not Found Resource not found Try another resource
500 Internal Server Error Rarely is there a 500 error Contact the support team
503 Service Unavailable Service currently not available Contact the support team
API Endpoint
https://developer-api.azlo.com
Terms of Service: https://www.azlo.com/wp-content/uploads/2017/11/Azlo-Privacy_Policy.pdf
Contact: info@azlo.com
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0

Authentication

customHeader

Authorization with API key using header "Authorization" with token.

type
apiKey
in
header
name
Authorization

Accounts

Methods for accessing account information

GET /v1/accounts

Get a list of the authorized user's accounts

unmask: boolean
in query

Flag to return full account numbers rather than only last 4 digits

Successfully fetched accounts

Response Example (200 OK)
{
  "result": {
    "info": "Successfully fetched accounts"
  },
  "data": [
    {
      "account_id": "ac.123345-45677235",
      "routing_number": 12345678,
      "account_number": "*****2342",
      "account_type": "CHECKING",
      "status": "ACTIVE",
      "alias": "AZLO CHECKING *2342",
      "currency": "USD",
      "balance": {
        "posted_balance": 123.45,
        "current_balance": 234.56
      }
    }
  ]
}

GET /v1/accounts/{account_id}/transactions

Get a list of the authorized user's transactions

account_id: string
in path

The account id for which to pull the transaction list

posted_date_from: string
in query

The start date for filtering by date (required if posted_date_to present)

posted_date_to: string
in query

The end date for filtering by date (required if posted_date_from present)

amount_from: number
in query

The minimum amount for filtering by amount (required if amount_to present)

amount_to: number
in query

The maximum amount for filtering by amount (required if amount_from present)

start: number
in query

The starting point for pagination (default = 0)

limit: number
in query

The page size for pagination (default = 25)

Successfully fetched transactions

Response Example (200 OK)
{
  "result": {
    "info": "Successfully fetched transactions"
  },
  "data": [
    {
      "id": "tx.123456789",
      "posted_date": "2018-01-25",
      "description": "Jimmy's Bistro",
      "purchase_date": "2018-01-23",
      "transaction_type": "VISA DEBIT",
      "amount": 12.34,
      "posted_balance": 123.45,
      "tags": [
        "Tag 1",
        "Tag 2"
      ],
      "currency": "USD"
    }
  ]
}

Contacts

Coming soon! Creating and updating contacts.

Invoices

Coming soon! Creating and sending invoices.

Schema Definitions

AccountInfo: object

account_id: string
routing_number: string
account_number: string
account_type: string
status: string
alias: string
currency: string
balance: object
posted_balance: number
current_balance: number
Example
{
  "account_id": "ac.123345-45677235",
  "routing_number": 12345678,
  "account_number": "*****2342",
  "account_type": "CHECKING",
  "status": "ACTIVE",
  "alias": "AZLO CHECKING *2342",
  "currency": "USD",
  "balance": {
    "posted_balance": 123.45,
    "current_balance": 234.56
  }
}

Transaction: object

id: string
posted_date: string
description: string
purchase_date: string
transaction_type: string
amount: number
posted_balance: number
tags: string[]
string
currency: string
Example
{
  "id": "tx.123456789",
  "posted_date": "2018-01-25",
  "description": "Jimmy's Bistro",
  "purchase_date": "2018-01-23",
  "transaction_type": "VISA DEBIT",
  "amount": 12.34,
  "posted_balance": 123.45,
  "tags": [
    "Tag 1",
    "Tag 2"
  ],
  "currency": "USD"
}

GetAccountsResponse:

result: object
info: string
data: AccountInfo
AccountInfo
Example
{
  "result": {
    "info": "Successfully fetched accounts"
  },
  "data": [
    {
      "account_id": "ac.123345-45677235",
      "routing_number": 12345678,
      "account_number": "*****2342",
      "account_type": "CHECKING",
      "status": "ACTIVE",
      "alias": "AZLO CHECKING *2342",
      "currency": "USD",
      "balance": {
        "posted_balance": 123.45,
        "current_balance": 234.56
      }
    }
  ]
}

GetTransactionsResponse:

result: object
info: string
data: Transaction
Transaction
Example
{
  "result": {
    "info": "Successfully fetched transactions"
  },
  "data": [
    {
      "id": "tx.123456789",
      "posted_date": "2018-01-25",
      "description": "Jimmy's Bistro",
      "purchase_date": "2018-01-23",
      "transaction_type": "VISA DEBIT",
      "amount": 12.34,
      "posted_balance": 123.45,
      "tags": [
        "Tag 1",
        "Tag 2"
      ],
      "currency": "USD"
    }
  ]
}