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

TabaPay User API

This resource represents a Client's User.

TabaPay User API is one of 16 APIs that TabaPay 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, and an API reference.

This API exposes 4 operations across 2 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://{FQDN}:{PORT}.

4 operations 2 paths 25 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.tabapay.com
Authentication
HTTP Bearer, API Key
License
All rights reserved
Resource Areas
1

Authentication & Security 2

TabaPay User API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (custom-header). By default, every request must be authenticated.

Paths & Operations 4

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

User 4

This resource represents a Client's User.

POST
/v2/clients/{ClientID}/users
Create User
createuser 1 param body → 200207
DELETE
/v2/clients/{ClientID}/users/{UserID}
Delete User
deleteuser 2 params → 200404
GET
/v2/clients/{ClientID}/users/{UserID}
Retrieve User
retrieveuser 3 params → 200404
PUT
/v2/clients/{ClientID}/users/{UserID}
Update User
updateuser 2 params body → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are retrieveUserResponse (15 properties), userCreate (10 properties), userUpdate (10 properties), address (6 properties). Each schema is shown below with its type and property counts.

businessOwner
object
Additional individuals that own at least 25% of the entity.
4 properties 3 required
tpReferenceID
string
Client-defined reference identifier
address
object
Address
6 properties 4 required
apiResponseSCECEM
object
3 properties
city
string
City
tpDateYYYYMMDD
string
Date in YYYYMMDD format
userNameCompany
object
2 properties 1 required
line1
string
Address Line 1
apiResponseSCEC
object
2 properties
SC
integer
[HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes/)
createUserResponse
object
4 properties
userCreate
object
10 properties 4 required
userName
object
For type NaturalPerson use name.individual; otherwise use name.company.
2 properties
userUpdate
object
Partial update; only supplied fields are updated.
10 properties
userNameIndividual
object
4 properties 2 required
zipcode
string
Zip Code If country is 840, zipcode must be 5 or 9 digits. If country is 124, zipcode must be in the A1A 1A1 format. Zip codes from other countries will not be…
userIdentification
object
2 properties 2 required
EM
string
Short description of the error if an error occurred.
state
string
State Code [State Code](https://developers.tabapay.com/reference/us-state-codes/) must be a valid 2-character code if country is [840](https://developers.tabap…
country
string
[Country Code](https://developers.tabapay.com/reference/country-codes/) Optional. Default is 840
phone
object
Phone object
2 properties 1 required
EC
string
Internal Error Code. This is used to help TabaPay team members trace an error.
tpUserID
string
TabaPay user identifier
line2
string
Address Line 2 Optional
retrieveUserResponse
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabapay-user-api-openapi.yml Raw ↑

Other APIs TabaPay publishes across the network.

TabaPay 3D Secure API
TabaPay Account API
TabaPay Bank API
TabaPay Card API
TabaPay Client API
TabaPay FXRate API
TabaPay Health API
TabaPay Key API
TabaPay Ledger API
TabaPay OFAC API
TabaPay SubClient API
TabaPay Tag API