generated: '2026-09-26'
method: derived
generator: derive-data-model.py
source:
- openapi/_original/argyle9a25-openapi-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 116
  entities_in_spec: 116
  relationships: 83
entities:
- name: Account
  fields: 12
- name: Address
  fields: 6
- name: AvailabilityItem
  fields: 7
  description: Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads)
    submission.
- name: BankingReport
  fields: 14
  description: Report object.
- name: BankingReportCustomField
  fields: 3
- name: BankingReportRequest
  fields: 7
- name: BasePay
  fields: 3
- name: Broker
  fields: 4
  description: '**Note:** Only for wholesale mortgage integrations.'
- name: ClientEmbeddedSessionCreateRequest
  fields: 3
- name: ClientInviteSession
  fields: 6
- name: ClientInviteSessionConfiguration
  fields: 5
- name: ClientInviteSessionCreateConfiguration
  fields: 5
- name: ClientInviteSessionCreateRequest
  fields: 3
- name: ClientInviteSessionDelivery
  fields: 5
- name: ClientInviteSessionInvite
  fields: 5
- name: ClientReportCustomField
  fields: 3
  description: Custom field returned in report JSON as a pass-through value.
- name: ClientSession
  fields: 4
- name: ClientSessionConfiguration
  fields: 0
- name: ClientSessionCreateConfiguration
  fields: 7
  description: Connection session configuration for payroll and banking verifications.
- name: ClientVerification
  fields: 12
- name: ClientVerificationBilling
  fields: 1
  description: Optional billing details for regular payroll and mortgage verification workflows.
- name: ClientVerificationConfiguration
  fields: 1
- name: ClientVerificationCreateConfiguration
  fields: 1
- name: ClientVerificationCreateReportRequest
  fields: 3
  description: Report request configuration.
- name: ClientVerificationCreateRequest
  fields: 6
  description: Request body for ordering a verification.
- name: ClientVerificationEmployment
  fields: 4
  description: Employment details for the user.
- name: ClientVerificationEmploymentRequest
  fields: 0
- name: ClientVerificationError
  fields: 4
  description: Verification error details.
- name: ClientVerificationErrorResource
  fields: 3
  description: Verification error resource details.
- name: ClientVerificationLoan
  fields: 5
  description: Optional loan details for regular payroll and mortgage verification workflows.
- name: ClientVerificationLoanCreateRequest
  fields: 0
- name: ClientVerificationLoanMetadata
  fields: 4
  description: Optional loan details for regular payroll and mortgage verification workflows.
- name: ClientVerificationRefreshReportRequest
  fields: 2
  description: Report request configuration for refresh requests.
- name: ClientVerificationRefreshRequest
  fields: 4
- name: ClientVerificationReport
  fields: 6
  description: Report information.
- name: ClientVerificationReportConfiguration
  fields: 5
  description: Optional banking report configurations.
- name: ClientVerificationStatus
  fields: 3
  description: Verification status information.
- name: ClientVerificationUpdateRequest
  fields: 3
  description: Request body for updating a verification.
- name: ConsolidatedWebhookEventPayload
  fields: 3
  description: Webhook event payload. Use `event` to determine the event-specific shape of `data`.
- name: ConsolidatedWebhookSubscriptionRequest
  fields: 5
- name: ConsolidatedWebhookSubscriptionResponse
  fields: 9
- name: CreateUserTokenRequest
  fields: 1
- name: CreateUserTokenResponse
  fields: 1
- name: Deduction
  fields: 4
- name: DepositDestination
  fields: 15
- name: Destination
  fields: 5
- name: Employer
  fields: 6
- name: Employment
  fields: 7
- name: FilingStatus
  fields: 3
- name: Gig
  fields: 23
- name: GrossPay
  fields: 9
- name: GrossPayTotal
  fields: 6
- name: Identity
  fields: 28
- name: InviteDelivery
  fields: 5
- name: InviteObject
  fields: 20
- name: Item
  fields: 11
- name: OcrDocument
  fields: 3
  description: Contains OCR and authenticity results for one document detected within an uploaded file.
- name: OpenBankingBankAccount
  fields: 28
- name: PartnerAddress
  fields: 6
  description: Address of the user.
- name: PartnerBirthDate
  fields: 3
  description: Date of birth in year-month-day format.
