{
  "$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"
    }
  }
}