generated: '2026-10-03' method: derived generator: derive-data-model.py source: - openapi/transmit-security-applications-api-openapi.yml - openapi/transmit-security-auth-api-openapi.yml - openapi/transmit-security-manage-api-openapi.yml - openapi/transmit-security-organizations-api-openapi.yml - openapi/transmit-security-recommendation-api-openapi.yml - openapi/transmit-security-token-api-openapi.yml - openapi/transmit-security-users-api-openapi.yml - openapi/transmit-security-verification-api-openapi.yml notation: has_one = property $ref; has_many = array of $ref; belongs_to = _id field summary: entities: 175 entities_in_spec: 175 relationships: 156 entities: - name: APNConfiguration fields: 5 - name: AdditionalInfoDto fields: 3 - name: AddressDto fields: 8 - name: ApiAddPassword fields: 4 - name: ApiAddress fields: 7 - name: ApiApp fields: 34 - name: ApiAppIds fields: 1 - name: ApiAppWithoutLogo fields: 33 - name: ApiAuthMethods fields: 14 - name: ApiAuthenticatorAppPreferences fields: 2 - name: ApiBasicApp fields: 6 - name: ApiCibaAuthConfiguration fields: 2 - name: ApiClientAuthenticationConfiguration fields: 4 - name: ApiCreateAppInput fields: 26 - name: ApiCreateManagedOrganizationInput fields: 5 - name: ApiCreateOidcClientInput fields: 28 - name: ApiCreateOrUpdateAddressInput fields: 6 - name: ApiCreateOrganizationInput fields: 6 - name: ApiCreateSamlClientInput fields: 16 - name: ApiCreateUserInput fields: 16 - name: ApiCustomDomainOutput fields: 4 - name: ApiDeviceAuthConfiguration fields: 4 - name: ApiExternalCommunication fields: 1 - name: ApiGetAllUsers fields: 3 - name: ApiGroup fields: 6 - name: ApiIdTokenEncryptionConfiguration fields: 2 - name: ApiLoginPreferences fields: 1 - name: ApiLogoutResponse fields: 1 - name: ApiMagicLinkInitWithEmailRequestDto fields: 9 - name: ApiMagicLinkInitWithIdentifierRequestDto fields: 10 - name: ApiMagicLinkTokenRequestDto fields: 8 - name: ApiMeAddPassword fields: 2 - name: ApiOidcClient fields: 29 - name: ApiOrganization fields: 12 - name: ApiOtpInitRequestDto fields: 12 - name: ApiOtpTokenRequestDto fields: 10 - name: ApiPasswordInformation fields: 4 - name: ApiRefreshTokenInvalidationTriggerConfiguration fields: 3 - name: ApiRole fields: 6 - name: ApiRoleGroup fields: 5 - name: ApiRoleGroupIds fields: 1 - name: ApiSamlClient fields: 25 - name: ApiSendAuthSmsOtpInput fields: 9 - name: ApiSendAuthSmsResponse fields: 2 - name: ApiSendEmailResponse fields: 1 - name: ApiSendLoginEmailInput fields: 9 - name: ApiSendOtpEmailRequestInput fields: 10 - name: ApiSendOtpEmailResponse fields: 2 - name: ApiSendOtpResponse fields: 3 - name: ApiTokenExchangeRequestInput fields: 3 - name: ApiTokenExchangeResponse fields: 4 - name: ApiTokenExpirationConfiguration fields: 3 - name: ApiTokenRequestClaims fields: 2 - name: ApiTokenResponse fields: 6 - name: ApiTokenSigningKey fields: 10 - name: ApiUpdateAppInput fields: 26 - name: ApiUpdateOidcClientInput fields: 27 - name: ApiUpdateOrganizationInput fields: 5 - name: ApiUpdatePassword fields: 2 - name: ApiUpdateResourceInAppInput fields: 1 - name: ApiUpdateSamlClientInput fields: 15 - name: ApiUpdateUserInput fields: 15 - name: ApiUser fields: 25 - name: ApiUserEmail fields: 3 - name: ApiUserIdentity fields: 7 - name: ApiUserIdentityAlias fields: 2 - name: ApiUserIdentityProvider fields: 5 - name: ApiUserName fields: 4 - name: ApiUserNameInput fields: 4 - name: ApiUserPasswordInput fields: 2 - name: ApiUserPhone fields: 3 - name: ApiUsersCount fields: 1 - name: ApiValidateAuthEmailOtpInput fields: 4 - name: ApiValidateAuthSmsOtpInput fields: 4 - name: AppleConfiguration fields: 5 - name: BadRequestException fields: 0 - name: BadRequestHttpError fields: 2 - name: BaseSmsOtpInput fields: 2 - name: BiometricLivenessCheckDto fields: 2 - name: BiometricMatchingCheckDto fields: 2 - name: ClientAttributes fields: 2 - name: ClientSecretConfiguration fields: 3 - name: CompleteSessionResult fields: 9 - name: CreateSessionRequest fields: 7 - name: CreateSessionResponse fields: 4 - name: CreateTokenSigningKeyInput fields: 1 - name: CustomerInformation fields: 3 - name: DelegatedAccessInput fields: 2 - name: DeprecatedAddressDetailsDto fields: 8 - name: DeprecatedDocumentDto fields: 11 - name: DeprecatedExtractedInfoDto fields: 2 - name: DeprecatedPersonDto fields: 7 - name: DeprecatedSessionResult fields: 6 - name: DeviceKeyResponseDto fields: 7 - name: DevicePushConfigDto fields: 3 - name: DocumentAuthenticationCheckDto fields: 2 - name: DocumentDto fields: 7 - name: DocumentLivenessCheckDto fields: 2 - name: DocumentValidationCheckDto fields: 2 - name: EmailConfiguration fields: 3 - name: EmailContentAttributes fields: 9 - name: EmailOtpConfiguration fields: 6 - name: EmploymentDto fields: 1 - name: ExtractedDetails fields: 2 - name: FaceAuthenticatorConfiguration fields: 5 - name: FcmConfiguration fields: 1 - name: FlaggedIdentityCheckDto fields: 2 - name: ForbiddenHttpError fields: 2 - name: GetConsentApprovalResponse fields: 2 - name: IdentifierIsTakenHttpError fields: 3 - name: IncompleteSessionResult fields: 2 - name: InvalidTokenHttpError fields: 2 - name: LockoutTier fields: 2 - name: LogoUploadDto fields: 1 - name: MessageConfiguration fields: 3 - name: MockBehavior fields: 5 - name: NationalStatusDto fields: 2 - name: NotFoundHttpError fields: 2 - name: PageInfo fields: 2 - name: PasswordConfiguration fields: 17 - name: PersonDto fields: 7 - name: PinAuthenticatorConfiguration fields: 4 - name: PushConfiguration fields: 2 - name: RedirectUriResponse fields: 1 - name: RegisterPasswordResponse fields: 1 - name: RiskDetailsDeviceDto fields: 13 - name: RiskDetailsDto fields: 4 - name: RiskDetailsGeneralDto fields: 4 - name: RiskDetailsNetworkDto fields: 9 - name: RiskRecommendationCheckDto fields: 2 - name: RoleGroupsAndDefaultOrgRolesDto fields: 2 - name: RolesAndRoleGroupsDto fields: 3 - name: RolesAndRoleGroupsInputDto fields: 2 - name: SMSConfiguration fields: 5 - name: SessionChecksDto fields: 7 - name: SessionConsent fields: 2 - name: SessionImageDto fields: 6 - name: SessionImagesResponse fields: 1 - name: StartSessionConfigDto fields: 1 - name: TlsClientAuth fields: 6 - name: TotpConfiguration fields: 10 - name: UpdateTokenSigningKey fields: 2 - name: UploadTokenSigningKey fields: 2 - name: UserVerifyEmailOrPhoneNumberInput fields: 1 - name: VerificationImageDto fields: 2 - name: VerifiedInfoDto fields: 2 - name: WebAuthnApiConfiguration fields: 15 - name: browser_names fields: 1 - name: context fields: 35 description: Identifies the context in which the action occurred. - name: country_codes fields: 1 - name: create_rule_response fields: 2 - name: custom_attributes fields: 0 description: Tenant-defined custom attributes attached to the action. These add context to an action but must match the schema defined in the Admin Portal. Invalid attributes are ignored and not included in the re - name: device_fingerprints fields: 1 - name: device_ids fields: 1 - name: device_public_keys fields: 1 - name: get_all_response fields: 1 - name: get_rule_response fields: 2 - name: ip_cidrs fields: 1 - name: os_versions fields: 1 - name: preview_rule fields: 3 description: Rule configured in preview mode that would have determined this action's recommendation if all enabled rules were in production. Useful for impact analysis without changing live behavior. - name: recommendation fields: 3 description: Decision the engine produced for the action. - name: recommendation_full fields: 11 description: Recommendation - name: risk_signals fields: 4 description: Additional informative signals derived from the action. - name: rule fields: 6 description: Recommendation rule - name: transaction_address fields: 9 description: Address and contact information (used by `billingInfo` and `shippingInfo`). - name: transaction_avs fields: 3 description: Address Verification Service result for the transaction. - name: transaction_card fields: 3 description: Card-level identifiers for the party. - name: transaction_data fields: 11 description: Transaction data-points provided with the action via the SDK. - name: transaction_party fields: 7 description: Shared shape for a transaction party (payee or payer). - name: transaction_payee fields: 0 description: Payee party of the transaction. - name: transaction_payer fields: 2 description: Payer party of the transaction. Adds customer-tier and billing-info fields on top of the shared party shape. - name: transaction_product fields: 4 description: A single product line item. - name: transaction_purchase fields: 3 description: Purchase details for the transaction. - name: update_delete_rule_response fields: 1 - name: user_ids fields: 1 relationships: - from: RolesAndRoleGroupsDto to: ApiRoleGroup type: has_many via: role_groups - from: RolesAndRoleGroupsDto to: ApiRole type: has_many via: default_organization_roles - from: RolesAndRoleGroupsDto to: ApiRole type: has_many via: roles - from: RoleGroupsAndDefaultOrgRolesDto to: ApiRoleGroup type: has_many via: role_groups - from: RoleGroupsAndDefaultOrgRolesDto to: ApiRole type: has_many via: default_organization_roles - from: ApiRoleGroup to: ApiRole type: has_many via: roles - from: ApiAuthMethods to: ClientSecretConfiguration type: has_one via: google - from: ApiAuthMethods to: ClientSecretConfiguration type: has_one via: facebook - from: ApiAuthMethods to: EmailConfiguration type: has_one via: email - from: ApiAuthMethods to: EmailOtpConfiguration type: has_one via: email_otp - from: ApiAuthMethods to: AppleConfiguration type: has_one via: apple - from: ApiAuthMethods to: SMSConfiguration type: has_one via: sms - from: ApiAuthMethods to: WebAuthnApiConfiguration type: has_one via: webauthn_api - from: ApiAuthMethods to: ClientSecretConfiguration type: has_one via: line - from: ApiAuthMethods to: PasswordConfiguration type: has_one via: password - from: ApiAuthMethods to: TotpConfiguration type: has_one via: totp - from: ApiAuthMethods to: PushConfiguration type: has_one via: push - from: ApiAuthMethods to: ClientSecretConfiguration type: has_one via: tiktok - from: ApiAuthMethods to: PinAuthenticatorConfiguration type: has_one via: pin_authenticator - from: ApiAuthMethods to: FaceAuthenticatorConfiguration type: has_one via: face - from: EmailConfiguration to: MessageConfiguration type: has_one via: message - from: ApiClientAuthenticationConfiguration to: TlsClientAuth type: has_one via: tls_client_auth - from: FaceAuthenticatorConfiguration to: LockoutTier type: has_many via: lockoutTiers - from: PasswordConfiguration to: LockoutTier type: has_many via: lockoutTiers - from: PasswordConfiguration to: MessageConfiguration type: has_one via: message - from: ApiUpdateOidcClientInput to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiUpdateOidcClientInput to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: ApiUpdateOidcClientInput to: ApiTokenExpirationConfiguration type: has_one via: token_expiration - from: ApiUpdateOidcClientInput to: ApiClientAuthenticationConfiguration type: has_one via: authentication_configuration - from: ApiUpdateOidcClientInput to: ApiIdTokenEncryptionConfiguration type: has_one via: id_token_encryption - from: ApiCreateOidcClientInput to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiCreateOidcClientInput to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: ApiCreateOidcClientInput to: ApiTokenExpirationConfiguration type: has_one via: token_expiration - from: ApiCreateOidcClientInput to: ApiClientAuthenticationConfiguration type: has_one via: authentication_configuration - from: ApiCreateOidcClientInput to: ApiIdTokenEncryptionConfiguration type: has_one via: id_token_encryption - from: EmailOtpConfiguration to: MessageConfiguration type: has_one via: message - from: ApiApp to: ApiLoginPreferences type: has_one via: login_preferences - from: ApiApp to: ApiAuthenticatorAppPreferences type: has_one via: authenticator_preferences - from: ApiApp to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiApp to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: ApiApp to: ApiCustomDomainOutput type: has_one via: custom_domain - from: ApiApp to: ApiExternalCommunication type: has_one via: external_communication - from: ApiApp to: ApiRefreshTokenInvalidationTriggerConfiguration type: has_one via: refresh_token_invalidation_trigger_configuration - from: ApiLoginPreferences to: ApiAuthMethods type: has_one via: auth_methods - from: PinAuthenticatorConfiguration to: LockoutTier type: has_many via: lockoutTiers - from: PushConfiguration to: APNConfiguration type: has_one via: apn - from: PushConfiguration to: FcmConfiguration type: has_one via: fcm - from: ApiCreateAppInput to: ApiAuthenticatorAppPreferences type: has_one via: authenticator_preferences - from: ApiCreateAppInput to: ApiRefreshTokenInvalidationTriggerConfiguration type: has_one via: refresh_token_invalidation_trigger_configuration - from: ApiCreateAppInput to: ApiCreateOidcClientInput type: has_one via: first_client - from: ApiCreateAppInput to: ApiCreateSamlClientInput type: has_one via: first_client - from: ApiCreateAppInput to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiCreateAppInput to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: TotpConfiguration to: LockoutTier type: has_many via: lockoutTiers - from: ApiAppWithoutLogo to: ApiLoginPreferences type: has_one via: login_preferences - from: ApiAppWithoutLogo to: ApiAuthenticatorAppPreferences type: has_one via: authenticator_preferences - from: ApiAppWithoutLogo to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiAppWithoutLogo to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: ApiAppWithoutLogo to: ApiCustomDomainOutput type: has_one via: custom_domain - from: ApiAppWithoutLogo to: ApiExternalCommunication type: has_one via: external_communication - from: ApiAppWithoutLogo to: ApiRefreshTokenInvalidationTriggerConfiguration type: has_one via: refresh_token_invalidation_trigger_configuration - from: WebAuthnApiConfiguration to: LockoutTier type: has_many via: lockoutTiers - from: ApiUpdateAppInput to: ApiAuthenticatorAppPreferences type: has_one via: authenticator_preferences - from: ApiUpdateAppInput to: ApiRefreshTokenInvalidationTriggerConfiguration type: has_one via: refresh_token_invalidation_trigger_configuration - from: ApiUpdateAppInput to: ApiCreateOidcClientInput type: has_one via: first_client - from: ApiUpdateAppInput to: ApiCreateSamlClientInput type: has_one via: first_client - from: ApiUpdateAppInput to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiUpdateAppInput to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: ApiOidcClient to: ApiDeviceAuthConfiguration type: has_one via: device_authorization - from: ApiOidcClient to: ApiCibaAuthConfiguration type: has_one via: ciba_authorization - from: ApiOidcClient to: ApiClientAuthenticationConfiguration type: has_one via: authentication_configuration - from: ApiOidcClient to: ApiTokenExpirationConfiguration type: has_one via: token_expiration - from: ApiOidcClient to: ApiIdTokenEncryptionConfiguration type: has_one via: id_token_encryption - from: ApiOtpTokenRequestDto to: ClientAttributes type: has_one via: client_attributes - from: ApiMagicLinkTokenRequestDto to: ApiTokenRequestClaims type: has_one via: claims - from: ApiMagicLinkTokenRequestDto to: ClientAttributes type: has_one via: client_attributes - from: ApiOtpInitRequestDto to: EmailContentAttributes type: has_one via: email_content - from: ApiOtpInitRequestDto to: BaseSmsOtpInput type: has_one via: custom_sms_input - from: ApiOtpInitRequestDto to: ClientAttributes type: has_one via: client_attributes - from: ApiMagicLinkInitWithIdentifierRequestDto to: EmailContentAttributes type: has_one via: email_content - from: ApiMagicLinkInitWithIdentifierRequestDto to: ClientAttributes type: has_one via: client_attributes - from: ApiMagicLinkInitWithEmailRequestDto to: EmailContentAttributes type: has_one via: email_content - from: ApiMagicLinkInitWithEmailRequestDto to: ClientAttributes type: has_one via: client_attributes - from: ApiSendOtpEmailRequestInput to: EmailContentAttributes type: has_one via: email_content - from: ApiSendOtpEmailRequestInput to: ClientAttributes type: has_one via: client_attributes - from: ApiSendLoginEmailInput to: EmailContentAttributes type: has_one via: email_content - from: ApiSendLoginEmailInput to: ClientAttributes type: has_one via: client_attributes - from: transaction_data to: transaction_payer type: has_one via: payer - from: transaction_data to: transaction_payee type: has_one via: payee - from: transaction_data to: transaction_purchase type: has_one via: purchase - from: transaction_data to: transaction_avs type: has_one via: avs - from: get_rule_response to: rule type: has_one via: data - from: transaction_purchase to: transaction_product type: has_many via: products - from: transaction_purchase to: transaction_address type: has_one via: shippingInfo - from: create_rule_response to: rule type: belongs_to via: rule_id - from: recommendation_full to: recommendation type: has_one via: recommendation - from: recommendation_full to: context type: has_one via: context - from: recommendation_full to: risk_signals type: has_one via: risk_signals - from: recommendation_full to: transaction_data type: has_one via: transaction_data - from: recommendation_full to: custom_attributes type: has_one via: custom_attributes - from: recommendation_full to: preview_rule type: has_one via: preview_rule - from: transaction_payer to: transaction_address type: has_one via: billingInfo - from: transaction_party to: transaction_card type: has_one via: card - from: ApiCreateUserInput to: ApiCreateOrUpdateAddressInput type: has_one via: address - from: ApiCreateUserInput to: ApiUserNameInput type: has_one via: name - from: ApiCreateUserInput to: ApiUserPasswordInput type: has_one via: credentials - from: ApiCreateUserInput to: DelegatedAccessInput type: has_one via: delegated_access - from: DeviceKeyResponseDto to: DevicePushConfigDto type: has_one via: push_config - from: ApiUpdateUserInput to: ApiCreateOrUpdateAddressInput type: has_one via: address - from: ApiUpdateUserInput to: ApiUserNameInput type: has_one via: name - from: ApiUserIdentity to: ApiUserIdentityAlias type: has_one via: user_alias - from: ApiGetAllUsers to: PageInfo type: has_one via: page_info - from: ApiGetAllUsers to: ApiUser type: has_many via: result - from: ApiUser to: ApiUserEmail type: has_one via: email - from: ApiUser to: ApiUserEmail type: has_many via: secondary_emails - from: ApiUser to: ApiUserPhone type: has_one via: phone_number - from: ApiUser to: ApiUserPhone type: has_many via: secondary_phone_numbers - from: ApiUser to: ApiAddress type: has_one via: address - from: ApiUser to: ApiUserName type: has_one via: name - from: ApiUser to: ApiUserIdentityProvider type: has_many via: identity_providers - from: ApiUser to: ApiUserIdentity type: has_many via: identities - from: ApiUser to: ApiPasswordInformation type: has_one via: password_information - from: DeprecatedSessionResult to: DeprecatedExtractedInfoDto type: has_one via: extracted_info - from: DeprecatedSessionResult to: VerifiedInfoDto type: has_one via: verified_info - from: SessionChecksDto to: DocumentValidationCheckDto type: has_one via: document_validation - from: SessionChecksDto to: DocumentAuthenticationCheckDto type: has_one via: document_authentication - from: SessionChecksDto to: DocumentLivenessCheckDto type: has_one via: document_liveness - from: SessionChecksDto to: BiometricMatchingCheckDto type: has_one via: biometric_matching - from: SessionChecksDto to: BiometricLivenessCheckDto type: has_one via: biometric_liveness - from: SessionChecksDto to: FlaggedIdentityCheckDto type: has_one via: flagged_identity - from: SessionChecksDto to: RiskRecommendationCheckDto type: has_one via: risk_recommendation - from: RiskDetailsDto to: RiskDetailsGeneralDto type: has_one via: general - from: RiskDetailsDto to: RiskDetailsDeviceDto type: has_one via: device - from: RiskDetailsDto to: RiskDetailsNetworkDto type: has_one via: network - from: MockBehavior to: ExtractedDetails type: has_one via: info - from: SessionImagesResponse to: SessionImageDto type: has_many via: session_images - from: AdditionalInfoDto to: AddressDto type: has_one via: address - from: AdditionalInfoDto to: NationalStatusDto type: has_one via: national_status - from: AdditionalInfoDto to: EmploymentDto type: has_one via: employment - from: DeprecatedExtractedInfoDto to: DeprecatedDocumentDto type: has_one via: document - from: DeprecatedExtractedInfoDto to: DeprecatedPersonDto type: has_one via: person - from: CompleteSessionResult to: RiskDetailsDto type: has_one via: risk_details - from: CompleteSessionResult to: PersonDto type: has_one via: person - from: CompleteSessionResult to: DocumentDto type: has_one via: document - from: CompleteSessionResult to: AdditionalInfoDto type: has_one via: additional_info - from: CompleteSessionResult to: SessionChecksDto type: has_one via: checks - from: CompleteSessionResult to: VerificationImageDto type: has_many via: verification_images - from: DeprecatedPersonDto to: DeprecatedAddressDetailsDto type: has_one via: address - from: VerifiedInfoDto to: DeprecatedPersonDto type: has_one via: person - from: VerifiedInfoDto to: DeprecatedDocumentDto type: has_one via: document - from: CreateSessionRequest to: MockBehavior type: has_one via: mock_behavior - from: CreateSessionRequest to: StartSessionConfigDto type: has_one via: start - from: CreateSessionRequest to: CustomerInformation type: has_one via: customer_information - from: StartSessionConfigDto to: SessionConsent type: has_one via: consent - from: ExtractedDetails to: DeprecatedPersonDto type: has_one via: person_details - from: ExtractedDetails to: DeprecatedDocumentDto type: has_one via: document_details