Sign in

v1

latestOpenAPI 3.0.0All rights reserved2026-07-2439128156.3 KB
User

Retrieve User

Retrieves a user by userID.

get/v2/clients/{ClientID}/users/{UserID}

Path parameters

ClientIDstring required

22-character <glossary:ClientID>. Ask TabaPay Support if you need to specify a <glossary:SubClientID>.

UserIDstring required

22-character UserID returned from Create User.

Query parameters

referenceIDstring

Reference ID fallback lookup.

Response

User retrieved.

SCinteger

HTTP Status Code

ECstring

Internal Error Code. This is used to help TabaPay team members trace an error.

EMstring

Short description of the error if an error occurred.

userIDstring

TabaPay user identifier

referenceIDstring

Client-defined reference identifier

type'LLC' | 'LLP' | 'C-Corp' | 'S-Corp' | 'SoleProprietor' | 'Nonprofit' | 'Charitable' | 'NaturalPerson' | 'Other'
emailstring email

Email Address

dateOfBirthstring

Date in YYYYMMDD format

dateOfFormationstring

Date in YYYYMMDD format

businessOwnersobject
kycstring

Lists the status of the verification request

Valid Values:

  • CREATED
  • PENDING
  • COMPLETED
  • FAILED
  • UNKNOWN

Example response

{
  "address": {
    "country": "840"
  },
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  },
  "dateOfBirth": "19990131",
  "dateOfFormation": "19990131"
}