- name: PartnerBroker
  fields: 4
  description: Mortgage broker contact details for [wholesale borrower invites](/partners/wholesale-mortgage).
- name: PartnerCreateUserResponse
  fields: 2
  description: Response returned after creating a partner user.
- name: PartnerEmbeddedSessionCreateRequest
  fields: 3
- name: PartnerInviteSession
  fields: 6
- name: PartnerInviteSessionConfiguration
  fields: 5
- name: PartnerInviteSessionCreateConfiguration
  fields: 5
- name: PartnerInviteSessionCreateRequest
  fields: 3
- name: PartnerInviteSessionDelivery
  fields: 5
- name: PartnerInviteSessionInvite
  fields: 5
- name: PartnerOcrDocument
  fields: 3
  description: Contains OCR and authenticity results for one document detected within an uploaded file.
- name: PartnerOpenBanking
  fields: 1
  description: Banking-specific user metadata.
- name: PartnerOpenBankingEndUser
  fields: 6
  description: Contains details about the person or entity making the lending decision.
- name: PartnerPaystub
  fields: 31
- name: PartnerReportCustomField
  fields: 3
  description: Custom field returned in report JSON as a pass-through value.
- name: PartnerSession
  fields: 4
- name: PartnerSessionConfiguration
  fields: 0
- name: PartnerSessionCreateConfiguration
  fields: 7
  description: Connection session configuration for payroll and banking verifications.
- name: PartnerUser
  fields: 13
  description: Partner user object.
- name: PartnerUserCreateRequest
  fields: 11
- name: PartnerUserUpdateRequest
  fields: 10
- name: PartnerUserUpload
  fields: 9
- name: PartnerVerification
  fields: 13
- name: PartnerVerificationBilling
  fields: 1
  description: Optional billing details for regular payroll and mortgage verification workflows.
- name: PartnerVerificationConfiguration
  fields: 1
- name: PartnerVerificationCreateConfiguration
  fields: 1
- name: PartnerVerificationCreateReportRequest
  fields: 3
  description: Report request configuration.
- name: PartnerVerificationCreateRequest
  fields: 6
  description: Request body for ordering a verification.
- name: PartnerVerificationEmployment
  fields: 4
  description: Employment details for the user.
- name: PartnerVerificationEmploymentRequest
  fields: 0
- name: PartnerVerificationError
  fields: 4
  description: Verification error details.
- name: PartnerVerificationErrorResource
  fields: 3
  description: Verification error resource details.
- name: PartnerVerificationLoan
  fields: 5
  description: Optional loan details for regular payroll and mortgage verification workflows.
- name: PartnerVerificationLoanCreateRequest
  fields: 0
- name: PartnerVerificationLoanMetadata
  fields: 4
  description: Optional loan details for regular payroll and mortgage verification workflows.
- name: PartnerVerificationRefreshReportRequest
  fields: 2
  description: Report request configuration for refresh requests.
- name: PartnerVerificationRefreshRequest
  fields: 4
- name: PartnerVerificationReport
  fields: 6
  description: Report information.
- name: PartnerVerificationReportConfiguration
  fields: 5
  description: Optional banking report configurations.
- name: PartnerVerificationStatus
  fields: 3
  description: Verification status information.
- name: PartnerVerificationUpdateRequest
  fields: 3
  description: Request body for updating a verification.
- name: PayrollDocument
  fields: 14
- name: PayrollDocument_verifications-partners
  fields: 14
- name: Paystub
  fields: 31
- name: PlatformIds
  fields: 3
- name: Rating
  fields: 11
- name: Report
  fields: 13
- name: SendInviteRequest
  fields: 10
- name: Shift
  fields: 14
- name: Tax
  fields: 4
- name: User
  fields: 13
- name: UserForm
  fields: 5
- name: UserUpload
  fields: 9
- name: Vehicle
  fields: 12
- name: Webhook
  fields: 9
- name: WebhookCreateRequest
  fields: 5
- name: WebhookListResponse
  fields: 3
relationships:
- from: BankingReportRequest
  to: BankingReportCustomField
  type: has_many
  via: report_custom_fields
- from: ClientEmbeddedSessionCreateRequest
  to: ClientSessionCreateConfiguration
  type: has_one
  via: configuration
- from: ClientInviteSession
  to: ClientInviteSessionConfiguration
  type: has_one
  via: configuration
