How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zai

Zai Users API

The Users API from Zai — 9 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zai Users API is one of 26 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 11 operations across 9 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.3.

Requests are made against 5 base URLs: https://test.api.promisepay.com, https://secure.api.promisepay.com, https://au-0000.sandbox.auth.assemblypay.com, https://au-0000.auth.assemblypay.com, https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.3.

11 operations 9 paths 12 schemas 7 GET3 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.3
Base URL
https://secure.api.promisepay.com
Authentication
OAuth 2.0
Contact
http://docs.assemblypayments.com/
Resource Areas
1

Authentication & Security 1

Zai Users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • oAuth2ClientCredentials — Please refer to Authentication section within https://developer.assemblypayments.com/referenceauthentication

Paths & Operations 11

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

Users 11
GET
/users/{id}/bpay_accounts
List User's BPay Accounts
listUserBPayAccounts 1 param → 200
GET
/users/{id}/card_accounts
Show User Card Account
showUserCardAccount 1 param → 200
GET
/users/{id}
Show User
showUser 1 param → 200
PATCH
/users/{id}
Update User
updateUser 1 param body → 200
PATCH
/users/{id}/identity_verified
Verify User (Prelive Only)
verifyUser 1 param → 200
GET
/users/{id}/bank_accounts
Show User Bank Account
showUserBankAccount 1 param → 200
PATCH
/users/{id}/disbursement_account
Set User Disbursement Account
setUserDisbursementAccount 1 param body → 200
GET
/users
List Users
listUsers 3 params → 200
POST
/users
Create User
createUser body → 201
GET
/users/{id}/items
List User Items
listUserItems 3 params → 200
GET
/users/{id}/wallet_accounts
Show User Wallet Account
showUserWalletAccounts 1 param → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are item (46 properties), user (23 properties), user_requestBody (22 properties), update_user_requestBody (20 properties). Each schema is shown below with its type and property counts.

single_user
object
1 property
bank_account_id_requestBody
object
1 property 1 required
bank_account_au
object
1 property
item
object
46 properties 6 required
user_requestBody
object
22 properties 5 required
users
object
1 property
user
object
23 properties
list_bpay_accounts
object
3 properties
items
object
3 properties
card_account
object
1 property
wallet_account
object
1 property
update_user_requestBody
object
20 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-users-api-openapi.yml Raw ↑

Other APIs Zai publishes across the network.

Zai Addresses API
AE Profile APIs.io
Zai Authentication API
AE Profile APIs.io
Zai Bank Accounts API
AE Profile APIs.io
Zai Batch Transactions API
AE Profile APIs.io
Zai BPay Accounts API
AE Profile APIs.io
Zai Callbacks API
AE Profile APIs.io
Zai Card Accounts API
AE Profile APIs.io
Zai Charges API
AE Profile APIs.io
Zai Companies API
AE Profile APIs.io
Zai Direct Debit Authorities API
AE Profile APIs.io
Zai Disbursements API
AE Profile APIs.io
Zai Fees API
AE Profile APIs.io
#User
← Back to Z APIs
API Details
ID
zai:zai-users-api
Base URL
https://secure.api.promisepay.com
Docs
https://developer.hellozai.com/reference/overview
Provider
Zai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zai-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zai-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zai Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.