increase 1.339.0 → 1.341.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/increase/client.rb +8 -6
- data/lib/increase/internal/type/converter.rb +13 -12
- data/lib/increase/models/account.rb +40 -19
- data/lib/increase/models/account_create_params.rb +14 -11
- data/lib/increase/models/account_list_params.rb +25 -17
- data/lib/increase/models/account_number.rb +22 -14
- data/lib/increase/models/account_number_create_params.rb +12 -13
- data/lib/increase/models/account_number_list_params.rb +26 -20
- data/lib/increase/models/account_number_update_params.rb +12 -11
- data/lib/increase/models/account_statement.rb +15 -11
- data/lib/increase/models/account_statement_list_params.rb +15 -12
- data/lib/increase/models/account_transfer.rb +58 -29
- data/lib/increase/models/account_transfer_create_params.rb +12 -7
- data/lib/increase/models/account_transfer_list_params.rb +20 -12
- data/lib/increase/models/ach_prenotification.rb +48 -27
- data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
- data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
- data/lib/increase/models/ach_transfer.rb +199 -103
- data/lib/increase/models/ach_transfer_create_params.rb +110 -61
- data/lib/increase/models/ach_transfer_list_params.rb +23 -16
- data/lib/increase/models/balance_lookup.rb +14 -11
- data/lib/increase/models/beneficial_owner_create_params.rb +50 -38
- data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
- data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
- data/lib/increase/models/card.rb +69 -47
- data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
- data/lib/increase/models/card_create_params.rb +65 -56
- data/lib/increase/models/card_details.rb +7 -5
- data/lib/increase/models/card_dispute.rb +530 -306
- data/lib/increase/models/card_dispute_create_params.rb +271 -175
- data/lib/increase/models/card_dispute_list_params.rb +24 -16
- data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
- data/lib/increase/models/card_iframe_url.rb +3 -4
- data/lib/increase/models/card_list_params.rb +23 -16
- data/lib/increase/models/card_payment.rb +1941 -1200
- data/lib/increase/models/card_payment_list_params.rb +15 -11
- data/lib/increase/models/card_purchase_supplement.rb +37 -25
- data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
- data/lib/increase/models/card_push_transfer.rb +121 -65
- data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
- data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
- data/lib/increase/models/card_token.rb +9 -6
- data/lib/increase/models/card_token_capabilities.rb +11 -8
- data/lib/increase/models/card_token_list_params.rb +15 -11
- data/lib/increase/models/card_update_params.rb +65 -57
- data/lib/increase/models/card_validation.rb +76 -43
- data/lib/increase/models/card_validation_create_params.rb +11 -7
- data/lib/increase/models/card_validation_list_params.rb +23 -16
- data/lib/increase/models/check_deposit.rb +103 -52
- data/lib/increase/models/check_deposit_create_params.rb +2 -4
- data/lib/increase/models/check_deposit_list_params.rb +20 -12
- data/lib/increase/models/check_transfer.rb +127 -75
- data/lib/increase/models/check_transfer_create_params.rb +91 -51
- data/lib/increase/models/check_transfer_list_params.rb +27 -16
- data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
- data/lib/increase/models/declined_transaction.rb +339 -206
- data/lib/increase/models/declined_transaction_list_params.rb +18 -15
- data/lib/increase/models/digital_card_profile.rb +16 -9
- data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
- data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
- data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
- data/lib/increase/models/digital_wallet_token.rb +26 -17
- data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
- data/lib/increase/models/entity.rb +182 -140
- data/lib/increase/models/entity_archive_params.rb +3 -4
- data/lib/increase/models/entity_beneficial_owner.rb +24 -19
- data/lib/increase/models/entity_create_params.rb +326 -238
- data/lib/increase/models/entity_list_params.rb +67 -16
- data/lib/increase/models/entity_onboarding_session.rb +25 -11
- data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
- data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
- data/lib/increase/models/entity_supplemental_document.rb +11 -7
- data/lib/increase/models/entity_update_params.rb +114 -88
- data/lib/increase/models/event.rb +6 -5
- data/lib/increase/models/event_list_params.rb +23 -17
- data/lib/increase/models/event_subscription.rb +17 -9
- data/lib/increase/models/event_subscription_create_params.rb +14 -8
- data/lib/increase/models/event_subscription_list_params.rb +8 -5
- data/lib/increase/models/event_subscription_update_params.rb +2 -1
- data/lib/increase/models/export.rb +69 -30
- data/lib/increase/models/export_create_params.rb +76 -46
- data/lib/increase/models/export_list_params.rb +26 -17
- data/lib/increase/models/external_account.rb +14 -8
- data/lib/increase/models/external_account_create_params.rb +7 -6
- data/lib/increase/models/external_account_list_params.rb +12 -9
- data/lib/increase/models/external_account_update_params.rb +6 -3
- data/lib/increase/models/fednow_transfer.rb +62 -32
- data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
- data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
- data/lib/increase/models/file.rb +13 -7
- data/lib/increase/models/file_create_params.rb +6 -5
- data/lib/increase/models/file_link.rb +17 -8
- data/lib/increase/models/file_link_create_params.rb +3 -4
- data/lib/increase/models/file_list_params.rb +23 -16
- data/lib/increase/models/group.rb +6 -5
- data/lib/increase/models/inbound_ach_transfer.rb +115 -51
- data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
- data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
- data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
- data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
- data/lib/increase/models/inbound_check_deposit.rb +46 -19
- data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
- data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
- data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
- data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
- data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_mail_item.rb +13 -8
- data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
- data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
- data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
- data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
- data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
- data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_wire_transfer.rb +33 -21
- data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
- data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
- data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
- data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
- data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
- data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
- data/lib/increase/models/intrafi_balance.rb +18 -12
- data/lib/increase/models/intrafi_exclusion.rb +13 -7
- data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
- data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
- data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
- data/lib/increase/models/lockbox_address.rb +16 -11
- data/lib/increase/models/lockbox_address_list_params.rb +20 -12
- data/lib/increase/models/lockbox_address_update_params.rb +2 -1
- data/lib/increase/models/lockbox_recipient.rb +22 -10
- data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
- data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
- data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
- data/lib/increase/models/oauth_application.rb +12 -7
- data/lib/increase/models/oauth_application_list_params.rb +18 -15
- data/lib/increase/models/oauth_connection.rb +9 -6
- data/lib/increase/models/oauth_connection_list_params.rb +10 -9
- data/lib/increase/models/oauth_token.rb +6 -5
- data/lib/increase/models/oauth_token_create_params.rb +14 -7
- data/lib/increase/models/pending_transaction.rb +392 -239
- data/lib/increase/models/pending_transaction_create_params.rb +6 -6
- data/lib/increase/models/pending_transaction_list_params.rb +23 -19
- data/lib/increase/models/physical_card.rb +36 -24
- data/lib/increase/models/physical_card_create_params.rb +22 -17
- data/lib/increase/models/physical_card_list_params.rb +20 -12
- data/lib/increase/models/physical_card_profile.rb +33 -17
- data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
- data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
- data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
- data/lib/increase/models/physical_card_update_params.rb +2 -1
- data/lib/increase/models/program.rb +15 -8
- data/lib/increase/models/program_list_params.rb +3 -4
- data/lib/increase/models/real_time_decision.rb +561 -370
- data/lib/increase/models/real_time_decision_action_params.rb +86 -75
- data/lib/increase/models/real_time_payments_transfer.rb +90 -47
- data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
- data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
- data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
- data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
- data/lib/increase/models/routing_number_list_params.rb +3 -4
- data/lib/increase/models/routing_number_list_response.rb +11 -8
- data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
- data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
- data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
- data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
- data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
- data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
- data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
- data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
- data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
- data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
- data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
- data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
- data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
- data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
- data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
- data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
- data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
- data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
- data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
- data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
- data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
- data/lib/increase/models/simulations/export_create_params.rb +5 -5
- data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
- data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
- data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
- data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
- data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
- data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
- data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
- data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
- data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
- data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
- data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
- data/lib/increase/models/simulations/program_create_params.rb +4 -2
- data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
- data/lib/increase/models/supplemental_document_list_params.rb +8 -5
- data/lib/increase/models/swift_transfer.rb +48 -26
- data/lib/increase/models/swift_transfer_create_params.rb +28 -19
- data/lib/increase/models/swift_transfer_list_params.rb +23 -16
- data/lib/increase/models/transaction.rb +995 -534
- data/lib/increase/models/transaction_list_params.rb +21 -16
- data/lib/increase/models/unwrap_webhook_event.rb +6 -5
- data/lib/increase/models/wire_drawdown_request.rb +44 -26
- data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
- data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
- data/lib/increase/models/wire_transfer.rb +100 -55
- data/lib/increase/models/wire_transfer_create_params.rb +43 -26
- data/lib/increase/models/wire_transfer_list_params.rb +23 -16
- data/lib/increase/resources/account_numbers.rb +20 -16
- data/lib/increase/resources/account_statements.rb +3 -4
- data/lib/increase/resources/account_transfers.rb +20 -12
- data/lib/increase/resources/accounts.rb +19 -12
- data/lib/increase/resources/ach_prenotifications.rb +23 -13
- data/lib/increase/resources/ach_transfers.rb +93 -43
- data/lib/increase/resources/beneficial_owners.rb +35 -19
- data/lib/increase/resources/card_disputes.rb +43 -22
- data/lib/increase/resources/card_payments.rb +3 -4
- data/lib/increase/resources/card_purchase_supplements.rb +6 -5
- data/lib/increase/resources/card_push_transfers.rb +55 -24
- data/lib/increase/resources/card_tokens.rb +3 -4
- data/lib/increase/resources/card_validations.rb +19 -12
- data/lib/increase/resources/cards.rb +33 -22
- data/lib/increase/resources/check_deposits.rb +10 -9
- data/lib/increase/resources/check_transfers.rb +37 -17
- data/lib/increase/resources/declined_transactions.rb +3 -4
- data/lib/increase/resources/digital_card_profiles.rb +12 -7
- data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
- data/lib/increase/resources/entities.rb +69 -33
- data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
- data/lib/increase/resources/event_subscriptions.rb +22 -13
- data/lib/increase/resources/events.rb +10 -9
- data/lib/increase/resources/exports.rb +40 -22
- data/lib/increase/resources/external_accounts.rb +21 -14
- data/lib/increase/resources/fednow_transfers.rb +21 -14
- data/lib/increase/resources/file_links.rb +3 -4
- data/lib/increase/resources/files.rb +14 -10
- data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
- data/lib/increase/resources/inbound_check_deposits.rb +8 -6
- data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
- data/lib/increase/resources/inbound_mail_items.rb +7 -6
- data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
- data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
- data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
- data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
- data/lib/increase/resources/intrafi_exclusions.rb +17 -13
- data/lib/increase/resources/lockbox_addresses.rb +10 -6
- data/lib/increase/resources/lockbox_recipients.rb +17 -12
- data/lib/increase/resources/oauth_applications.rb +3 -4
- data/lib/increase/resources/oauth_connections.rb +6 -5
- data/lib/increase/resources/oauth_tokens.rb +14 -7
- data/lib/increase/resources/pending_transactions.rb +7 -8
- data/lib/increase/resources/physical_card_profiles.rb +18 -15
- data/lib/increase/resources/physical_cards.rb +17 -12
- data/lib/increase/resources/programs.rb +3 -4
- data/lib/increase/resources/real_time_decisions.rb +18 -9
- data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
- data/lib/increase/resources/routing_numbers.rb +3 -4
- data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
- data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
- data/lib/increase/resources/simulations/card_authentications.rb +10 -8
- data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
- data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
- data/lib/increase/resources/simulations/card_disputes.rb +6 -5
- data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
- data/lib/increase/resources/simulations/card_increments.rb +5 -4
- data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
- data/lib/increase/resources/simulations/card_refunds.rb +10 -6
- data/lib/increase/resources/simulations/card_reversals.rb +3 -4
- data/lib/increase/resources/simulations/card_settlements.rb +6 -5
- data/lib/increase/resources/simulations/card_tokens.rb +6 -3
- data/lib/increase/resources/simulations/check_deposits.rb +11 -9
- data/lib/increase/resources/simulations/entities.rb +3 -4
- data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
- data/lib/increase/resources/simulations/exports.rb +5 -5
- data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
- data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
- data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
- data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
- data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
- data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
- data/lib/increase/resources/simulations/interest_payments.rb +4 -5
- data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
- data/lib/increase/resources/simulations/physical_cards.rb +7 -6
- data/lib/increase/resources/simulations/programs.rb +4 -2
- data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
- data/lib/increase/resources/supplemental_documents.rb +8 -5
- data/lib/increase/resources/swift_transfers.rb +28 -16
- data/lib/increase/resources/transactions.rb +6 -5
- data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
- data/lib/increase/resources/wire_transfers.rb +29 -16
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/beneficial_owner_create_params.rbi +4 -2
- data/rbi/increase/models/check_transfer.rbi +15 -0
- data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
- data/rbi/increase/models/check_transfer_list_params.rbi +7 -0
- data/rbi/increase/models/entity.rbi +9 -6
- data/rbi/increase/models/entity_create_params.rbi +6 -4
- data/rbi/increase/models/entity_list_params.rbi +119 -0
- data/rbi/increase/models/entity_supplemental_document.rbi +1 -1
- data/rbi/increase/models/entity_update_params.rbi +4 -4
- data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
- data/rbi/increase/resources/beneficial_owners.rbi +2 -1
- data/rbi/increase/resources/entities.rbi +3 -0
- data/rbi/increase/resources/pending_transactions.rbi +2 -2
- data/sig/increase/models/check_transfer.rbs +9 -0
- data/sig/increase/models/check_transfer_create_params.rbs +12 -9
- data/sig/increase/models/check_transfer_list_params.rbs +4 -0
- data/sig/increase/models/entity_list_params.rbs +48 -1
- data/sig/increase/resources/entities.rbs +1 -0
- metadata +2 -2
|
@@ -136,50 +136,78 @@ module Increase
|
|
|
136
136
|
required :validation, -> { Increase::Entity::Validation }, nil?: true
|
|
137
137
|
|
|
138
138
|
# @!method initialize(id:, corporation:, created_at:, creating_entity_onboarding_session_id:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
|
|
139
|
-
# Some parameter documentations has been truncated, see {Increase::Models::Entity}
|
|
140
|
-
# for more details.
|
|
141
|
-
#
|
|
142
139
|
# Entities are the legal entities that own accounts. They can be people,
|
|
143
|
-
# corporations,
|
|
140
|
+
# corporations, joint accounts, trusts, or government authorities. To learn more,
|
|
144
141
|
# see [Entities](/documentation/entities).
|
|
145
142
|
#
|
|
146
143
|
# @param id [String] The entity's identifier.
|
|
147
144
|
#
|
|
148
|
-
# @param corporation [Increase::Models::Entity::Corporation, nil]
|
|
145
|
+
# @param corporation [Increase::Models::Entity::Corporation, nil]
|
|
146
|
+
# Details of the corporation entity. Will be present if `structure` is equal to
|
|
147
|
+
# `corporation`.
|
|
149
148
|
#
|
|
150
|
-
# @param created_at [Time]
|
|
149
|
+
# @param created_at [Time]
|
|
150
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity
|
|
151
|
+
# was created.
|
|
151
152
|
#
|
|
152
|
-
# @param creating_entity_onboarding_session_id [String, nil]
|
|
153
|
+
# @param creating_entity_onboarding_session_id [String, nil]
|
|
154
|
+
# The identifier of the Entity Onboarding Session that was used to create this
|
|
155
|
+
# Entity, if any.
|
|
153
156
|
#
|
|
154
157
|
# @param description [String, nil] The entity's description for display purposes.
|
|
155
158
|
#
|
|
156
|
-
# @param details_confirmed_at [Time, nil]
|
|
159
|
+
# @param details_confirmed_at [Time, nil]
|
|
160
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
|
|
161
|
+
# Entity's details were most recently confirmed.
|
|
157
162
|
#
|
|
158
|
-
# @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil]
|
|
163
|
+
# @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil]
|
|
164
|
+
# Details of the government authority entity. Will be present if `structure` is
|
|
165
|
+
# equal to `government_authority`.
|
|
159
166
|
#
|
|
160
|
-
# @param idempotency_key [String, nil]
|
|
167
|
+
# @param idempotency_key [String, nil]
|
|
168
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
169
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
170
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
161
171
|
#
|
|
162
|
-
# @param joint [Increase::Models::Entity::Joint, nil]
|
|
172
|
+
# @param joint [Increase::Models::Entity::Joint, nil]
|
|
173
|
+
# Details of the joint entity. Will be present if `structure` is equal to `joint`.
|
|
163
174
|
#
|
|
164
|
-
# @param natural_person [Increase::Models::Entity::NaturalPerson, nil]
|
|
175
|
+
# @param natural_person [Increase::Models::Entity::NaturalPerson, nil]
|
|
176
|
+
# Details of the natural person entity. Will be present if `structure` is equal to
|
|
177
|
+
# `natural_person`.
|
|
165
178
|
#
|
|
166
|
-
# @param risk_rating [Increase::Models::Entity::RiskRating, nil]
|
|
179
|
+
# @param risk_rating [Increase::Models::Entity::RiskRating, nil]
|
|
180
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
|
181
|
+
# such as money laundering.
|
|
167
182
|
#
|
|
168
183
|
# @param status [Symbol, Increase::Models::Entity::Status] The status of the entity.
|
|
169
184
|
#
|
|
170
185
|
# @param structure [Symbol, Increase::Models::Entity::Structure] The entity's legal structure.
|
|
171
186
|
#
|
|
172
|
-
# @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>]
|
|
187
|
+
# @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>]
|
|
188
|
+
# Additional documentation associated with the entity. This is limited to the
|
|
189
|
+
# first 10 documents for an entity. If an entity has more than 10 documents, use
|
|
190
|
+
# the GET /entity_supplemental_documents list endpoint to retrieve them.
|
|
173
191
|
#
|
|
174
|
-
# @param terms_agreements [Array<Increase::Models::Entity::TermsAgreement>]
|
|
192
|
+
# @param terms_agreements [Array<Increase::Models::Entity::TermsAgreement>]
|
|
193
|
+
# The terms that the Entity agreed to. Not all programs are required to submit
|
|
194
|
+
# this data.
|
|
175
195
|
#
|
|
176
|
-
# @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil]
|
|
196
|
+
# @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil]
|
|
197
|
+
# If you are using a third-party service for identity verification, you can use
|
|
198
|
+
# this field to associate this Entity with the identifier that represents them in
|
|
199
|
+
# that service.
|
|
177
200
|
#
|
|
178
|
-
# @param trust [Increase::Models::Entity::Trust, nil]
|
|
201
|
+
# @param trust [Increase::Models::Entity::Trust, nil]
|
|
202
|
+
# Details of the trust entity. Will be present if `structure` is equal to `trust`.
|
|
179
203
|
#
|
|
180
|
-
# @param type [Symbol, Increase::Models::Entity::Type]
|
|
204
|
+
# @param type [Symbol, Increase::Models::Entity::Type]
|
|
205
|
+
# A constant representing the object's type. For this resource it will always be
|
|
206
|
+
# `entity`.
|
|
181
207
|
#
|
|
182
|
-
# @param validation [Increase::Models::Entity::Validation, nil]
|
|
208
|
+
# @param validation [Increase::Models::Entity::Validation, nil]
|
|
209
|
+
# The validation results for the entity. Learn more about
|
|
210
|
+
# [validations](/documentation/entity-validation).
|
|
183
211
|
|
|
184
212
|
# @see Increase::Models::Entity#corporation
|
|
185
213
|
class Corporation < Increase::Internal::Type::BaseModel
|
|
@@ -227,7 +255,8 @@ module Increase
|
|
|
227
255
|
required :industry_code, String, nil?: true
|
|
228
256
|
|
|
229
257
|
# @!attribute legal_identifier
|
|
230
|
-
# The legal identifier of the corporation
|
|
258
|
+
# The legal identifier of the corporation, like an Employer Identification Number
|
|
259
|
+
# (EIN).
|
|
231
260
|
#
|
|
232
261
|
# @return [Increase::Models::Entity::Corporation::LegalIdentifier, nil]
|
|
233
262
|
required :legal_identifier, -> { Increase::Entity::Corporation::LegalIdentifier }, nil?: true
|
|
@@ -245,25 +274,32 @@ module Increase
|
|
|
245
274
|
required :website, String, nil?: true
|
|
246
275
|
|
|
247
276
|
# @!method initialize(address:, beneficial_owners:, beneficial_ownership_exemption_reason:, email:, incorporation_state:, industry_code:, legal_identifier:, name:, website:)
|
|
248
|
-
# Some parameter documentations has been truncated, see
|
|
249
|
-
# {Increase::Models::Entity::Corporation} for more details.
|
|
250
|
-
#
|
|
251
277
|
# Details of the corporation entity. Will be present if `structure` is equal to
|
|
252
278
|
# `corporation`.
|
|
253
279
|
#
|
|
254
280
|
# @param address [Increase::Models::Entity::Corporation::Address] The corporation's address.
|
|
255
281
|
#
|
|
256
|
-
# @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>]
|
|
282
|
+
# @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>]
|
|
283
|
+
# The identifying details of anyone controlling or owning 25% or more of the
|
|
284
|
+
# corporation.
|
|
257
285
|
#
|
|
258
|
-
# @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::Entity::Corporation::BeneficialOwnershipExemptionReason, nil]
|
|
286
|
+
# @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::Entity::Corporation::BeneficialOwnershipExemptionReason, nil]
|
|
287
|
+
# If the entity is exempt from the requirement to submit beneficial owners, the
|
|
288
|
+
# justification for the exemption.
|
|
259
289
|
#
|
|
260
290
|
# @param email [String, nil] An email address for the business.
|
|
261
291
|
#
|
|
262
|
-
# @param incorporation_state [String, nil]
|
|
292
|
+
# @param incorporation_state [String, nil]
|
|
293
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the
|
|
294
|
+
# corporation's state of incorporation.
|
|
263
295
|
#
|
|
264
|
-
# @param industry_code [String, nil]
|
|
296
|
+
# @param industry_code [String, nil]
|
|
297
|
+
# The numeric North American Industry Classification System (NAICS) code submitted
|
|
298
|
+
# for the corporation.
|
|
265
299
|
#
|
|
266
|
-
# @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil]
|
|
300
|
+
# @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil]
|
|
301
|
+
# The legal identifier of the corporation, like an Employer Identification Number
|
|
302
|
+
# (EIN).
|
|
267
303
|
#
|
|
268
304
|
# @param name [String] The legal name of the corporation.
|
|
269
305
|
#
|
|
@@ -309,9 +345,6 @@ module Increase
|
|
|
309
345
|
required :zip, String, nil?: true
|
|
310
346
|
|
|
311
347
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
312
|
-
# Some parameter documentations has been truncated, see
|
|
313
|
-
# {Increase::Models::Entity::Corporation::Address} for more details.
|
|
314
|
-
#
|
|
315
348
|
# The corporation's address.
|
|
316
349
|
#
|
|
317
350
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -322,7 +355,9 @@ module Increase
|
|
|
322
355
|
#
|
|
323
356
|
# @param line2 [String, nil] The second line of the address.
|
|
324
357
|
#
|
|
325
|
-
# @param state [String, nil]
|
|
358
|
+
# @param state [String, nil]
|
|
359
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
360
|
+
# state, province, or region of the address.
|
|
326
361
|
#
|
|
327
362
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
328
363
|
end
|
|
@@ -358,9 +393,11 @@ module Increase
|
|
|
358
393
|
#
|
|
359
394
|
# @param company_title [String, nil] This person's role or title within the entity.
|
|
360
395
|
#
|
|
361
|
-
# @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual]
|
|
396
|
+
# @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual]
|
|
397
|
+
# Personal details for the beneficial owner.
|
|
362
398
|
#
|
|
363
|
-
# @param prongs [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>]
|
|
399
|
+
# @param prongs [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>]
|
|
400
|
+
# Why this person is considered a beneficial owner of the entity.
|
|
364
401
|
|
|
365
402
|
# @see Increase::Models::Entity::Corporation::BeneficialOwner#individual
|
|
366
403
|
class Individual < Increase::Internal::Type::BaseModel
|
|
@@ -393,11 +430,13 @@ module Increase
|
|
|
393
430
|
# @!method initialize(address:, date_of_birth:, identification:, name:)
|
|
394
431
|
# Personal details for the beneficial owner.
|
|
395
432
|
#
|
|
396
|
-
# @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address]
|
|
433
|
+
# @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address]
|
|
434
|
+
# The person's address.
|
|
397
435
|
#
|
|
398
436
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
399
437
|
#
|
|
400
|
-
# @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification, nil]
|
|
438
|
+
# @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification, nil]
|
|
439
|
+
# A means of verifying the person's identity.
|
|
401
440
|
#
|
|
402
441
|
# @param name [String] The person's legal name.
|
|
403
442
|
|
|
@@ -441,10 +480,6 @@ module Increase
|
|
|
441
480
|
required :zip, String, nil?: true
|
|
442
481
|
|
|
443
482
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
444
|
-
# Some parameter documentations has been truncated, see
|
|
445
|
-
# {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address}
|
|
446
|
-
# for more details.
|
|
447
|
-
#
|
|
448
483
|
# The person's address.
|
|
449
484
|
#
|
|
450
485
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -455,7 +490,9 @@ module Increase
|
|
|
455
490
|
#
|
|
456
491
|
# @param line2 [String, nil] The second line of the address.
|
|
457
492
|
#
|
|
458
|
-
# @param state [String, nil]
|
|
493
|
+
# @param state [String, nil]
|
|
494
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
495
|
+
# state, province, or region of the address.
|
|
459
496
|
#
|
|
460
497
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
461
498
|
end
|
|
@@ -480,15 +517,14 @@ module Increase
|
|
|
480
517
|
required :number_last4, String
|
|
481
518
|
|
|
482
519
|
# @!method initialize(method_:, number_last4:)
|
|
483
|
-
# Some parameter documentations has been truncated, see
|
|
484
|
-
# {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification}
|
|
485
|
-
# for more details.
|
|
486
|
-
#
|
|
487
520
|
# A means of verifying the person's identity.
|
|
488
521
|
#
|
|
489
|
-
# @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
522
|
+
# @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
523
|
+
# A method that can be used to verify the individual's identity.
|
|
490
524
|
#
|
|
491
|
-
# @param number_last4 [String]
|
|
525
|
+
# @param number_last4 [String]
|
|
526
|
+
# The last 4 digits of the identification number that can be used to verify the
|
|
527
|
+
# individual's identity.
|
|
492
528
|
|
|
493
529
|
# A method that can be used to verify the individual's identity.
|
|
494
530
|
#
|
|
@@ -563,17 +599,19 @@ module Increase
|
|
|
563
599
|
required :category, enum: -> { Increase::Entity::Corporation::LegalIdentifier::Category }
|
|
564
600
|
|
|
565
601
|
# @!attribute value
|
|
566
|
-
# The
|
|
602
|
+
# The legal identifier itself.
|
|
567
603
|
#
|
|
568
604
|
# @return [String]
|
|
569
605
|
required :value, String
|
|
570
606
|
|
|
571
607
|
# @!method initialize(category:, value:)
|
|
572
|
-
# The legal identifier of the corporation
|
|
608
|
+
# The legal identifier of the corporation, like an Employer Identification Number
|
|
609
|
+
# (EIN).
|
|
573
610
|
#
|
|
574
|
-
# @param category [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category]
|
|
611
|
+
# @param category [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category]
|
|
612
|
+
# The category of the legal identifier.
|
|
575
613
|
#
|
|
576
|
-
# @param value [String] The
|
|
614
|
+
# @param value [String] The legal identifier itself.
|
|
577
615
|
|
|
578
616
|
# The category of the legal identifier.
|
|
579
617
|
#
|
|
@@ -636,11 +674,14 @@ module Increase
|
|
|
636
674
|
# Details of the government authority entity. Will be present if `structure` is
|
|
637
675
|
# equal to `government_authority`.
|
|
638
676
|
#
|
|
639
|
-
# @param address [Increase::Models::Entity::GovernmentAuthority::Address]
|
|
677
|
+
# @param address [Increase::Models::Entity::GovernmentAuthority::Address]
|
|
678
|
+
# The government authority's address.
|
|
640
679
|
#
|
|
641
|
-
# @param authorized_persons [Array<Increase::Models::Entity::GovernmentAuthority::AuthorizedPerson>]
|
|
680
|
+
# @param authorized_persons [Array<Increase::Models::Entity::GovernmentAuthority::AuthorizedPerson>]
|
|
681
|
+
# The identifying details of authorized persons of the government authority.
|
|
642
682
|
#
|
|
643
|
-
# @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category]
|
|
683
|
+
# @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category]
|
|
684
|
+
# The category of the government authority.
|
|
644
685
|
#
|
|
645
686
|
# @param name [String] The government authority's name.
|
|
646
687
|
#
|
|
@@ -688,9 +729,6 @@ module Increase
|
|
|
688
729
|
required :zip, String, nil?: true
|
|
689
730
|
|
|
690
731
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
691
|
-
# Some parameter documentations has been truncated, see
|
|
692
|
-
# {Increase::Models::Entity::GovernmentAuthority::Address} for more details.
|
|
693
|
-
#
|
|
694
732
|
# The government authority's address.
|
|
695
733
|
#
|
|
696
734
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -701,7 +739,9 @@ module Increase
|
|
|
701
739
|
#
|
|
702
740
|
# @param line2 [String, nil] The second line of the address.
|
|
703
741
|
#
|
|
704
|
-
# @param state [String, nil]
|
|
742
|
+
# @param state [String, nil]
|
|
743
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
744
|
+
# state, province, or region of the address.
|
|
705
745
|
#
|
|
706
746
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
707
747
|
end
|
|
@@ -765,7 +805,8 @@ module Increase
|
|
|
765
805
|
# @!method initialize(individuals:, name:)
|
|
766
806
|
# Details of the joint entity. Will be present if `structure` is equal to `joint`.
|
|
767
807
|
#
|
|
768
|
-
# @param individuals [Array<Increase::Models::Entity::Joint::Individual>]
|
|
808
|
+
# @param individuals [Array<Increase::Models::Entity::Joint::Individual>]
|
|
809
|
+
# The two individuals that share control of the entity.
|
|
769
810
|
#
|
|
770
811
|
# @param name [String] The entity's name.
|
|
771
812
|
|
|
@@ -799,7 +840,8 @@ module Increase
|
|
|
799
840
|
#
|
|
800
841
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
801
842
|
#
|
|
802
|
-
# @param identification [Increase::Models::Entity::Joint::Individual::Identification, nil]
|
|
843
|
+
# @param identification [Increase::Models::Entity::Joint::Individual::Identification, nil]
|
|
844
|
+
# A means of verifying the person's identity.
|
|
803
845
|
#
|
|
804
846
|
# @param name [String] The person's legal name.
|
|
805
847
|
|
|
@@ -843,9 +885,6 @@ module Increase
|
|
|
843
885
|
required :zip, String, nil?: true
|
|
844
886
|
|
|
845
887
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
846
|
-
# Some parameter documentations has been truncated, see
|
|
847
|
-
# {Increase::Models::Entity::Joint::Individual::Address} for more details.
|
|
848
|
-
#
|
|
849
888
|
# The person's address.
|
|
850
889
|
#
|
|
851
890
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -856,7 +895,9 @@ module Increase
|
|
|
856
895
|
#
|
|
857
896
|
# @param line2 [String, nil] The second line of the address.
|
|
858
897
|
#
|
|
859
|
-
# @param state [String, nil]
|
|
898
|
+
# @param state [String, nil]
|
|
899
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
900
|
+
# state, province, or region of the address.
|
|
860
901
|
#
|
|
861
902
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
862
903
|
end
|
|
@@ -879,14 +920,14 @@ module Increase
|
|
|
879
920
|
required :number_last4, String
|
|
880
921
|
|
|
881
922
|
# @!method initialize(method_:, number_last4:)
|
|
882
|
-
# Some parameter documentations has been truncated, see
|
|
883
|
-
# {Increase::Models::Entity::Joint::Individual::Identification} for more details.
|
|
884
|
-
#
|
|
885
923
|
# A means of verifying the person's identity.
|
|
886
924
|
#
|
|
887
|
-
# @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method]
|
|
925
|
+
# @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method]
|
|
926
|
+
# A method that can be used to verify the individual's identity.
|
|
888
927
|
#
|
|
889
|
-
# @param number_last4 [String]
|
|
928
|
+
# @param number_last4 [String]
|
|
929
|
+
# The last 4 digits of the identification number that can be used to verify the
|
|
930
|
+
# individual's identity.
|
|
890
931
|
|
|
891
932
|
# A method that can be used to verify the individual's identity.
|
|
892
933
|
#
|
|
@@ -950,7 +991,8 @@ module Increase
|
|
|
950
991
|
#
|
|
951
992
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
952
993
|
#
|
|
953
|
-
# @param identification [Increase::Models::Entity::NaturalPerson::Identification, nil]
|
|
994
|
+
# @param identification [Increase::Models::Entity::NaturalPerson::Identification, nil]
|
|
995
|
+
# A means of verifying the person's identity.
|
|
954
996
|
#
|
|
955
997
|
# @param name [String] The person's legal name.
|
|
956
998
|
|
|
@@ -994,9 +1036,6 @@ module Increase
|
|
|
994
1036
|
required :zip, String, nil?: true
|
|
995
1037
|
|
|
996
1038
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
997
|
-
# Some parameter documentations has been truncated, see
|
|
998
|
-
# {Increase::Models::Entity::NaturalPerson::Address} for more details.
|
|
999
|
-
#
|
|
1000
1039
|
# The person's address.
|
|
1001
1040
|
#
|
|
1002
1041
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -1007,7 +1046,9 @@ module Increase
|
|
|
1007
1046
|
#
|
|
1008
1047
|
# @param line2 [String, nil] The second line of the address.
|
|
1009
1048
|
#
|
|
1010
|
-
# @param state [String, nil]
|
|
1049
|
+
# @param state [String, nil]
|
|
1050
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1051
|
+
# state, province, or region of the address.
|
|
1011
1052
|
#
|
|
1012
1053
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
1013
1054
|
end
|
|
@@ -1032,14 +1073,14 @@ module Increase
|
|
|
1032
1073
|
required :number_last4, String
|
|
1033
1074
|
|
|
1034
1075
|
# @!method initialize(method_:, number_last4:)
|
|
1035
|
-
# Some parameter documentations has been truncated, see
|
|
1036
|
-
# {Increase::Models::Entity::NaturalPerson::Identification} for more details.
|
|
1037
|
-
#
|
|
1038
1076
|
# A means of verifying the person's identity.
|
|
1039
1077
|
#
|
|
1040
|
-
# @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method]
|
|
1078
|
+
# @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method]
|
|
1079
|
+
# A method that can be used to verify the individual's identity.
|
|
1041
1080
|
#
|
|
1042
|
-
# @param number_last4 [String]
|
|
1081
|
+
# @param number_last4 [String]
|
|
1082
|
+
# The last 4 digits of the identification number that can be used to verify the
|
|
1083
|
+
# individual's identity.
|
|
1043
1084
|
|
|
1044
1085
|
# A method that can be used to verify the individual's identity.
|
|
1045
1086
|
#
|
|
@@ -1084,13 +1125,12 @@ module Increase
|
|
|
1084
1125
|
required :rating, enum: -> { Increase::Entity::RiskRating::Rating }
|
|
1085
1126
|
|
|
1086
1127
|
# @!method initialize(rated_at:, rating:)
|
|
1087
|
-
# Some parameter documentations has been truncated, see
|
|
1088
|
-
# {Increase::Models::Entity::RiskRating} for more details.
|
|
1089
|
-
#
|
|
1090
1128
|
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
|
1091
1129
|
# such as money laundering.
|
|
1092
1130
|
#
|
|
1093
|
-
# @param rated_at [Time]
|
|
1131
|
+
# @param rated_at [Time]
|
|
1132
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
|
1133
|
+
# rating was performed.
|
|
1094
1134
|
#
|
|
1095
1135
|
# @param rating [Symbol, Increase::Models::Entity::RiskRating::Rating] The rating given to this entity.
|
|
1096
1136
|
|
|
@@ -1178,9 +1218,6 @@ module Increase
|
|
|
1178
1218
|
required :terms_url, String
|
|
1179
1219
|
|
|
1180
1220
|
# @!method initialize(agreed_at:, ip_address:, terms_url:)
|
|
1181
|
-
# Some parameter documentations has been truncated, see
|
|
1182
|
-
# {Increase::Models::Entity::TermsAgreement} for more details.
|
|
1183
|
-
#
|
|
1184
1221
|
# @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
|
|
1185
1222
|
#
|
|
1186
1223
|
# @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
|
|
@@ -1209,7 +1246,8 @@ module Increase
|
|
|
1209
1246
|
#
|
|
1210
1247
|
# @param reference [String] The reference identifier for the third party verification.
|
|
1211
1248
|
#
|
|
1212
|
-
# @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor]
|
|
1249
|
+
# @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor]
|
|
1250
|
+
# The vendor that was used to perform the verification.
|
|
1213
1251
|
|
|
1214
1252
|
# The vendor that was used to perform the verification.
|
|
1215
1253
|
#
|
|
@@ -1289,20 +1327,22 @@ module Increase
|
|
|
1289
1327
|
required :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Trust::Trustee] }
|
|
1290
1328
|
|
|
1291
1329
|
# @!method initialize(address:, category:, formation_document_file_id:, formation_state:, grantor:, name:, tax_identifier:, trustees:)
|
|
1292
|
-
# Some parameter documentations has been truncated, see
|
|
1293
|
-
# {Increase::Models::Entity::Trust} for more details.
|
|
1294
|
-
#
|
|
1295
1330
|
# Details of the trust entity. Will be present if `structure` is equal to `trust`.
|
|
1296
1331
|
#
|
|
1297
1332
|
# @param address [Increase::Models::Entity::Trust::Address] The trust's address.
|
|
1298
1333
|
#
|
|
1299
|
-
# @param category [Symbol, Increase::Models::Entity::Trust::Category]
|
|
1334
|
+
# @param category [Symbol, Increase::Models::Entity::Trust::Category]
|
|
1335
|
+
# Whether the trust is `revocable` or `irrevocable`.
|
|
1300
1336
|
#
|
|
1301
|
-
# @param formation_document_file_id [String, nil]
|
|
1337
|
+
# @param formation_document_file_id [String, nil]
|
|
1338
|
+
# The ID for the File containing the formation document of the trust.
|
|
1302
1339
|
#
|
|
1303
|
-
# @param formation_state [String, nil]
|
|
1340
|
+
# @param formation_state [String, nil]
|
|
1341
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state in
|
|
1342
|
+
# which the trust was formed.
|
|
1304
1343
|
#
|
|
1305
|
-
# @param grantor [Increase::Models::Entity::Trust::Grantor, nil]
|
|
1344
|
+
# @param grantor [Increase::Models::Entity::Trust::Grantor, nil]
|
|
1345
|
+
# The grantor of the trust. Will be present if the `category` is `revocable`.
|
|
1306
1346
|
#
|
|
1307
1347
|
# @param name [String] The trust's name.
|
|
1308
1348
|
#
|
|
@@ -1350,9 +1390,6 @@ module Increase
|
|
|
1350
1390
|
required :zip, String, nil?: true
|
|
1351
1391
|
|
|
1352
1392
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
1353
|
-
# Some parameter documentations has been truncated, see
|
|
1354
|
-
# {Increase::Models::Entity::Trust::Address} for more details.
|
|
1355
|
-
#
|
|
1356
1393
|
# The trust's address.
|
|
1357
1394
|
#
|
|
1358
1395
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -1363,7 +1400,9 @@ module Increase
|
|
|
1363
1400
|
#
|
|
1364
1401
|
# @param line2 [String, nil] The second line of the address.
|
|
1365
1402
|
#
|
|
1366
|
-
# @param state [String, nil]
|
|
1403
|
+
# @param state [String, nil]
|
|
1404
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1405
|
+
# state, province, or region of the address.
|
|
1367
1406
|
#
|
|
1368
1407
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
1369
1408
|
end
|
|
@@ -1417,7 +1456,8 @@ module Increase
|
|
|
1417
1456
|
#
|
|
1418
1457
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
1419
1458
|
#
|
|
1420
|
-
# @param identification [Increase::Models::Entity::Trust::Grantor::Identification, nil]
|
|
1459
|
+
# @param identification [Increase::Models::Entity::Trust::Grantor::Identification, nil]
|
|
1460
|
+
# A means of verifying the person's identity.
|
|
1421
1461
|
#
|
|
1422
1462
|
# @param name [String] The person's legal name.
|
|
1423
1463
|
|
|
@@ -1461,9 +1501,6 @@ module Increase
|
|
|
1461
1501
|
required :zip, String, nil?: true
|
|
1462
1502
|
|
|
1463
1503
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
1464
|
-
# Some parameter documentations has been truncated, see
|
|
1465
|
-
# {Increase::Models::Entity::Trust::Grantor::Address} for more details.
|
|
1466
|
-
#
|
|
1467
1504
|
# The person's address.
|
|
1468
1505
|
#
|
|
1469
1506
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -1474,7 +1511,9 @@ module Increase
|
|
|
1474
1511
|
#
|
|
1475
1512
|
# @param line2 [String, nil] The second line of the address.
|
|
1476
1513
|
#
|
|
1477
|
-
# @param state [String, nil]
|
|
1514
|
+
# @param state [String, nil]
|
|
1515
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1516
|
+
# state, province, or region of the address.
|
|
1478
1517
|
#
|
|
1479
1518
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
1480
1519
|
end
|
|
@@ -1497,14 +1536,14 @@ module Increase
|
|
|
1497
1536
|
required :number_last4, String
|
|
1498
1537
|
|
|
1499
1538
|
# @!method initialize(method_:, number_last4:)
|
|
1500
|
-
# Some parameter documentations has been truncated, see
|
|
1501
|
-
# {Increase::Models::Entity::Trust::Grantor::Identification} for more details.
|
|
1502
|
-
#
|
|
1503
1539
|
# A means of verifying the person's identity.
|
|
1504
1540
|
#
|
|
1505
|
-
# @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method]
|
|
1541
|
+
# @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method]
|
|
1542
|
+
# A method that can be used to verify the individual's identity.
|
|
1506
1543
|
#
|
|
1507
|
-
# @param number_last4 [String]
|
|
1544
|
+
# @param number_last4 [String]
|
|
1545
|
+
# The last 4 digits of the identification number that can be used to verify the
|
|
1546
|
+
# individual's identity.
|
|
1508
1547
|
|
|
1509
1548
|
# A method that can be used to verify the individual's identity.
|
|
1510
1549
|
#
|
|
@@ -1548,12 +1587,12 @@ module Increase
|
|
|
1548
1587
|
required :structure, enum: -> { Increase::Entity::Trust::Trustee::Structure }
|
|
1549
1588
|
|
|
1550
1589
|
# @!method initialize(individual:, structure:)
|
|
1551
|
-
#
|
|
1552
|
-
#
|
|
1590
|
+
# @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil]
|
|
1591
|
+
# The individual trustee of the trust. Will be present if the trustee's
|
|
1592
|
+
# `structure` is equal to `individual`.
|
|
1553
1593
|
#
|
|
1554
|
-
# @param
|
|
1555
|
-
#
|
|
1556
|
-
# @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] The structure of the trustee. Will always be equal to `individual`.
|
|
1594
|
+
# @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure]
|
|
1595
|
+
# The structure of the trustee. Will always be equal to `individual`.
|
|
1557
1596
|
|
|
1558
1597
|
# @see Increase::Models::Entity::Trust::Trustee#individual
|
|
1559
1598
|
class Individual < Increase::Internal::Type::BaseModel
|
|
@@ -1593,7 +1632,8 @@ module Increase
|
|
|
1593
1632
|
#
|
|
1594
1633
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
1595
1634
|
#
|
|
1596
|
-
# @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification, nil]
|
|
1635
|
+
# @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification, nil]
|
|
1636
|
+
# A means of verifying the person's identity.
|
|
1597
1637
|
#
|
|
1598
1638
|
# @param name [String] The person's legal name.
|
|
1599
1639
|
|
|
@@ -1637,10 +1677,6 @@ module Increase
|
|
|
1637
1677
|
required :zip, String, nil?: true
|
|
1638
1678
|
|
|
1639
1679
|
# @!method initialize(city:, country:, line1:, line2:, state:, zip:)
|
|
1640
|
-
# Some parameter documentations has been truncated, see
|
|
1641
|
-
# {Increase::Models::Entity::Trust::Trustee::Individual::Address} for more
|
|
1642
|
-
# details.
|
|
1643
|
-
#
|
|
1644
1680
|
# The person's address.
|
|
1645
1681
|
#
|
|
1646
1682
|
# @param city [String, nil] The city, district, town, or village of the address.
|
|
@@ -1651,7 +1687,9 @@ module Increase
|
|
|
1651
1687
|
#
|
|
1652
1688
|
# @param line2 [String, nil] The second line of the address.
|
|
1653
1689
|
#
|
|
1654
|
-
# @param state [String, nil]
|
|
1690
|
+
# @param state [String, nil]
|
|
1691
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1692
|
+
# state, province, or region of the address.
|
|
1655
1693
|
#
|
|
1656
1694
|
# @param zip [String, nil] The ZIP or postal code of the address.
|
|
1657
1695
|
end
|
|
@@ -1674,15 +1712,14 @@ module Increase
|
|
|
1674
1712
|
required :number_last4, String
|
|
1675
1713
|
|
|
1676
1714
|
# @!method initialize(method_:, number_last4:)
|
|
1677
|
-
# Some parameter documentations has been truncated, see
|
|
1678
|
-
# {Increase::Models::Entity::Trust::Trustee::Individual::Identification} for more
|
|
1679
|
-
# details.
|
|
1680
|
-
#
|
|
1681
1715
|
# A means of verifying the person's identity.
|
|
1682
1716
|
#
|
|
1683
|
-
# @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method]
|
|
1717
|
+
# @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method]
|
|
1718
|
+
# A method that can be used to verify the individual's identity.
|
|
1684
1719
|
#
|
|
1685
|
-
# @param number_last4 [String]
|
|
1720
|
+
# @param number_last4 [String]
|
|
1721
|
+
# The last 4 digits of the identification number that can be used to verify the
|
|
1722
|
+
# individual's identity.
|
|
1686
1723
|
|
|
1687
1724
|
# A method that can be used to verify the individual's identity.
|
|
1688
1725
|
#
|
|
@@ -1755,15 +1792,15 @@ module Increase
|
|
|
1755
1792
|
required :status, enum: -> { Increase::Entity::Validation::Status }
|
|
1756
1793
|
|
|
1757
1794
|
# @!method initialize(issues:, status:)
|
|
1758
|
-
# Some parameter documentations has been truncated, see
|
|
1759
|
-
# {Increase::Models::Entity::Validation} for more details.
|
|
1760
|
-
#
|
|
1761
1795
|
# The validation results for the entity. Learn more about
|
|
1762
1796
|
# [validations](/documentation/entity-validation).
|
|
1763
1797
|
#
|
|
1764
|
-
# @param issues [Array<Increase::Models::Entity::Validation::Issue>]
|
|
1798
|
+
# @param issues [Array<Increase::Models::Entity::Validation::Issue>]
|
|
1799
|
+
# The list of issues that need to be addressed.
|
|
1765
1800
|
#
|
|
1766
|
-
# @param status [Symbol, Increase::Models::Entity::Validation::Status]
|
|
1801
|
+
# @param status [Symbol, Increase::Models::Entity::Validation::Status]
|
|
1802
|
+
# The validation status for the entity. If the status is `invalid`, the `issues`
|
|
1803
|
+
# array will be populated.
|
|
1767
1804
|
|
|
1768
1805
|
class Issue < Increase::Internal::Type::BaseModel
|
|
1769
1806
|
# @!attribute beneficial_owner_address
|
|
@@ -1804,18 +1841,21 @@ module Increase
|
|
|
1804
1841
|
nil?: true
|
|
1805
1842
|
|
|
1806
1843
|
# @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_tax_identifier:)
|
|
1807
|
-
#
|
|
1808
|
-
#
|
|
1809
|
-
#
|
|
1810
|
-
# @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil] Details when the issue is with a beneficial owner's address.
|
|
1844
|
+
# @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil]
|
|
1845
|
+
# Details when the issue is with a beneficial owner's address.
|
|
1811
1846
|
#
|
|
1812
|
-
# @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil]
|
|
1847
|
+
# @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil]
|
|
1848
|
+
# Details when the issue is with a beneficial owner's identity verification.
|
|
1813
1849
|
#
|
|
1814
|
-
# @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category]
|
|
1850
|
+
# @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category]
|
|
1851
|
+
# The type of issue. We may add additional possible values for this enum over
|
|
1852
|
+
# time; your application should be able to handle such additions gracefully.
|
|
1815
1853
|
#
|
|
1816
|
-
# @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
|
|
1854
|
+
# @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
|
|
1855
|
+
# Details when the issue is with the entity's address.
|
|
1817
1856
|
#
|
|
1818
|
-
# @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
|
|
1857
|
+
# @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
|
|
1858
|
+
# Details when the issue is with the entity's tax ID.
|
|
1819
1859
|
|
|
1820
1860
|
# @see Increase::Models::Entity::Validation::Issue#beneficial_owner_address
|
|
1821
1861
|
class BeneficialOwnerAddress < Increase::Internal::Type::BaseModel
|
|
@@ -1836,7 +1876,8 @@ module Increase
|
|
|
1836
1876
|
#
|
|
1837
1877
|
# @param beneficial_owner_id [String] The ID of the beneficial owner.
|
|
1838
1878
|
#
|
|
1839
|
-
# @param reason [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason]
|
|
1879
|
+
# @param reason [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason]
|
|
1880
|
+
# The reason the address is invalid.
|
|
1840
1881
|
|
|
1841
1882
|
# The reason the address is invalid.
|
|
1842
1883
|
#
|
|
@@ -1900,7 +1941,8 @@ module Increase
|
|
|
1900
1941
|
# @!method initialize(reason:)
|
|
1901
1942
|
# Details when the issue is with the entity's address.
|
|
1902
1943
|
#
|
|
1903
|
-
# @param reason [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason]
|
|
1944
|
+
# @param reason [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason]
|
|
1945
|
+
# The reason the address is invalid.
|
|
1904
1946
|
|
|
1905
1947
|
# The reason the address is invalid.
|
|
1906
1948
|
#
|