- from: ClientInviteSession
  to: ClientInviteSessionInvite
  type: has_one
  via: invite
- from: ClientInviteSessionCreateRequest
  to: ClientInviteSessionCreateConfiguration
  type: has_one
  via: configuration
- from: ClientInviteSessionInvite
  to: ClientInviteSessionDelivery
  type: has_many
  via: deliveries
- from: ClientSession
  to: ClientSessionConfiguration
  type: has_one
  via: configuration
- from: ClientVerification
  to: ClientVerificationStatus
  type: has_one
  via: status
- from: ClientVerification
  to: ClientVerificationReport
  type: has_one
  via: report
- from: ClientVerification
  to: ClientVerificationEmployment
  type: has_many
  via: employments
- from: ClientVerification
  to: ClientVerificationLoan
  type: has_one
  via: loan
- from: ClientVerification
  to: ClientVerificationBilling
  type: has_one
  via: billing
- from: ClientVerification
  to: ClientVerificationConfiguration
  type: has_one
  via: configuration
- from: ClientVerificationCreateReportRequest
  to: ClientVerificationReportConfiguration
  type: has_one
  via: configuration
- from: ClientVerificationCreateRequest
  to: ClientVerificationEmploymentRequest
  type: has_many
  via: employments
- from: ClientVerificationCreateRequest
  to: ClientVerificationCreateReportRequest
  type: has_one
  via: report
- from: ClientVerificationCreateRequest
  to: ClientVerificationLoanCreateRequest
  type: has_one
  via: loan
- from: ClientVerificationCreateRequest
  to: ClientVerificationBilling
  type: has_one
  via: billing
- from: ClientVerificationCreateRequest
  to: ClientVerificationCreateConfiguration
  type: has_one
  via: configuration
- from: ClientVerificationError
  to: ClientVerificationErrorResource
  type: has_many
  via: resources
- from: ClientVerificationRefreshReportRequest
  to: ClientVerificationReportConfiguration
  type: has_one
  via: configuration
- from: ClientVerificationRefreshRequest
  to: ClientVerificationRefreshReportRequest
  type: has_one
  via: report
- from: ClientVerificationRefreshRequest
  to: ClientVerificationLoanMetadata
  type: has_one
  via: loan
- from: ClientVerificationRefreshRequest
  to: ClientVerificationBilling
  type: has_one
  via: billing
- from: ClientVerificationReport
  to: ClientVerificationReportConfiguration
  type: has_one
  via: configuration
- from: ClientVerificationReportConfiguration
  to: ClientReportCustomField
  type: has_many
  via: report_custom_fields
- from: ClientVerificationStatus
  to: ClientVerificationError
  type: has_many
  via: errors
- from: ClientVerificationUpdateRequest
  to: ClientVerificationLoanMetadata
  type: has_one
  via: loan
- from: ClientVerificationUpdateRequest
  to: ClientVerificationBilling
  type: has_one
  via: billing
- from: ClientVerificationUpdateRequest
  to: ClientVerificationEmploymentRequest
  type: has_many
  via: employments
- from: Identity
  to: Address
  type: has_one
  via: address
- from: Identity
  to: BasePay
  type: has_one
  via: base_pay
- from: Identity
  to: PlatformIds
  type: has_one
  via: platform_ids
- from: InviteObject
  to: InviteDelivery
  type: has_many
  via: deliveries
- from: PartnerEmbeddedSessionCreateRequest
  to: PartnerSessionCreateConfiguration
  type: has_one
  via: configuration
- from: PartnerInviteSession
  to: PartnerInviteSessionConfiguration
  type: has_one
  via: configuration
- from: PartnerInviteSession
  to: PartnerInviteSessionInvite
  type: has_one
  via: invite
- from: PartnerInviteSessionCreateRequest
  to: PartnerInviteSessionCreateConfiguration
  type: has_one
  via: configuration
- from: PartnerInviteSessionInvite
  to: PartnerInviteSessionDelivery
  type: has_many
  via: deliveries
- from: PartnerOpenBanking
  to: PartnerOpenBankingEndUser
  type: has_one
  via: end_user
- from: PartnerPaystub
  to: Deduction
  type: has_many
  via: deduction_list
- from: PartnerPaystub
  to: FilingStatus
  type: has_many
  via: filing_status
- from: PartnerPaystub
  to: Tax
  type: has_many
  via: tax_list
