OFX · Schema

GetV1BusinessUsersUseridResponse

CompanyPaymentsMoney TransferFintechBanking

Properties

Name Type Description
id string The user ID
firstName string The user's first name
middleName string The user's middle name
lastName string The user's last name
experianAddress string The experian generated address for the user
addressStructured object The user's structured address details
address string The user's full address
city string The user's city
postCode string The user's post code
state string The user's state or region
email string The user's email
gender string The user's gender
countryCode string The 2 letter country code for the user
countryAreaCode string The area code of the country e.g. (+61)
dateOfBirth string The user's date of birth. Format('dd/MM/yyyy')
mobile string The user's mobile number
F1APIEntityID string The entity ID of the user inside FrankieOne when added via API
screeningStatus string The screening status of the user as decided by FrankieOne
verifyIdentity string The identity verification status of the user as decided by FrankieOne
onfidoApplicantId string The Onfido applicant ID of the user
avatar string The user's profile picture
referral string How the user found Paytron
referralCode string A referral code the user was given upon signing up
fromCurrency string Primary transfer from currency
toCurrency string Primary transfer to currency
transferRange string Expected yearly transfer amount in local currency
createdAt string ISO 8601 UTC datetime
updatedAt string ISO 8601 UTC datetime
updatedBy string UUID of the last updating user
notificationSettings object Notification settings for the user
roleName string The role name of the user in the company
supportRole string If the user has a support/admin role. This is typically a Paytron customer support user.
permissions object Company permissions
authorities array User company authority permissions
userSource string The authorization type of user.
marketingAgreement boolean Whether the user grants consent for marketing emails
marketingAgreementAt string When the user provided marketing consent, stored in ISO format
cid integer Marketing campaign id
ofxUserAgreement boolean The user must consent to OFX's user agreement policies
ofxUserAgreementAt string When the user provided OFX agreement consent, stored in ISO format
serviceMessagesAgreement boolean The user must consent to two-step verification messages and other important service messages
serviceMessagesAgreementAt string The time that the user consented to two-step verification messages and other important service messages
advisorConsoleAgreement boolean Has the user consented to the OFX advisor console agreement
advisorConsoleAgreementAt string When the user provided OFX advisor console agreement consent, stored in ISO format
externalId string User's id in an external system
externalUserName string User's username in an external system
deviceConnected boolean Whether the user has a connected device
View JSON Schema on GitHub

JSON Schema

ofx-get-v1-business-users-userid-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ofx/main/json-schema/ofx-get-v1-business-users-userid-response-schema.json",
  "title": "GetV1BusinessUsersUseridResponse",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/ofx-openapi-generated.yml#/components/schemas/GetV1BusinessUsersUseridResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The user ID"
    },
    "firstName": {
      "type": "string",
      "description": "The user's first name"
    },
    "middleName": {
      "type": "string",
      "description": "The user's middle name"
    },
    "lastName": {
      "type": "string",
      "description": "The user's last name"
    },
    "experianAddress": {
      "type": "string",
      "description": "The experian generated address for the user"
    },
    "addressStructured": {
      "type": "object",
      "description": "The user's structured address details"
    },
    "address": {
      "type": "string",
      "description": "The user's full address"
    },
    "city": {
      "type": "string",
      "description": "The user's city"
    },
    "postCode": {
      "type": "string",
      "description": "The user's post code"
    },
    "state": {
      "type": "string",
      "description": "The user's state or region"
    },
    "email": {
      "type": "string",
      "description": "The user's email"
    },
    "gender": {
      "type": "string",
      "description": "The user's gender"
    },
    "countryCode": {
      "type": "string",
      "description": "The 2 letter country code for the user"
    },
    "countryAreaCode": {
      "type": "string",
      "description": "The area code of the country e.g. (+61)"
    },
    "dateOfBirth": {
      "type": "string",
      "description": "The user's date of birth. Format('dd/MM/yyyy')"
    },
    "mobile": {
      "type": "string",
      "description": "The user's mobile number"
    },
    "F1APIEntityID": {
      "type": "string",
      "description": "The entity ID of the user inside FrankieOne when added via API"
    },
    "screeningStatus": {
      "type": "string",
      "description": "The screening status of the user as decided by FrankieOne"
    },
    "verifyIdentity": {
      "type": "string",
      "description": "The identity verification status of the user as decided by FrankieOne"
    },
    "onfidoApplicantId": {
      "type": "string",
      "description": "The Onfido applicant ID of the user"
    },
    "avatar": {
      "type": "string",
      "description": "The user's profile picture"
    },
    "referral": {
      "type": "string",
      "description": "How the user found Paytron"
    },
    "referralCode": {
      "type": "string",
      "description": "A referral code the user was given upon signing up"
    },
    "fromCurrency": {
      "type": "string",
      "description": "Primary transfer from currency"
    },
    "toCurrency": {
      "type": "string",
      "description": "Primary transfer to currency"
    },
    "transferRange": {
      "type": "string",
      "description": "Expected yearly transfer amount in local currency"
    },
    "createdAt": {
      "type": "string",
      "description": "ISO 8601 UTC datetime"
    },
    "updatedAt": {
      "type": "string",
      "description": "ISO 8601 UTC datetime"
    },
    "updatedBy": {
      "type": "string",
      "description": "UUID of the last updating user"
    },
    "notificationSettings": {
      "type": "object",
      "description": "Notification settings for the user"
    },
    "roleName": {
      "type": "string",
      "description": "The role name of the user in the company"
    },
    "supportRole": {
      "type": "string",
      "description": "If the user has a support/admin role. This is typically a Paytron customer support user."
    },
    "permissions": {
      "type": "object",
      "description": "Company permissions"
    },
    "authorities": {
      "type": "array",
      "description": "User company authority permissions"
    },
    "userSource": {
      "type": "string",
      "description": "The authorization type of user."
    },
    "marketingAgreement": {
      "type": "boolean",
      "description": "Whether the user grants consent for marketing emails"
    },
    "marketingAgreementAt": {
      "type": "string",
      "description": "When the user provided marketing consent, stored in ISO format"
    },
    "cid": {
      "type": "integer",
      "description": "Marketing campaign id"
    },
    "ofxUserAgreement": {
      "type": "boolean",
      "description": "The user must consent to OFX's user agreement policies"
    },
    "ofxUserAgreementAt": {
      "type": "string",
      "description": "When the user provided OFX agreement consent, stored in ISO format"
    },
    "serviceMessagesAgreement": {
      "type": "boolean",
      "description": "The user must consent to two-step verification messages and other important service messages"
    },
    "serviceMessagesAgreementAt": {
      "type": "string",
      "description": "The time that the user consented to two-step verification messages and other important service messages"
    },
    "advisorConsoleAgreement": {
      "type": "boolean",
      "description": "Has the user consented to the OFX advisor console agreement"
    },
    "advisorConsoleAgreementAt": {
      "type": "string",
      "description": "When the user provided OFX advisor console agreement consent, stored in ISO format"
    },
    "externalId": {
      "type": "string",
      "description": "User's id in an external system"
    },
    "externalUserName": {
      "type": "string",
      "description": "User's username in an external system"
    },
    "deviceConnected": {
      "type": "boolean",
      "description": "Whether the user has a connected device"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/ofx-get-v1-business-users-userid-response"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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