increase 1.340.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 +48 -37
- 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 +124 -75
- data/lib/increase/models/check_transfer_create_params.rb +91 -51
- data/lib/increase/models/check_transfer_list_params.rb +24 -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 +175 -135
- 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 +323 -236
- 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 +10 -6
- data/lib/increase/models/entity_update_params.rb +112 -86
- 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/check_transfer.rbi +8 -0
- data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
- data/rbi/increase/models/entity_list_params.rbi +119 -0
- data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
- data/rbi/increase/resources/entities.rbi +3 -0
- data/rbi/increase/resources/pending_transactions.rbi +2 -2
- data/sig/increase/models/check_transfer.rbs +5 -0
- data/sig/increase/models/check_transfer_create_params.rbs +12 -9
- data/sig/increase/models/entity_list_params.rbs +48 -1
- data/sig/increase/resources/entities.rbs +1 -0
- metadata +2 -2
|
@@ -87,30 +87,47 @@ module Increase
|
|
|
87
87
|
optional :trust, -> { Increase::EntityCreateParams::Trust }
|
|
88
88
|
|
|
89
89
|
# @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
|
|
90
|
-
# Some parameter documentations has been truncated, see
|
|
91
|
-
# {Increase::Models::EntityCreateParams} for more details.
|
|
92
|
-
#
|
|
93
90
|
# @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
|
|
94
91
|
#
|
|
95
|
-
# @param corporation [Increase::Models::EntityCreateParams::Corporation]
|
|
92
|
+
# @param corporation [Increase::Models::EntityCreateParams::Corporation]
|
|
93
|
+
# Details of the corporation entity to create. Required if `structure` is equal to
|
|
94
|
+
# `corporation`.
|
|
96
95
|
#
|
|
97
96
|
# @param description [String] The description you choose to give the entity.
|
|
98
97
|
#
|
|
99
|
-
# @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
|
|
98
|
+
# @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
|
|
99
|
+
# Details of the Government Authority entity to create. Required if `structure` is
|
|
100
|
+
# equal to `government_authority`.
|
|
100
101
|
#
|
|
101
|
-
# @param joint [Increase::Models::EntityCreateParams::Joint]
|
|
102
|
+
# @param joint [Increase::Models::EntityCreateParams::Joint]
|
|
103
|
+
# Details of the joint entity to create. Required if `structure` is equal to
|
|
104
|
+
# `joint`.
|
|
102
105
|
#
|
|
103
|
-
# @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson]
|
|
106
|
+
# @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson]
|
|
107
|
+
# Details of the natural person entity to create. Required if `structure` is equal
|
|
108
|
+
# to `natural_person`. Natural people entities should be submitted with
|
|
109
|
+
# `social_security_number` or `individual_taxpayer_identification_number`
|
|
110
|
+
# identification methods.
|
|
104
111
|
#
|
|
105
|
-
# @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
|
|
112
|
+
# @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
|
|
113
|
+
# An assessment of the entity's potential risk of involvement in financial crimes,
|
|
114
|
+
# such as money laundering.
|
|
106
115
|
#
|
|
107
|
-
# @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
|
|
116
|
+
# @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
|
|
117
|
+
# Additional documentation associated with the entity.
|
|
108
118
|
#
|
|
109
|
-
# @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>]
|
|
119
|
+
# @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>]
|
|
120
|
+
# The terms that the Entity agreed to. Not all programs are required to submit
|
|
121
|
+
# this data.
|
|
110
122
|
#
|
|
111
|
-
# @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification]
|
|
123
|
+
# @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification]
|
|
124
|
+
# If you are using a third-party service for identity verification, you can use
|
|
125
|
+
# this field to associate this Entity with the identifier that represents them in
|
|
126
|
+
# that service.
|
|
112
127
|
#
|
|
113
|
-
# @param trust [Increase::Models::EntityCreateParams::Trust]
|
|
128
|
+
# @param trust [Increase::Models::EntityCreateParams::Trust]
|
|
129
|
+
# Details of the trust entity to create. Required if `structure` is equal to
|
|
130
|
+
# `trust`.
|
|
114
131
|
#
|
|
115
132
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
116
133
|
|
|
@@ -211,29 +228,50 @@ module Increase
|
|
|
211
228
|
optional :website, String
|
|
212
229
|
|
|
213
230
|
# @!method initialize(address:, beneficial_owners:, legal_identifier:, name:, beneficial_ownership_exemption_reason: nil, email: nil, incorporation_state: nil, industry_code: nil, website: nil)
|
|
214
|
-
# Some parameter documentations has been truncated, see
|
|
215
|
-
# {Increase::Models::EntityCreateParams::Corporation} for more details.
|
|
216
|
-
#
|
|
217
231
|
# Details of the corporation entity to create. Required if `structure` is equal to
|
|
218
232
|
# `corporation`.
|
|
219
233
|
#
|
|
220
|
-
# @param address [Increase::Models::EntityCreateParams::Corporation::Address]
|
|
234
|
+
# @param address [Increase::Models::EntityCreateParams::Corporation::Address]
|
|
235
|
+
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
236
|
+
# are disallowed.
|
|
221
237
|
#
|
|
222
|
-
# @param beneficial_owners [Array<Increase::Models::EntityCreateParams::Corporation::BeneficialOwner>]
|
|
238
|
+
# @param beneficial_owners [Array<Increase::Models::EntityCreateParams::Corporation::BeneficialOwner>]
|
|
239
|
+
# The identifying details of one control person (`control`), like the CEO, CFO, or
|
|
240
|
+
# other executive, plus each person who owns 25% or more of the business
|
|
241
|
+
# (`ownership`). At least one control person is required, and frequently, the
|
|
242
|
+
# `control` person is also `ownership`. In some cases, there are no individuals
|
|
243
|
+
# who own 25% or more of the business. In that case, you should submit a single
|
|
244
|
+
# `control` person.
|
|
223
245
|
#
|
|
224
|
-
# @param legal_identifier [Increase::Models::EntityCreateParams::Corporation::LegalIdentifier]
|
|
246
|
+
# @param legal_identifier [Increase::Models::EntityCreateParams::Corporation::LegalIdentifier]
|
|
247
|
+
# The legal identifier of the corporation. This is usually the Employer
|
|
248
|
+
# Identification Number (EIN). This replaces the deprecated `tax_identifier`
|
|
249
|
+
# field.
|
|
225
250
|
#
|
|
226
251
|
# @param name [String] The legal name of the corporation.
|
|
227
252
|
#
|
|
228
|
-
# @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason]
|
|
253
|
+
# @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason]
|
|
254
|
+
# If the entity is exempt from the requirement to submit beneficial owners,
|
|
255
|
+
# provide the justification. If a reason is provided, you do not need to submit a
|
|
256
|
+
# list of beneficial owners.
|
|
229
257
|
#
|
|
230
|
-
# @param email [String]
|
|
258
|
+
# @param email [String]
|
|
259
|
+
# An email address for the business. Not every program requires an email for
|
|
260
|
+
# submitted Entities.
|
|
231
261
|
#
|
|
232
|
-
# @param incorporation_state [String]
|
|
262
|
+
# @param incorporation_state [String]
|
|
263
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the
|
|
264
|
+
# corporation's state of incorporation.
|
|
233
265
|
#
|
|
234
|
-
# @param industry_code [String]
|
|
266
|
+
# @param industry_code [String]
|
|
267
|
+
# The North American Industry Classification System (NAICS) code for the
|
|
268
|
+
# corporation's primary line of business. This is a number, like `5132` for
|
|
269
|
+
# `Software Publishers`. A full list of classification codes is available
|
|
270
|
+
# [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
|
|
235
271
|
#
|
|
236
|
-
# @param website [String]
|
|
272
|
+
# @param website [String]
|
|
273
|
+
# A website for the business. Not every program requires a website for submitted
|
|
274
|
+
# Entities.
|
|
237
275
|
|
|
238
276
|
# @see Increase::Models::EntityCreateParams::Corporation#address
|
|
239
277
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -275,9 +313,6 @@ module Increase
|
|
|
275
313
|
optional :zip, String
|
|
276
314
|
|
|
277
315
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
278
|
-
# Some parameter documentations has been truncated, see
|
|
279
|
-
# {Increase::Models::EntityCreateParams::Corporation::Address} for more details.
|
|
280
|
-
#
|
|
281
316
|
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
282
317
|
# are disallowed.
|
|
283
318
|
#
|
|
@@ -289,7 +324,9 @@ module Increase
|
|
|
289
324
|
#
|
|
290
325
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
291
326
|
#
|
|
292
|
-
# @param state [String]
|
|
327
|
+
# @param state [String]
|
|
328
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
329
|
+
# state, province, or region of the address. Required in certain countries.
|
|
293
330
|
#
|
|
294
331
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
295
332
|
end
|
|
@@ -317,13 +354,13 @@ module Increase
|
|
|
317
354
|
optional :company_title, String
|
|
318
355
|
|
|
319
356
|
# @!method initialize(individual:, prongs:, company_title: nil)
|
|
320
|
-
#
|
|
321
|
-
#
|
|
322
|
-
# details.
|
|
357
|
+
# @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual]
|
|
358
|
+
# Personal details for the beneficial owner.
|
|
323
359
|
#
|
|
324
|
-
# @param
|
|
325
|
-
#
|
|
326
|
-
#
|
|
360
|
+
# @param prongs [Array<Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong>]
|
|
361
|
+
# Why this person is considered a beneficial owner of the entity. At least one
|
|
362
|
+
# option is required, if a person is both a control person and owner, submit an
|
|
363
|
+
# array containing both.
|
|
327
364
|
#
|
|
328
365
|
# @param company_title [String] This person's role or title within the entity.
|
|
329
366
|
|
|
@@ -365,21 +402,24 @@ module Increase
|
|
|
365
402
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
366
403
|
|
|
367
404
|
# @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
|
|
368
|
-
# Some parameter documentations has been truncated, see
|
|
369
|
-
# {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual}
|
|
370
|
-
# for more details.
|
|
371
|
-
#
|
|
372
405
|
# Personal details for the beneficial owner.
|
|
373
406
|
#
|
|
374
|
-
# @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address]
|
|
407
|
+
# @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address]
|
|
408
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
409
|
+
# PMB's are disallowed.
|
|
375
410
|
#
|
|
376
411
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
377
412
|
#
|
|
378
|
-
# @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification]
|
|
413
|
+
# @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification]
|
|
414
|
+
# A means of verifying the person's identity.
|
|
379
415
|
#
|
|
380
416
|
# @param name [String] The person's legal name.
|
|
381
417
|
#
|
|
382
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
418
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
419
|
+
# The identification method for an individual can only be a passport, driver's
|
|
420
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
421
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
422
|
+
# Number).
|
|
383
423
|
|
|
384
424
|
# @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#address
|
|
385
425
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -421,10 +461,6 @@ module Increase
|
|
|
421
461
|
optional :zip, String
|
|
422
462
|
|
|
423
463
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
424
|
-
# Some parameter documentations has been truncated, see
|
|
425
|
-
# {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address}
|
|
426
|
-
# for more details.
|
|
427
|
-
#
|
|
428
464
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
429
465
|
# PMB's are disallowed.
|
|
430
466
|
#
|
|
@@ -436,7 +472,9 @@ module Increase
|
|
|
436
472
|
#
|
|
437
473
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
438
474
|
#
|
|
439
|
-
# @param state [String]
|
|
475
|
+
# @param state [String]
|
|
476
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
477
|
+
# state, province, or region of the address. Required in certain countries.
|
|
440
478
|
#
|
|
441
479
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
442
480
|
end
|
|
@@ -488,21 +526,29 @@ module Increase
|
|
|
488
526
|
-> { Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport }
|
|
489
527
|
|
|
490
528
|
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
491
|
-
# Some parameter documentations has been truncated, see
|
|
492
|
-
# {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification}
|
|
493
|
-
# for more details.
|
|
494
|
-
#
|
|
495
529
|
# A means of verifying the person's identity.
|
|
496
530
|
#
|
|
497
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
531
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
532
|
+
# A method that can be used to verify the individual's identity.
|
|
498
533
|
#
|
|
499
|
-
# @param number [String]
|
|
534
|
+
# @param number [String]
|
|
535
|
+
# An identification number that can be used to verify the individual's identity,
|
|
536
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
537
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
538
|
+
# separators. When testing in sandbox, use one of our
|
|
539
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
500
540
|
#
|
|
501
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense]
|
|
541
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense]
|
|
542
|
+
# Information about the United States driver's license used for identification.
|
|
543
|
+
# Required if `method` is equal to `drivers_license`.
|
|
502
544
|
#
|
|
503
|
-
# @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other]
|
|
545
|
+
# @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other]
|
|
546
|
+
# Information about the identification document provided. Required if `method` is
|
|
547
|
+
# equal to `other`.
|
|
504
548
|
#
|
|
505
|
-
# @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport]
|
|
549
|
+
# @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport]
|
|
550
|
+
# Information about the passport used for identification. Required if `method` is
|
|
551
|
+
# equal to `passport`.
|
|
506
552
|
|
|
507
553
|
# A method that can be used to verify the individual's identity.
|
|
508
554
|
#
|
|
@@ -603,20 +649,20 @@ module Increase
|
|
|
603
649
|
optional :expiration_date, Date
|
|
604
650
|
|
|
605
651
|
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
606
|
-
# Some parameter documentations has been truncated, see
|
|
607
|
-
# {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other}
|
|
608
|
-
# for more details.
|
|
609
|
-
#
|
|
610
652
|
# Information about the identification document provided. Required if `method` is
|
|
611
653
|
# equal to `other`.
|
|
612
654
|
#
|
|
613
|
-
# @param country [String]
|
|
655
|
+
# @param country [String]
|
|
656
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
657
|
+
# document (e.g., `US`).
|
|
614
658
|
#
|
|
615
659
|
# @param description [String] A description of the document submitted.
|
|
616
660
|
#
|
|
617
661
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
618
662
|
#
|
|
619
|
-
# @param back_file_id [String]
|
|
663
|
+
# @param back_file_id [String]
|
|
664
|
+
# The identifier of the File containing the back of the document. Not every
|
|
665
|
+
# document has a reverse side.
|
|
620
666
|
#
|
|
621
667
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
622
668
|
end
|
|
@@ -643,14 +689,12 @@ module Increase
|
|
|
643
689
|
required :file_id, String
|
|
644
690
|
|
|
645
691
|
# @!method initialize(country:, expiration_date:, file_id:)
|
|
646
|
-
# Some parameter documentations has been truncated, see
|
|
647
|
-
# {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport}
|
|
648
|
-
# for more details.
|
|
649
|
-
#
|
|
650
692
|
# Information about the passport used for identification. Required if `method` is
|
|
651
693
|
# equal to `passport`.
|
|
652
694
|
#
|
|
653
|
-
# @param country [String]
|
|
695
|
+
# @param country [String]
|
|
696
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
697
|
+
# document (e.g., `US`).
|
|
654
698
|
#
|
|
655
699
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
656
700
|
#
|
|
@@ -692,17 +736,19 @@ module Increase
|
|
|
692
736
|
optional :category, enum: -> { Increase::EntityCreateParams::Corporation::LegalIdentifier::Category }
|
|
693
737
|
|
|
694
738
|
# @!method initialize(value:, category: nil)
|
|
695
|
-
# Some parameter documentations has been truncated, see
|
|
696
|
-
# {Increase::Models::EntityCreateParams::Corporation::LegalIdentifier} for more
|
|
697
|
-
# details.
|
|
698
|
-
#
|
|
699
739
|
# The legal identifier of the corporation. This is usually the Employer
|
|
700
740
|
# Identification Number (EIN). This replaces the deprecated `tax_identifier`
|
|
701
741
|
# field.
|
|
702
742
|
#
|
|
703
|
-
# @param value [String]
|
|
743
|
+
# @param value [String]
|
|
744
|
+
# The legal identifier itself. For US Employer Identification Numbers, submit nine
|
|
745
|
+
# digits with no dashes or other separators. When testing in sandbox, use one of
|
|
746
|
+
# our
|
|
747
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
704
748
|
#
|
|
705
|
-
# @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category]
|
|
749
|
+
# @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category]
|
|
750
|
+
# The category of the legal identifier. If not provided, the default is
|
|
751
|
+
# `us_employer_identification_number`.
|
|
706
752
|
|
|
707
753
|
# The category of the legal identifier. If not provided, the default is
|
|
708
754
|
# `us_employer_identification_number`.
|
|
@@ -789,23 +835,28 @@ module Increase
|
|
|
789
835
|
optional :website, String
|
|
790
836
|
|
|
791
837
|
# @!method initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website: nil)
|
|
792
|
-
# Some parameter documentations has been truncated, see
|
|
793
|
-
# {Increase::Models::EntityCreateParams::GovernmentAuthority} for more details.
|
|
794
|
-
#
|
|
795
838
|
# Details of the Government Authority entity to create. Required if `structure` is
|
|
796
839
|
# equal to `government_authority`.
|
|
797
840
|
#
|
|
798
|
-
# @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address]
|
|
841
|
+
# @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address]
|
|
842
|
+
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
843
|
+
# are disallowed.
|
|
799
844
|
#
|
|
800
|
-
# @param authorized_persons [Array<Increase::Models::EntityCreateParams::GovernmentAuthority::AuthorizedPerson>]
|
|
845
|
+
# @param authorized_persons [Array<Increase::Models::EntityCreateParams::GovernmentAuthority::AuthorizedPerson>]
|
|
846
|
+
# The identifying details of authorized officials acting on the entity's behalf.
|
|
801
847
|
#
|
|
802
|
-
# @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category]
|
|
848
|
+
# @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category]
|
|
849
|
+
# The category of the government authority.
|
|
803
850
|
#
|
|
804
851
|
# @param name [String] The legal name of the government authority.
|
|
805
852
|
#
|
|
806
|
-
# @param tax_identifier [String]
|
|
853
|
+
# @param tax_identifier [String]
|
|
854
|
+
# The Employer Identification Number (EIN) for the government authority. Submit
|
|
855
|
+
# nine digits with no dashes or other separators.
|
|
807
856
|
#
|
|
808
|
-
# @param website [String]
|
|
857
|
+
# @param website [String]
|
|
858
|
+
# A website for the government authority. Not every program requires a website for
|
|
859
|
+
# submitted Entities.
|
|
809
860
|
|
|
810
861
|
# @see Increase::Models::EntityCreateParams::GovernmentAuthority#address
|
|
811
862
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -841,10 +892,6 @@ module Increase
|
|
|
841
892
|
optional :line2, String
|
|
842
893
|
|
|
843
894
|
# @!method initialize(city:, line1:, state:, zip:, line2: nil)
|
|
844
|
-
# Some parameter documentations has been truncated, see
|
|
845
|
-
# {Increase::Models::EntityCreateParams::GovernmentAuthority::Address} for more
|
|
846
|
-
# details.
|
|
847
|
-
#
|
|
848
895
|
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
849
896
|
# are disallowed.
|
|
850
897
|
#
|
|
@@ -852,7 +899,9 @@ module Increase
|
|
|
852
899
|
#
|
|
853
900
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
854
901
|
#
|
|
855
|
-
# @param state [String]
|
|
902
|
+
# @param state [String]
|
|
903
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
904
|
+
# the address.
|
|
856
905
|
#
|
|
857
906
|
# @param zip [String] The ZIP code of the address.
|
|
858
907
|
#
|
|
@@ -905,7 +954,8 @@ module Increase
|
|
|
905
954
|
# Details of the joint entity to create. Required if `structure` is equal to
|
|
906
955
|
# `joint`.
|
|
907
956
|
#
|
|
908
|
-
# @param individuals [Array<Increase::Models::EntityCreateParams::Joint::Individual>]
|
|
957
|
+
# @param individuals [Array<Increase::Models::EntityCreateParams::Joint::Individual>]
|
|
958
|
+
# The two individuals that share control of the entity.
|
|
909
959
|
|
|
910
960
|
class Individual < Increase::Internal::Type::BaseModel
|
|
911
961
|
# @!attribute address
|
|
@@ -943,18 +993,22 @@ module Increase
|
|
|
943
993
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
944
994
|
|
|
945
995
|
# @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
|
|
946
|
-
#
|
|
947
|
-
#
|
|
948
|
-
#
|
|
949
|
-
# @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
|
|
996
|
+
# @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address]
|
|
997
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
998
|
+
# PMB's are disallowed.
|
|
950
999
|
#
|
|
951
1000
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
952
1001
|
#
|
|
953
|
-
# @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification]
|
|
1002
|
+
# @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification]
|
|
1003
|
+
# A means of verifying the person's identity.
|
|
954
1004
|
#
|
|
955
1005
|
# @param name [String] The person's legal name.
|
|
956
1006
|
#
|
|
957
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
1007
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
1008
|
+
# The identification method for an individual can only be a passport, driver's
|
|
1009
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
1010
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
1011
|
+
# Number).
|
|
958
1012
|
|
|
959
1013
|
# @see Increase::Models::EntityCreateParams::Joint::Individual#address
|
|
960
1014
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -996,10 +1050,6 @@ module Increase
|
|
|
996
1050
|
optional :zip, String
|
|
997
1051
|
|
|
998
1052
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
999
|
-
# Some parameter documentations has been truncated, see
|
|
1000
|
-
# {Increase::Models::EntityCreateParams::Joint::Individual::Address} for more
|
|
1001
|
-
# details.
|
|
1002
|
-
#
|
|
1003
1053
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1004
1054
|
# PMB's are disallowed.
|
|
1005
1055
|
#
|
|
@@ -1011,7 +1061,9 @@ module Increase
|
|
|
1011
1061
|
#
|
|
1012
1062
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
1013
1063
|
#
|
|
1014
|
-
# @param state [String]
|
|
1064
|
+
# @param state [String]
|
|
1065
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1066
|
+
# state, province, or region of the address. Required in certain countries.
|
|
1015
1067
|
#
|
|
1016
1068
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
1017
1069
|
end
|
|
@@ -1059,21 +1111,29 @@ module Increase
|
|
|
1059
1111
|
optional :passport, -> { Increase::EntityCreateParams::Joint::Individual::Identification::Passport }
|
|
1060
1112
|
|
|
1061
1113
|
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
1062
|
-
# Some parameter documentations has been truncated, see
|
|
1063
|
-
# {Increase::Models::EntityCreateParams::Joint::Individual::Identification} for
|
|
1064
|
-
# more details.
|
|
1065
|
-
#
|
|
1066
1114
|
# A means of verifying the person's identity.
|
|
1067
1115
|
#
|
|
1068
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method]
|
|
1116
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method]
|
|
1117
|
+
# A method that can be used to verify the individual's identity.
|
|
1069
1118
|
#
|
|
1070
|
-
# @param number [String]
|
|
1119
|
+
# @param number [String]
|
|
1120
|
+
# An identification number that can be used to verify the individual's identity,
|
|
1121
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
1122
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
1123
|
+
# separators. When testing in sandbox, use one of our
|
|
1124
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
1071
1125
|
#
|
|
1072
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense]
|
|
1126
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense]
|
|
1127
|
+
# Information about the United States driver's license used for identification.
|
|
1128
|
+
# Required if `method` is equal to `drivers_license`.
|
|
1073
1129
|
#
|
|
1074
|
-
# @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other]
|
|
1130
|
+
# @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other]
|
|
1131
|
+
# Information about the identification document provided. Required if `method` is
|
|
1132
|
+
# equal to `other`.
|
|
1075
1133
|
#
|
|
1076
|
-
# @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport]
|
|
1134
|
+
# @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport]
|
|
1135
|
+
# Information about the passport used for identification. Required if `method` is
|
|
1136
|
+
# equal to `passport`.
|
|
1077
1137
|
|
|
1078
1138
|
# A method that can be used to verify the individual's identity.
|
|
1079
1139
|
#
|
|
@@ -1174,20 +1234,20 @@ module Increase
|
|
|
1174
1234
|
optional :expiration_date, Date
|
|
1175
1235
|
|
|
1176
1236
|
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
1177
|
-
# Some parameter documentations has been truncated, see
|
|
1178
|
-
# {Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other}
|
|
1179
|
-
# for more details.
|
|
1180
|
-
#
|
|
1181
1237
|
# Information about the identification document provided. Required if `method` is
|
|
1182
1238
|
# equal to `other`.
|
|
1183
1239
|
#
|
|
1184
|
-
# @param country [String]
|
|
1240
|
+
# @param country [String]
|
|
1241
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1242
|
+
# document (e.g., `US`).
|
|
1185
1243
|
#
|
|
1186
1244
|
# @param description [String] A description of the document submitted.
|
|
1187
1245
|
#
|
|
1188
1246
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
1189
1247
|
#
|
|
1190
|
-
# @param back_file_id [String]
|
|
1248
|
+
# @param back_file_id [String]
|
|
1249
|
+
# The identifier of the File containing the back of the document. Not every
|
|
1250
|
+
# document has a reverse side.
|
|
1191
1251
|
#
|
|
1192
1252
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
1193
1253
|
end
|
|
@@ -1214,14 +1274,12 @@ module Increase
|
|
|
1214
1274
|
required :file_id, String
|
|
1215
1275
|
|
|
1216
1276
|
# @!method initialize(country:, expiration_date:, file_id:)
|
|
1217
|
-
# Some parameter documentations has been truncated, see
|
|
1218
|
-
# {Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport}
|
|
1219
|
-
# for more details.
|
|
1220
|
-
#
|
|
1221
1277
|
# Information about the passport used for identification. Required if `method` is
|
|
1222
1278
|
# equal to `passport`.
|
|
1223
1279
|
#
|
|
1224
|
-
# @param country [String]
|
|
1280
|
+
# @param country [String]
|
|
1281
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1282
|
+
# document (e.g., `US`).
|
|
1225
1283
|
#
|
|
1226
1284
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
1227
1285
|
#
|
|
@@ -1267,23 +1325,27 @@ module Increase
|
|
|
1267
1325
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
1268
1326
|
|
|
1269
1327
|
# @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
|
|
1270
|
-
# Some parameter documentations has been truncated, see
|
|
1271
|
-
# {Increase::Models::EntityCreateParams::NaturalPerson} for more details.
|
|
1272
|
-
#
|
|
1273
1328
|
# Details of the natural person entity to create. Required if `structure` is equal
|
|
1274
1329
|
# to `natural_person`. Natural people entities should be submitted with
|
|
1275
1330
|
# `social_security_number` or `individual_taxpayer_identification_number`
|
|
1276
1331
|
# identification methods.
|
|
1277
1332
|
#
|
|
1278
|
-
# @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address]
|
|
1333
|
+
# @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address]
|
|
1334
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1335
|
+
# PMB's are disallowed.
|
|
1279
1336
|
#
|
|
1280
1337
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
1281
1338
|
#
|
|
1282
|
-
# @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification]
|
|
1339
|
+
# @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification]
|
|
1340
|
+
# A means of verifying the person's identity.
|
|
1283
1341
|
#
|
|
1284
1342
|
# @param name [String] The person's legal name.
|
|
1285
1343
|
#
|
|
1286
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
1344
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
1345
|
+
# The identification method for an individual can only be a passport, driver's
|
|
1346
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
1347
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
1348
|
+
# Number).
|
|
1287
1349
|
|
|
1288
1350
|
# @see Increase::Models::EntityCreateParams::NaturalPerson#address
|
|
1289
1351
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -1325,9 +1387,6 @@ module Increase
|
|
|
1325
1387
|
optional :zip, String
|
|
1326
1388
|
|
|
1327
1389
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
1328
|
-
# Some parameter documentations has been truncated, see
|
|
1329
|
-
# {Increase::Models::EntityCreateParams::NaturalPerson::Address} for more details.
|
|
1330
|
-
#
|
|
1331
1390
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1332
1391
|
# PMB's are disallowed.
|
|
1333
1392
|
#
|
|
@@ -1339,7 +1398,9 @@ module Increase
|
|
|
1339
1398
|
#
|
|
1340
1399
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
1341
1400
|
#
|
|
1342
|
-
# @param state [String]
|
|
1401
|
+
# @param state [String]
|
|
1402
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1403
|
+
# state, province, or region of the address. Required in certain countries.
|
|
1343
1404
|
#
|
|
1344
1405
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
1345
1406
|
end
|
|
@@ -1387,21 +1448,29 @@ module Increase
|
|
|
1387
1448
|
optional :passport, -> { Increase::EntityCreateParams::NaturalPerson::Identification::Passport }
|
|
1388
1449
|
|
|
1389
1450
|
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
1390
|
-
# Some parameter documentations has been truncated, see
|
|
1391
|
-
# {Increase::Models::EntityCreateParams::NaturalPerson::Identification} for more
|
|
1392
|
-
# details.
|
|
1393
|
-
#
|
|
1394
1451
|
# A means of verifying the person's identity.
|
|
1395
1452
|
#
|
|
1396
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method]
|
|
1453
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method]
|
|
1454
|
+
# A method that can be used to verify the individual's identity.
|
|
1397
1455
|
#
|
|
1398
|
-
# @param number [String]
|
|
1456
|
+
# @param number [String]
|
|
1457
|
+
# An identification number that can be used to verify the individual's identity,
|
|
1458
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
1459
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
1460
|
+
# separators. When testing in sandbox, use one of our
|
|
1461
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
1399
1462
|
#
|
|
1400
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense]
|
|
1463
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense]
|
|
1464
|
+
# Information about the United States driver's license used for identification.
|
|
1465
|
+
# Required if `method` is equal to `drivers_license`.
|
|
1401
1466
|
#
|
|
1402
|
-
# @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other]
|
|
1467
|
+
# @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other]
|
|
1468
|
+
# Information about the identification document provided. Required if `method` is
|
|
1469
|
+
# equal to `other`.
|
|
1403
1470
|
#
|
|
1404
|
-
# @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport]
|
|
1471
|
+
# @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport]
|
|
1472
|
+
# Information about the passport used for identification. Required if `method` is
|
|
1473
|
+
# equal to `passport`.
|
|
1405
1474
|
|
|
1406
1475
|
# A method that can be used to verify the individual's identity.
|
|
1407
1476
|
#
|
|
@@ -1502,20 +1571,20 @@ module Increase
|
|
|
1502
1571
|
optional :expiration_date, Date
|
|
1503
1572
|
|
|
1504
1573
|
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
1505
|
-
# Some parameter documentations has been truncated, see
|
|
1506
|
-
# {Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other} for
|
|
1507
|
-
# more details.
|
|
1508
|
-
#
|
|
1509
1574
|
# Information about the identification document provided. Required if `method` is
|
|
1510
1575
|
# equal to `other`.
|
|
1511
1576
|
#
|
|
1512
|
-
# @param country [String]
|
|
1577
|
+
# @param country [String]
|
|
1578
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1579
|
+
# document (e.g., `US`).
|
|
1513
1580
|
#
|
|
1514
1581
|
# @param description [String] A description of the document submitted.
|
|
1515
1582
|
#
|
|
1516
1583
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
1517
1584
|
#
|
|
1518
|
-
# @param back_file_id [String]
|
|
1585
|
+
# @param back_file_id [String]
|
|
1586
|
+
# The identifier of the File containing the back of the document. Not every
|
|
1587
|
+
# document has a reverse side.
|
|
1519
1588
|
#
|
|
1520
1589
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
1521
1590
|
end
|
|
@@ -1542,14 +1611,12 @@ module Increase
|
|
|
1542
1611
|
required :file_id, String
|
|
1543
1612
|
|
|
1544
1613
|
# @!method initialize(country:, expiration_date:, file_id:)
|
|
1545
|
-
# Some parameter documentations has been truncated, see
|
|
1546
|
-
# {Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport}
|
|
1547
|
-
# for more details.
|
|
1548
|
-
#
|
|
1549
1614
|
# Information about the passport used for identification. Required if `method` is
|
|
1550
1615
|
# equal to `passport`.
|
|
1551
1616
|
#
|
|
1552
|
-
# @param country [String]
|
|
1617
|
+
# @param country [String]
|
|
1618
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1619
|
+
# document (e.g., `US`).
|
|
1553
1620
|
#
|
|
1554
1621
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
1555
1622
|
#
|
|
@@ -1573,15 +1640,15 @@ module Increase
|
|
|
1573
1640
|
required :rating, enum: -> { Increase::EntityCreateParams::RiskRating::Rating }
|
|
1574
1641
|
|
|
1575
1642
|
# @!method initialize(rated_at:, rating:)
|
|
1576
|
-
# Some parameter documentations has been truncated, see
|
|
1577
|
-
# {Increase::Models::EntityCreateParams::RiskRating} for more details.
|
|
1578
|
-
#
|
|
1579
1643
|
# An assessment of the entity's potential risk of involvement in financial crimes,
|
|
1580
1644
|
# such as money laundering.
|
|
1581
1645
|
#
|
|
1582
|
-
# @param rated_at [Time]
|
|
1646
|
+
# @param rated_at [Time]
|
|
1647
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
|
1648
|
+
# rating was performed.
|
|
1583
1649
|
#
|
|
1584
|
-
# @param rating [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
|
|
1650
|
+
# @param rating [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
|
|
1651
|
+
# The rating given to this entity.
|
|
1585
1652
|
|
|
1586
1653
|
# The rating given to this entity.
|
|
1587
1654
|
#
|
|
@@ -1634,9 +1701,6 @@ module Increase
|
|
|
1634
1701
|
required :terms_url, String
|
|
1635
1702
|
|
|
1636
1703
|
# @!method initialize(agreed_at:, ip_address:, terms_url:)
|
|
1637
|
-
# Some parameter documentations has been truncated, see
|
|
1638
|
-
# {Increase::Models::EntityCreateParams::TermsAgreement} for more details.
|
|
1639
|
-
#
|
|
1640
1704
|
# @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
|
|
1641
1705
|
#
|
|
1642
1706
|
# @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
|
|
@@ -1664,7 +1728,8 @@ module Increase
|
|
|
1664
1728
|
#
|
|
1665
1729
|
# @param reference [String] The reference identifier for the third party verification.
|
|
1666
1730
|
#
|
|
1667
|
-
# @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor]
|
|
1731
|
+
# @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor]
|
|
1732
|
+
# The vendor that was used to perform the verification.
|
|
1668
1733
|
|
|
1669
1734
|
# The vendor that was used to perform the verification.
|
|
1670
1735
|
#
|
|
@@ -1747,27 +1812,35 @@ module Increase
|
|
|
1747
1812
|
optional :tax_identifier, String
|
|
1748
1813
|
|
|
1749
1814
|
# @!method initialize(address:, category:, name:, trustees:, formation_document_file_id: nil, formation_state: nil, grantor: nil, tax_identifier: nil)
|
|
1750
|
-
# Some parameter documentations has been truncated, see
|
|
1751
|
-
# {Increase::Models::EntityCreateParams::Trust} for more details.
|
|
1752
|
-
#
|
|
1753
1815
|
# Details of the trust entity to create. Required if `structure` is equal to
|
|
1754
1816
|
# `trust`.
|
|
1755
1817
|
#
|
|
1756
|
-
# @param address [Increase::Models::EntityCreateParams::Trust::Address]
|
|
1818
|
+
# @param address [Increase::Models::EntityCreateParams::Trust::Address]
|
|
1819
|
+
# The trust's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
1820
|
+
# are disallowed.
|
|
1757
1821
|
#
|
|
1758
|
-
# @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category]
|
|
1822
|
+
# @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category]
|
|
1823
|
+
# Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
|
|
1824
|
+
# their own Employer Identification Number. Revocable trusts require information
|
|
1825
|
+
# about the individual `grantor` who created the trust.
|
|
1759
1826
|
#
|
|
1760
1827
|
# @param name [String] The legal name of the trust.
|
|
1761
1828
|
#
|
|
1762
1829
|
# @param trustees [Array<Increase::Models::EntityCreateParams::Trust::Trustee>] The trustees of the trust.
|
|
1763
1830
|
#
|
|
1764
|
-
# @param formation_document_file_id [String]
|
|
1831
|
+
# @param formation_document_file_id [String]
|
|
1832
|
+
# The identifier of the File containing the formation document of the trust.
|
|
1765
1833
|
#
|
|
1766
|
-
# @param formation_state [String]
|
|
1834
|
+
# @param formation_state [String]
|
|
1835
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state in
|
|
1836
|
+
# which the trust was formed.
|
|
1767
1837
|
#
|
|
1768
|
-
# @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor]
|
|
1838
|
+
# @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor]
|
|
1839
|
+
# The grantor of the trust. Required if `category` is equal to `revocable`.
|
|
1769
1840
|
#
|
|
1770
|
-
# @param tax_identifier [String]
|
|
1841
|
+
# @param tax_identifier [String]
|
|
1842
|
+
# The Employer Identification Number (EIN) for the trust. Submit nine digits with
|
|
1843
|
+
# no dashes or other separators. Required if `category` is equal to `irrevocable`.
|
|
1771
1844
|
|
|
1772
1845
|
# @see Increase::Models::EntityCreateParams::Trust#address
|
|
1773
1846
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -1803,9 +1876,6 @@ module Increase
|
|
|
1803
1876
|
optional :line2, String
|
|
1804
1877
|
|
|
1805
1878
|
# @!method initialize(city:, line1:, state:, zip:, line2: nil)
|
|
1806
|
-
# Some parameter documentations has been truncated, see
|
|
1807
|
-
# {Increase::Models::EntityCreateParams::Trust::Address} for more details.
|
|
1808
|
-
#
|
|
1809
1879
|
# The trust's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
1810
1880
|
# are disallowed.
|
|
1811
1881
|
#
|
|
@@ -1813,7 +1883,9 @@ module Increase
|
|
|
1813
1883
|
#
|
|
1814
1884
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
1815
1885
|
#
|
|
1816
|
-
# @param state [String]
|
|
1886
|
+
# @param state [String]
|
|
1887
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
1888
|
+
# the address.
|
|
1817
1889
|
#
|
|
1818
1890
|
# @param zip [String] The ZIP code of the address.
|
|
1819
1891
|
#
|
|
@@ -1853,12 +1925,12 @@ module Increase
|
|
|
1853
1925
|
optional :individual, -> { Increase::EntityCreateParams::Trust::Trustee::Individual }
|
|
1854
1926
|
|
|
1855
1927
|
# @!method initialize(structure:, individual: nil)
|
|
1856
|
-
#
|
|
1857
|
-
#
|
|
1928
|
+
# @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure]
|
|
1929
|
+
# The structure of the trustee.
|
|
1858
1930
|
#
|
|
1859
|
-
# @param
|
|
1860
|
-
#
|
|
1861
|
-
#
|
|
1931
|
+
# @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual]
|
|
1932
|
+
# Details of the individual trustee. Within the trustee object, this is required
|
|
1933
|
+
# if `structure` is equal to `individual`.
|
|
1862
1934
|
|
|
1863
1935
|
# The structure of the trustee.
|
|
1864
1936
|
#
|
|
@@ -1910,22 +1982,25 @@ module Increase
|
|
|
1910
1982
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
1911
1983
|
|
|
1912
1984
|
# @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
|
|
1913
|
-
# Some parameter documentations has been truncated, see
|
|
1914
|
-
# {Increase::Models::EntityCreateParams::Trust::Trustee::Individual} for more
|
|
1915
|
-
# details.
|
|
1916
|
-
#
|
|
1917
1985
|
# Details of the individual trustee. Within the trustee object, this is required
|
|
1918
1986
|
# if `structure` is equal to `individual`.
|
|
1919
1987
|
#
|
|
1920
|
-
# @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address]
|
|
1988
|
+
# @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address]
|
|
1989
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1990
|
+
# PMB's are disallowed.
|
|
1921
1991
|
#
|
|
1922
1992
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
1923
1993
|
#
|
|
1924
|
-
# @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification]
|
|
1994
|
+
# @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification]
|
|
1995
|
+
# A means of verifying the person's identity.
|
|
1925
1996
|
#
|
|
1926
1997
|
# @param name [String] The person's legal name.
|
|
1927
1998
|
#
|
|
1928
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
1999
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
2000
|
+
# The identification method for an individual can only be a passport, driver's
|
|
2001
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
2002
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
2003
|
+
# Number).
|
|
1929
2004
|
|
|
1930
2005
|
# @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#address
|
|
1931
2006
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -1967,10 +2042,6 @@ module Increase
|
|
|
1967
2042
|
optional :zip, String
|
|
1968
2043
|
|
|
1969
2044
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
1970
|
-
# Some parameter documentations has been truncated, see
|
|
1971
|
-
# {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address} for
|
|
1972
|
-
# more details.
|
|
1973
|
-
#
|
|
1974
2045
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1975
2046
|
# PMB's are disallowed.
|
|
1976
2047
|
#
|
|
@@ -1982,7 +2053,9 @@ module Increase
|
|
|
1982
2053
|
#
|
|
1983
2054
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
1984
2055
|
#
|
|
1985
|
-
# @param state [String]
|
|
2056
|
+
# @param state [String]
|
|
2057
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
2058
|
+
# state, province, or region of the address. Required in certain countries.
|
|
1986
2059
|
#
|
|
1987
2060
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
1988
2061
|
end
|
|
@@ -2033,21 +2106,29 @@ module Increase
|
|
|
2033
2106
|
-> { Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport }
|
|
2034
2107
|
|
|
2035
2108
|
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
2036
|
-
# Some parameter documentations has been truncated, see
|
|
2037
|
-
# {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification}
|
|
2038
|
-
# for more details.
|
|
2039
|
-
#
|
|
2040
2109
|
# A means of verifying the person's identity.
|
|
2041
2110
|
#
|
|
2042
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method]
|
|
2111
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method]
|
|
2112
|
+
# A method that can be used to verify the individual's identity.
|
|
2043
2113
|
#
|
|
2044
|
-
# @param number [String]
|
|
2114
|
+
# @param number [String]
|
|
2115
|
+
# An identification number that can be used to verify the individual's identity,
|
|
2116
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
2117
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
2118
|
+
# separators. When testing in sandbox, use one of our
|
|
2119
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
2045
2120
|
#
|
|
2046
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense]
|
|
2121
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense]
|
|
2122
|
+
# Information about the United States driver's license used for identification.
|
|
2123
|
+
# Required if `method` is equal to `drivers_license`.
|
|
2047
2124
|
#
|
|
2048
|
-
# @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other]
|
|
2125
|
+
# @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other]
|
|
2126
|
+
# Information about the identification document provided. Required if `method` is
|
|
2127
|
+
# equal to `other`.
|
|
2049
2128
|
#
|
|
2050
|
-
# @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport]
|
|
2129
|
+
# @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport]
|
|
2130
|
+
# Information about the passport used for identification. Required if `method` is
|
|
2131
|
+
# equal to `passport`.
|
|
2051
2132
|
|
|
2052
2133
|
# A method that can be used to verify the individual's identity.
|
|
2053
2134
|
#
|
|
@@ -2148,20 +2229,20 @@ module Increase
|
|
|
2148
2229
|
optional :expiration_date, Date
|
|
2149
2230
|
|
|
2150
2231
|
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
2151
|
-
# Some parameter documentations has been truncated, see
|
|
2152
|
-
# {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other}
|
|
2153
|
-
# for more details.
|
|
2154
|
-
#
|
|
2155
2232
|
# Information about the identification document provided. Required if `method` is
|
|
2156
2233
|
# equal to `other`.
|
|
2157
2234
|
#
|
|
2158
|
-
# @param country [String]
|
|
2235
|
+
# @param country [String]
|
|
2236
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2237
|
+
# document (e.g., `US`).
|
|
2159
2238
|
#
|
|
2160
2239
|
# @param description [String] A description of the document submitted.
|
|
2161
2240
|
#
|
|
2162
2241
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
2163
2242
|
#
|
|
2164
|
-
# @param back_file_id [String]
|
|
2243
|
+
# @param back_file_id [String]
|
|
2244
|
+
# The identifier of the File containing the back of the document. Not every
|
|
2245
|
+
# document has a reverse side.
|
|
2165
2246
|
#
|
|
2166
2247
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
2167
2248
|
end
|
|
@@ -2188,14 +2269,12 @@ module Increase
|
|
|
2188
2269
|
required :file_id, String
|
|
2189
2270
|
|
|
2190
2271
|
# @!method initialize(country:, expiration_date:, file_id:)
|
|
2191
|
-
# Some parameter documentations has been truncated, see
|
|
2192
|
-
# {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport}
|
|
2193
|
-
# for more details.
|
|
2194
|
-
#
|
|
2195
2272
|
# Information about the passport used for identification. Required if `method` is
|
|
2196
2273
|
# equal to `passport`.
|
|
2197
2274
|
#
|
|
2198
|
-
# @param country [String]
|
|
2275
|
+
# @param country [String]
|
|
2276
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2277
|
+
# document (e.g., `US`).
|
|
2199
2278
|
#
|
|
2200
2279
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
2201
2280
|
#
|
|
@@ -2242,20 +2321,24 @@ module Increase
|
|
|
2242
2321
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
2243
2322
|
|
|
2244
2323
|
# @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
|
|
2245
|
-
# Some parameter documentations has been truncated, see
|
|
2246
|
-
# {Increase::Models::EntityCreateParams::Trust::Grantor} for more details.
|
|
2247
|
-
#
|
|
2248
2324
|
# The grantor of the trust. Required if `category` is equal to `revocable`.
|
|
2249
2325
|
#
|
|
2250
|
-
# @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address]
|
|
2326
|
+
# @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address]
|
|
2327
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
2328
|
+
# PMB's are disallowed.
|
|
2251
2329
|
#
|
|
2252
2330
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
2253
2331
|
#
|
|
2254
|
-
# @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification]
|
|
2332
|
+
# @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification]
|
|
2333
|
+
# A means of verifying the person's identity.
|
|
2255
2334
|
#
|
|
2256
2335
|
# @param name [String] The person's legal name.
|
|
2257
2336
|
#
|
|
2258
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
2337
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
2338
|
+
# The identification method for an individual can only be a passport, driver's
|
|
2339
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
2340
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
2341
|
+
# Number).
|
|
2259
2342
|
|
|
2260
2343
|
# @see Increase::Models::EntityCreateParams::Trust::Grantor#address
|
|
2261
2344
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -2297,10 +2380,6 @@ module Increase
|
|
|
2297
2380
|
optional :zip, String
|
|
2298
2381
|
|
|
2299
2382
|
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
2300
|
-
# Some parameter documentations has been truncated, see
|
|
2301
|
-
# {Increase::Models::EntityCreateParams::Trust::Grantor::Address} for more
|
|
2302
|
-
# details.
|
|
2303
|
-
#
|
|
2304
2383
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
2305
2384
|
# PMB's are disallowed.
|
|
2306
2385
|
#
|
|
@@ -2312,7 +2391,9 @@ module Increase
|
|
|
2312
2391
|
#
|
|
2313
2392
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
2314
2393
|
#
|
|
2315
|
-
# @param state [String]
|
|
2394
|
+
# @param state [String]
|
|
2395
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
2396
|
+
# state, province, or region of the address. Required in certain countries.
|
|
2316
2397
|
#
|
|
2317
2398
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
2318
2399
|
end
|
|
@@ -2360,21 +2441,29 @@ module Increase
|
|
|
2360
2441
|
optional :passport, -> { Increase::EntityCreateParams::Trust::Grantor::Identification::Passport }
|
|
2361
2442
|
|
|
2362
2443
|
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
2363
|
-
# Some parameter documentations has been truncated, see
|
|
2364
|
-
# {Increase::Models::EntityCreateParams::Trust::Grantor::Identification} for more
|
|
2365
|
-
# details.
|
|
2366
|
-
#
|
|
2367
2444
|
# A means of verifying the person's identity.
|
|
2368
2445
|
#
|
|
2369
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method]
|
|
2446
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method]
|
|
2447
|
+
# A method that can be used to verify the individual's identity.
|
|
2370
2448
|
#
|
|
2371
|
-
# @param number [String]
|
|
2449
|
+
# @param number [String]
|
|
2450
|
+
# An identification number that can be used to verify the individual's identity,
|
|
2451
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
2452
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
2453
|
+
# separators. When testing in sandbox, use one of our
|
|
2454
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
2372
2455
|
#
|
|
2373
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense]
|
|
2456
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense]
|
|
2457
|
+
# Information about the United States driver's license used for identification.
|
|
2458
|
+
# Required if `method` is equal to `drivers_license`.
|
|
2374
2459
|
#
|
|
2375
|
-
# @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other]
|
|
2460
|
+
# @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other]
|
|
2461
|
+
# Information about the identification document provided. Required if `method` is
|
|
2462
|
+
# equal to `other`.
|
|
2376
2463
|
#
|
|
2377
|
-
# @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport]
|
|
2464
|
+
# @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport]
|
|
2465
|
+
# Information about the passport used for identification. Required if `method` is
|
|
2466
|
+
# equal to `passport`.
|
|
2378
2467
|
|
|
2379
2468
|
# A method that can be used to verify the individual's identity.
|
|
2380
2469
|
#
|
|
@@ -2475,20 +2564,20 @@ module Increase
|
|
|
2475
2564
|
optional :expiration_date, Date
|
|
2476
2565
|
|
|
2477
2566
|
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
2478
|
-
# Some parameter documentations has been truncated, see
|
|
2479
|
-
# {Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other}
|
|
2480
|
-
# for more details.
|
|
2481
|
-
#
|
|
2482
2567
|
# Information about the identification document provided. Required if `method` is
|
|
2483
2568
|
# equal to `other`.
|
|
2484
2569
|
#
|
|
2485
|
-
# @param country [String]
|
|
2570
|
+
# @param country [String]
|
|
2571
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2572
|
+
# document (e.g., `US`).
|
|
2486
2573
|
#
|
|
2487
2574
|
# @param description [String] A description of the document submitted.
|
|
2488
2575
|
#
|
|
2489
2576
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
2490
2577
|
#
|
|
2491
|
-
# @param back_file_id [String]
|
|
2578
|
+
# @param back_file_id [String]
|
|
2579
|
+
# The identifier of the File containing the back of the document. Not every
|
|
2580
|
+
# document has a reverse side.
|
|
2492
2581
|
#
|
|
2493
2582
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
2494
2583
|
end
|
|
@@ -2515,14 +2604,12 @@ module Increase
|
|
|
2515
2604
|
required :file_id, String
|
|
2516
2605
|
|
|
2517
2606
|
# @!method initialize(country:, expiration_date:, file_id:)
|
|
2518
|
-
# Some parameter documentations has been truncated, see
|
|
2519
|
-
# {Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport}
|
|
2520
|
-
# for more details.
|
|
2521
|
-
#
|
|
2522
2607
|
# Information about the passport used for identification. Required if `method` is
|
|
2523
2608
|
# equal to `passport`.
|
|
2524
2609
|
#
|
|
2525
|
-
# @param country [String]
|
|
2610
|
+
# @param country [String]
|
|
2611
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2612
|
+
# document (e.g., `US`).
|
|
2526
2613
|
#
|
|
2527
2614
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
2528
2615
|
#
|