- from: PartnerPaystub
  to: Destination
  type: has_many
  via: destinations
- from: PartnerPaystub
  to: GrossPay
  type: has_many
  via: gross_pay_list
- from: PartnerSession
  to: PartnerSessionConfiguration
  type: has_one
  via: configuration
- from: PartnerUser
  to: PartnerAddress
  type: has_one
  via: address
- from: PartnerUser
  to: PartnerBirthDate
  type: has_one
  via: birth_date
- from: PartnerUserCreateRequest
  to: PartnerAddress
  type: has_one
  via: address
- from: PartnerUserCreateRequest
  to: PartnerBirthDate
  type: has_one
  via: birth_date
- from: PartnerUserCreateRequest
  to: PartnerOpenBanking
  type: has_one
  via: open_banking
- from: PartnerUserUpdateRequest
  to: PartnerAddress
  type: has_one
  via: address
- from: PartnerUserUpdateRequest
  to: PartnerBirthDate
  type: has_one
  via: birth_date
- from: PartnerUserUpdateRequest
  to: PartnerOpenBanking
  type: has_one
  via: open_banking
- from: PartnerVerification
  to: PartnerVerificationStatus
  type: has_one
  via: status
- from: PartnerVerification
  to: PartnerVerificationReport
  type: has_one
  via: report
- from: PartnerVerification
  to: PartnerVerificationEmployment
  type: has_many
  via: employments
- from: PartnerVerification
  to: PartnerVerificationLoan
  type: has_one
  via: loan
- from: PartnerVerification
  to: PartnerVerificationBilling
  type: has_one
  via: billing
- from: PartnerVerification
  to: PartnerVerificationConfiguration
  type: has_one
  via: configuration
- from: PartnerVerificationCreateReportRequest
  to: PartnerVerificationReportConfiguration
  type: has_one
  via: configuration
- from: PartnerVerificationCreateRequest
  to: PartnerVerificationEmploymentRequest
  type: has_many
  via: employments
- from: PartnerVerificationCreateRequest
  to: PartnerVerificationCreateReportRequest
  type: has_one
  via: report
- from: PartnerVerificationCreateRequest
  to: PartnerVerificationLoanCreateRequest
  type: has_one
  via: loan
- from: PartnerVerificationCreateRequest
  to: PartnerVerificationBilling
  type: has_one
  via: billing
- from: PartnerVerificationCreateRequest
  to: PartnerVerificationCreateConfiguration
  type: has_one
  via: configuration
- from: PartnerVerificationError
  to: PartnerVerificationErrorResource
  type: has_many
  via: resources
- from: PartnerVerificationRefreshReportRequest
  to: PartnerVerificationReportConfiguration
  type: has_one
  via: configuration
- from: PartnerVerificationRefreshRequest
  to: PartnerVerificationRefreshReportRequest
  type: has_one
  via: report
- from: PartnerVerificationRefreshRequest
  to: PartnerVerificationLoanMetadata
  type: has_one
  via: loan
- from: PartnerVerificationRefreshRequest
  to: PartnerVerificationBilling
  type: has_one
  via: billing
- from: PartnerVerificationReport
  to: PartnerVerificationReportConfiguration
  type: has_one
  via: configuration
- from: PartnerVerificationReportConfiguration
  to: PartnerReportCustomField
  type: has_many
  via: report_custom_fields
- from: PartnerVerificationStatus
  to: PartnerVerificationError
  type: has_many
  via: errors
- from: PartnerVerificationUpdateRequest
  to: PartnerVerificationLoanMetadata
  type: has_one
  via: loan
- from: PartnerVerificationUpdateRequest
  to: PartnerVerificationBilling
  type: has_one
  via: billing
- from: PartnerVerificationUpdateRequest
  to: PartnerVerificationEmploymentRequest
  type: has_many
  via: employments
- from: Paystub
  to: Deduction
  type: has_many
  via: deduction_list
- from: Paystub
  to: FilingStatus
  type: has_many
  via: filing_status
- from: Paystub
  to: Tax
  type: has_many
  via: tax_list
- from: Paystub
  to: Destination
  type: has_many
  via: destinations
- from: Paystub
  to: GrossPay
  type: has_many
  via: gross_pay_list
- from: WebhookListResponse
  to: Webhook
  type: has_many
  via: results