increase 1.340.0 → 1.342.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 +49 -28
- 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 +220 -105
- 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 +60 -46
- data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
- data/lib/increase/models/beneficial_owner_update_params.rb +56 -40
- 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 -76
- 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 +395 -290
- 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 +136 -104
- data/lib/increase/models/event.rb +14 -5
- data/lib/increase/models/event_list_params.rb +31 -17
- data/lib/increase/models/event_subscription.rb +25 -9
- data/lib/increase/models/event_subscription_create_params.rb +22 -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 +51 -22
- 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 +18 -6
- 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 +16 -13
- 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 -5
- 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 +60 -27
- data/lib/increase/models/swift_transfer_create_params.rb +40 -20
- data/lib/increase/models/swift_transfer_list_params.rb +23 -16
- data/lib/increase/models/transaction.rb +1016 -536
- data/lib/increase/models/transaction_list_params.rb +21 -16
- data/lib/increase/models/unwrap_webhook_event.rb +14 -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 +18 -15
- 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 +8 -6
- 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 +33 -17
- 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/ach_prenotification.rbi +1 -1
- data/rbi/increase/models/ach_transfer.rbi +19 -1
- data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
- data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
- data/rbi/increase/models/check_transfer.rbi +12 -2
- data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
- data/rbi/increase/models/entity_create_params.rbi +78 -48
- data/rbi/increase/models/entity_list_params.rbi +119 -0
- data/rbi/increase/models/entity_update_params.rbi +26 -16
- data/rbi/increase/models/event.rbi +14 -0
- data/rbi/increase/models/event_list_params.rbi +14 -0
- data/rbi/increase/models/event_subscription.rbi +14 -0
- data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
- data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
- data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
- data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
- data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
- data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
- data/rbi/increase/models/swift_transfer.rbi +10 -0
- data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
- data/rbi/increase/models/transaction.rbi +19 -1
- data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
- data/rbi/increase/resources/entities.rbi +3 -0
- data/rbi/increase/resources/pending_transactions.rbi +2 -2
- data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
- data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
- data/rbi/increase/resources/swift_transfers.rbi +4 -0
- data/sig/increase/models/ach_prenotification.rbs +1 -1
- data/sig/increase/models/ach_transfer.rbs +6 -1
- data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
- data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
- 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_create_params.rbs +42 -30
- data/sig/increase/models/entity_list_params.rbs +48 -1
- data/sig/increase/models/entity_update_params.rbs +14 -10
- data/sig/increase/models/event.rbs +8 -0
- data/sig/increase/models/event_list_params.rbs +8 -0
- data/sig/increase/models/event_subscription.rbs +8 -0
- data/sig/increase/models/event_subscription_create_params.rbs +8 -0
- data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
- data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
- data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
- data/sig/increase/models/simulations/program_create_params.rbs +1 -8
- data/sig/increase/models/swift_transfer.rbs +5 -0
- data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
- data/sig/increase/models/transaction.rbs +6 -1
- data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
- data/sig/increase/resources/entities.rbs +1 -0
- data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
- data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
- data/sig/increase/resources/swift_transfers.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
|
|
@@ -243,18 +281,19 @@ module Increase
|
|
|
243
281
|
# @return [String]
|
|
244
282
|
required :city, String
|
|
245
283
|
|
|
246
|
-
# @!attribute country
|
|
247
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
248
|
-
#
|
|
249
|
-
# @return [String]
|
|
250
|
-
required :country, String
|
|
251
|
-
|
|
252
284
|
# @!attribute line1
|
|
253
285
|
# The first line of the address. This is usually the street number and street.
|
|
254
286
|
#
|
|
255
287
|
# @return [String]
|
|
256
288
|
required :line1, String
|
|
257
289
|
|
|
290
|
+
# @!attribute country
|
|
291
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
292
|
+
# to `US`.
|
|
293
|
+
#
|
|
294
|
+
# @return [String, nil]
|
|
295
|
+
optional :country, String
|
|
296
|
+
|
|
258
297
|
# @!attribute line2
|
|
259
298
|
# The second line of the address. This might be the floor or room number.
|
|
260
299
|
#
|
|
@@ -274,22 +313,23 @@ module Increase
|
|
|
274
313
|
# @return [String, nil]
|
|
275
314
|
optional :zip, String
|
|
276
315
|
|
|
277
|
-
# @!method initialize(city:,
|
|
278
|
-
# Some parameter documentations has been truncated, see
|
|
279
|
-
# {Increase::Models::EntityCreateParams::Corporation::Address} for more details.
|
|
280
|
-
#
|
|
316
|
+
# @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
|
|
281
317
|
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
282
318
|
# are disallowed.
|
|
283
319
|
#
|
|
284
320
|
# @param city [String] The city, district, town, or village of the address.
|
|
285
321
|
#
|
|
286
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
287
|
-
#
|
|
288
322
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
289
323
|
#
|
|
324
|
+
# @param country [String]
|
|
325
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
326
|
+
# to `US`.
|
|
327
|
+
#
|
|
290
328
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
291
329
|
#
|
|
292
|
-
# @param state [String]
|
|
330
|
+
# @param state [String]
|
|
331
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
332
|
+
# state, province, or region of the address. Required in certain countries.
|
|
293
333
|
#
|
|
294
334
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
295
335
|
end
|
|
@@ -317,13 +357,13 @@ module Increase
|
|
|
317
357
|
optional :company_title, String
|
|
318
358
|
|
|
319
359
|
# @!method initialize(individual:, prongs:, company_title: nil)
|
|
320
|
-
#
|
|
321
|
-
#
|
|
322
|
-
# details.
|
|
360
|
+
# @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual]
|
|
361
|
+
# Personal details for the beneficial owner.
|
|
323
362
|
#
|
|
324
|
-
# @param
|
|
325
|
-
#
|
|
326
|
-
#
|
|
363
|
+
# @param prongs [Array<Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong>]
|
|
364
|
+
# Why this person is considered a beneficial owner of the entity. At least one
|
|
365
|
+
# option is required, if a person is both a control person and owner, submit an
|
|
366
|
+
# array containing both.
|
|
327
367
|
#
|
|
328
368
|
# @param company_title [String] This person's role or title within the entity.
|
|
329
369
|
|
|
@@ -365,21 +405,24 @@ module Increase
|
|
|
365
405
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
366
406
|
|
|
367
407
|
# @!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
408
|
# Personal details for the beneficial owner.
|
|
373
409
|
#
|
|
374
|
-
# @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address]
|
|
410
|
+
# @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address]
|
|
411
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
412
|
+
# PMB's are disallowed.
|
|
375
413
|
#
|
|
376
414
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
377
415
|
#
|
|
378
|
-
# @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification]
|
|
416
|
+
# @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification]
|
|
417
|
+
# A means of verifying the person's identity.
|
|
379
418
|
#
|
|
380
419
|
# @param name [String] The person's legal name.
|
|
381
420
|
#
|
|
382
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
421
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
422
|
+
# The identification method for an individual can only be a passport, driver's
|
|
423
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
424
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
425
|
+
# Number).
|
|
383
426
|
|
|
384
427
|
# @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#address
|
|
385
428
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -389,18 +432,19 @@ module Increase
|
|
|
389
432
|
# @return [String]
|
|
390
433
|
required :city, String
|
|
391
434
|
|
|
392
|
-
# @!attribute country
|
|
393
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
394
|
-
#
|
|
395
|
-
# @return [String]
|
|
396
|
-
required :country, String
|
|
397
|
-
|
|
398
435
|
# @!attribute line1
|
|
399
436
|
# The first line of the address. This is usually the street number and street.
|
|
400
437
|
#
|
|
401
438
|
# @return [String]
|
|
402
439
|
required :line1, String
|
|
403
440
|
|
|
441
|
+
# @!attribute country
|
|
442
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
443
|
+
# to `US`.
|
|
444
|
+
#
|
|
445
|
+
# @return [String, nil]
|
|
446
|
+
optional :country, String
|
|
447
|
+
|
|
404
448
|
# @!attribute line2
|
|
405
449
|
# The second line of the address. This might be the floor or room number.
|
|
406
450
|
#
|
|
@@ -420,23 +464,23 @@ module Increase
|
|
|
420
464
|
# @return [String, nil]
|
|
421
465
|
optional :zip, String
|
|
422
466
|
|
|
423
|
-
# @!method initialize(city:,
|
|
424
|
-
# Some parameter documentations has been truncated, see
|
|
425
|
-
# {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address}
|
|
426
|
-
# for more details.
|
|
427
|
-
#
|
|
467
|
+
# @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
|
|
428
468
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
429
469
|
# PMB's are disallowed.
|
|
430
470
|
#
|
|
431
471
|
# @param city [String] The city, district, town, or village of the address.
|
|
432
472
|
#
|
|
433
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
434
|
-
#
|
|
435
473
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
436
474
|
#
|
|
475
|
+
# @param country [String]
|
|
476
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
477
|
+
# to `US`.
|
|
478
|
+
#
|
|
437
479
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
438
480
|
#
|
|
439
|
-
# @param state [String]
|
|
481
|
+
# @param state [String]
|
|
482
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
483
|
+
# state, province, or region of the address. Required in certain countries.
|
|
440
484
|
#
|
|
441
485
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
442
486
|
end
|
|
@@ -488,21 +532,29 @@ module Increase
|
|
|
488
532
|
-> { Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport }
|
|
489
533
|
|
|
490
534
|
# @!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
535
|
# A means of verifying the person's identity.
|
|
496
536
|
#
|
|
497
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
537
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method]
|
|
538
|
+
# A method that can be used to verify the individual's identity.
|
|
498
539
|
#
|
|
499
|
-
# @param number [String]
|
|
540
|
+
# @param number [String]
|
|
541
|
+
# An identification number that can be used to verify the individual's identity,
|
|
542
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
543
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
544
|
+
# separators. When testing in sandbox, use one of our
|
|
545
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
500
546
|
#
|
|
501
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense]
|
|
547
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense]
|
|
548
|
+
# Information about the United States driver's license used for identification.
|
|
549
|
+
# Required if `method` is equal to `drivers_license`.
|
|
502
550
|
#
|
|
503
|
-
# @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other]
|
|
551
|
+
# @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other]
|
|
552
|
+
# Information about the identification document provided. Required if `method` is
|
|
553
|
+
# equal to `other`.
|
|
504
554
|
#
|
|
505
|
-
# @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport]
|
|
555
|
+
# @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport]
|
|
556
|
+
# Information about the passport used for identification. Required if `method` is
|
|
557
|
+
# equal to `passport`.
|
|
506
558
|
|
|
507
559
|
# A method that can be used to verify the individual's identity.
|
|
508
560
|
#
|
|
@@ -603,20 +655,20 @@ module Increase
|
|
|
603
655
|
optional :expiration_date, Date
|
|
604
656
|
|
|
605
657
|
# @!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
658
|
# Information about the identification document provided. Required if `method` is
|
|
611
659
|
# equal to `other`.
|
|
612
660
|
#
|
|
613
|
-
# @param country [String]
|
|
661
|
+
# @param country [String]
|
|
662
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
663
|
+
# document (e.g., `US`).
|
|
614
664
|
#
|
|
615
665
|
# @param description [String] A description of the document submitted.
|
|
616
666
|
#
|
|
617
667
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
618
668
|
#
|
|
619
|
-
# @param back_file_id [String]
|
|
669
|
+
# @param back_file_id [String]
|
|
670
|
+
# The identifier of the File containing the back of the document. Not every
|
|
671
|
+
# document has a reverse side.
|
|
620
672
|
#
|
|
621
673
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
622
674
|
end
|
|
@@ -643,14 +695,12 @@ module Increase
|
|
|
643
695
|
required :file_id, String
|
|
644
696
|
|
|
645
697
|
# @!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
698
|
# Information about the passport used for identification. Required if `method` is
|
|
651
699
|
# equal to `passport`.
|
|
652
700
|
#
|
|
653
|
-
# @param country [String]
|
|
701
|
+
# @param country [String]
|
|
702
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
703
|
+
# document (e.g., `US`).
|
|
654
704
|
#
|
|
655
705
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
656
706
|
#
|
|
@@ -692,17 +742,19 @@ module Increase
|
|
|
692
742
|
optional :category, enum: -> { Increase::EntityCreateParams::Corporation::LegalIdentifier::Category }
|
|
693
743
|
|
|
694
744
|
# @!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
745
|
# The legal identifier of the corporation. This is usually the Employer
|
|
700
746
|
# Identification Number (EIN). This replaces the deprecated `tax_identifier`
|
|
701
747
|
# field.
|
|
702
748
|
#
|
|
703
|
-
# @param value [String]
|
|
749
|
+
# @param value [String]
|
|
750
|
+
# The legal identifier itself. For US Employer Identification Numbers, submit nine
|
|
751
|
+
# digits with no dashes or other separators. When testing in sandbox, use one of
|
|
752
|
+
# our
|
|
753
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
704
754
|
#
|
|
705
|
-
# @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category]
|
|
755
|
+
# @param category [Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category]
|
|
756
|
+
# The category of the legal identifier. If not provided, the default is
|
|
757
|
+
# `us_employer_identification_number`.
|
|
706
758
|
|
|
707
759
|
# The category of the legal identifier. If not provided, the default is
|
|
708
760
|
# `us_employer_identification_number`.
|
|
@@ -789,23 +841,28 @@ module Increase
|
|
|
789
841
|
optional :website, String
|
|
790
842
|
|
|
791
843
|
# @!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
844
|
# Details of the Government Authority entity to create. Required if `structure` is
|
|
796
845
|
# equal to `government_authority`.
|
|
797
846
|
#
|
|
798
|
-
# @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address]
|
|
847
|
+
# @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address]
|
|
848
|
+
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
849
|
+
# are disallowed.
|
|
799
850
|
#
|
|
800
|
-
# @param authorized_persons [Array<Increase::Models::EntityCreateParams::GovernmentAuthority::AuthorizedPerson>]
|
|
851
|
+
# @param authorized_persons [Array<Increase::Models::EntityCreateParams::GovernmentAuthority::AuthorizedPerson>]
|
|
852
|
+
# The identifying details of authorized officials acting on the entity's behalf.
|
|
801
853
|
#
|
|
802
|
-
# @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category]
|
|
854
|
+
# @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category]
|
|
855
|
+
# The category of the government authority.
|
|
803
856
|
#
|
|
804
857
|
# @param name [String] The legal name of the government authority.
|
|
805
858
|
#
|
|
806
|
-
# @param tax_identifier [String]
|
|
859
|
+
# @param tax_identifier [String]
|
|
860
|
+
# The Employer Identification Number (EIN) for the government authority. Submit
|
|
861
|
+
# nine digits with no dashes or other separators.
|
|
807
862
|
#
|
|
808
|
-
# @param website [String]
|
|
863
|
+
# @param website [String]
|
|
864
|
+
# A website for the government authority. Not every program requires a website for
|
|
865
|
+
# submitted Entities.
|
|
809
866
|
|
|
810
867
|
# @see Increase::Models::EntityCreateParams::GovernmentAuthority#address
|
|
811
868
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -841,10 +898,6 @@ module Increase
|
|
|
841
898
|
optional :line2, String
|
|
842
899
|
|
|
843
900
|
# @!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
901
|
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
849
902
|
# are disallowed.
|
|
850
903
|
#
|
|
@@ -852,7 +905,9 @@ module Increase
|
|
|
852
905
|
#
|
|
853
906
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
854
907
|
#
|
|
855
|
-
# @param state [String]
|
|
908
|
+
# @param state [String]
|
|
909
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
910
|
+
# the address.
|
|
856
911
|
#
|
|
857
912
|
# @param zip [String] The ZIP code of the address.
|
|
858
913
|
#
|
|
@@ -905,7 +960,8 @@ module Increase
|
|
|
905
960
|
# Details of the joint entity to create. Required if `structure` is equal to
|
|
906
961
|
# `joint`.
|
|
907
962
|
#
|
|
908
|
-
# @param individuals [Array<Increase::Models::EntityCreateParams::Joint::Individual>]
|
|
963
|
+
# @param individuals [Array<Increase::Models::EntityCreateParams::Joint::Individual>]
|
|
964
|
+
# The two individuals that share control of the entity.
|
|
909
965
|
|
|
910
966
|
class Individual < Increase::Internal::Type::BaseModel
|
|
911
967
|
# @!attribute address
|
|
@@ -943,18 +999,22 @@ module Increase
|
|
|
943
999
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
944
1000
|
|
|
945
1001
|
# @!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
|
|
1002
|
+
# @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address]
|
|
1003
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1004
|
+
# PMB's are disallowed.
|
|
950
1005
|
#
|
|
951
1006
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
952
1007
|
#
|
|
953
|
-
# @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification]
|
|
1008
|
+
# @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification]
|
|
1009
|
+
# A means of verifying the person's identity.
|
|
954
1010
|
#
|
|
955
1011
|
# @param name [String] The person's legal name.
|
|
956
1012
|
#
|
|
957
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
1013
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
1014
|
+
# The identification method for an individual can only be a passport, driver's
|
|
1015
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
1016
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
1017
|
+
# Number).
|
|
958
1018
|
|
|
959
1019
|
# @see Increase::Models::EntityCreateParams::Joint::Individual#address
|
|
960
1020
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -964,18 +1024,19 @@ module Increase
|
|
|
964
1024
|
# @return [String]
|
|
965
1025
|
required :city, String
|
|
966
1026
|
|
|
967
|
-
# @!attribute country
|
|
968
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
969
|
-
#
|
|
970
|
-
# @return [String]
|
|
971
|
-
required :country, String
|
|
972
|
-
|
|
973
1027
|
# @!attribute line1
|
|
974
1028
|
# The first line of the address. This is usually the street number and street.
|
|
975
1029
|
#
|
|
976
1030
|
# @return [String]
|
|
977
1031
|
required :line1, String
|
|
978
1032
|
|
|
1033
|
+
# @!attribute country
|
|
1034
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
1035
|
+
# to `US`.
|
|
1036
|
+
#
|
|
1037
|
+
# @return [String, nil]
|
|
1038
|
+
optional :country, String
|
|
1039
|
+
|
|
979
1040
|
# @!attribute line2
|
|
980
1041
|
# The second line of the address. This might be the floor or room number.
|
|
981
1042
|
#
|
|
@@ -995,23 +1056,23 @@ module Increase
|
|
|
995
1056
|
# @return [String, nil]
|
|
996
1057
|
optional :zip, String
|
|
997
1058
|
|
|
998
|
-
# @!method initialize(city:,
|
|
999
|
-
# Some parameter documentations has been truncated, see
|
|
1000
|
-
# {Increase::Models::EntityCreateParams::Joint::Individual::Address} for more
|
|
1001
|
-
# details.
|
|
1002
|
-
#
|
|
1059
|
+
# @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
|
|
1003
1060
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1004
1061
|
# PMB's are disallowed.
|
|
1005
1062
|
#
|
|
1006
1063
|
# @param city [String] The city, district, town, or village of the address.
|
|
1007
1064
|
#
|
|
1008
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
1009
|
-
#
|
|
1010
1065
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
1011
1066
|
#
|
|
1067
|
+
# @param country [String]
|
|
1068
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
1069
|
+
# to `US`.
|
|
1070
|
+
#
|
|
1012
1071
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
1013
1072
|
#
|
|
1014
|
-
# @param state [String]
|
|
1073
|
+
# @param state [String]
|
|
1074
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1075
|
+
# state, province, or region of the address. Required in certain countries.
|
|
1015
1076
|
#
|
|
1016
1077
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
1017
1078
|
end
|
|
@@ -1059,21 +1120,29 @@ module Increase
|
|
|
1059
1120
|
optional :passport, -> { Increase::EntityCreateParams::Joint::Individual::Identification::Passport }
|
|
1060
1121
|
|
|
1061
1122
|
# @!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
1123
|
# A means of verifying the person's identity.
|
|
1067
1124
|
#
|
|
1068
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method]
|
|
1125
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method]
|
|
1126
|
+
# A method that can be used to verify the individual's identity.
|
|
1069
1127
|
#
|
|
1070
|
-
# @param number [String]
|
|
1128
|
+
# @param number [String]
|
|
1129
|
+
# An identification number that can be used to verify the individual's identity,
|
|
1130
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
1131
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
1132
|
+
# separators. When testing in sandbox, use one of our
|
|
1133
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
1071
1134
|
#
|
|
1072
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense]
|
|
1135
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense]
|
|
1136
|
+
# Information about the United States driver's license used for identification.
|
|
1137
|
+
# Required if `method` is equal to `drivers_license`.
|
|
1073
1138
|
#
|
|
1074
|
-
# @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other]
|
|
1139
|
+
# @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other]
|
|
1140
|
+
# Information about the identification document provided. Required if `method` is
|
|
1141
|
+
# equal to `other`.
|
|
1075
1142
|
#
|
|
1076
|
-
# @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport]
|
|
1143
|
+
# @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport]
|
|
1144
|
+
# Information about the passport used for identification. Required if `method` is
|
|
1145
|
+
# equal to `passport`.
|
|
1077
1146
|
|
|
1078
1147
|
# A method that can be used to verify the individual's identity.
|
|
1079
1148
|
#
|
|
@@ -1174,20 +1243,20 @@ module Increase
|
|
|
1174
1243
|
optional :expiration_date, Date
|
|
1175
1244
|
|
|
1176
1245
|
# @!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
1246
|
# Information about the identification document provided. Required if `method` is
|
|
1182
1247
|
# equal to `other`.
|
|
1183
1248
|
#
|
|
1184
|
-
# @param country [String]
|
|
1249
|
+
# @param country [String]
|
|
1250
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1251
|
+
# document (e.g., `US`).
|
|
1185
1252
|
#
|
|
1186
1253
|
# @param description [String] A description of the document submitted.
|
|
1187
1254
|
#
|
|
1188
1255
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
1189
1256
|
#
|
|
1190
|
-
# @param back_file_id [String]
|
|
1257
|
+
# @param back_file_id [String]
|
|
1258
|
+
# The identifier of the File containing the back of the document. Not every
|
|
1259
|
+
# document has a reverse side.
|
|
1191
1260
|
#
|
|
1192
1261
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
1193
1262
|
end
|
|
@@ -1214,14 +1283,12 @@ module Increase
|
|
|
1214
1283
|
required :file_id, String
|
|
1215
1284
|
|
|
1216
1285
|
# @!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
1286
|
# Information about the passport used for identification. Required if `method` is
|
|
1222
1287
|
# equal to `passport`.
|
|
1223
1288
|
#
|
|
1224
|
-
# @param country [String]
|
|
1289
|
+
# @param country [String]
|
|
1290
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1291
|
+
# document (e.g., `US`).
|
|
1225
1292
|
#
|
|
1226
1293
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
1227
1294
|
#
|
|
@@ -1267,23 +1334,27 @@ module Increase
|
|
|
1267
1334
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
1268
1335
|
|
|
1269
1336
|
# @!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
1337
|
# Details of the natural person entity to create. Required if `structure` is equal
|
|
1274
1338
|
# to `natural_person`. Natural people entities should be submitted with
|
|
1275
1339
|
# `social_security_number` or `individual_taxpayer_identification_number`
|
|
1276
1340
|
# identification methods.
|
|
1277
1341
|
#
|
|
1278
|
-
# @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address]
|
|
1342
|
+
# @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address]
|
|
1343
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1344
|
+
# PMB's are disallowed.
|
|
1279
1345
|
#
|
|
1280
1346
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
1281
1347
|
#
|
|
1282
|
-
# @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification]
|
|
1348
|
+
# @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification]
|
|
1349
|
+
# A means of verifying the person's identity.
|
|
1283
1350
|
#
|
|
1284
1351
|
# @param name [String] The person's legal name.
|
|
1285
1352
|
#
|
|
1286
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
1353
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
1354
|
+
# The identification method for an individual can only be a passport, driver's
|
|
1355
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
1356
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
1357
|
+
# Number).
|
|
1287
1358
|
|
|
1288
1359
|
# @see Increase::Models::EntityCreateParams::NaturalPerson#address
|
|
1289
1360
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -1293,18 +1364,19 @@ module Increase
|
|
|
1293
1364
|
# @return [String]
|
|
1294
1365
|
required :city, String
|
|
1295
1366
|
|
|
1296
|
-
# @!attribute country
|
|
1297
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
1298
|
-
#
|
|
1299
|
-
# @return [String]
|
|
1300
|
-
required :country, String
|
|
1301
|
-
|
|
1302
1367
|
# @!attribute line1
|
|
1303
1368
|
# The first line of the address. This is usually the street number and street.
|
|
1304
1369
|
#
|
|
1305
1370
|
# @return [String]
|
|
1306
1371
|
required :line1, String
|
|
1307
1372
|
|
|
1373
|
+
# @!attribute country
|
|
1374
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
1375
|
+
# to `US`.
|
|
1376
|
+
#
|
|
1377
|
+
# @return [String, nil]
|
|
1378
|
+
optional :country, String
|
|
1379
|
+
|
|
1308
1380
|
# @!attribute line2
|
|
1309
1381
|
# The second line of the address. This might be the floor or room number.
|
|
1310
1382
|
#
|
|
@@ -1324,22 +1396,23 @@ module Increase
|
|
|
1324
1396
|
# @return [String, nil]
|
|
1325
1397
|
optional :zip, String
|
|
1326
1398
|
|
|
1327
|
-
# @!method initialize(city:,
|
|
1328
|
-
# Some parameter documentations has been truncated, see
|
|
1329
|
-
# {Increase::Models::EntityCreateParams::NaturalPerson::Address} for more details.
|
|
1330
|
-
#
|
|
1399
|
+
# @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
|
|
1331
1400
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1332
1401
|
# PMB's are disallowed.
|
|
1333
1402
|
#
|
|
1334
1403
|
# @param city [String] The city, district, town, or village of the address.
|
|
1335
1404
|
#
|
|
1336
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
1337
|
-
#
|
|
1338
1405
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
1339
1406
|
#
|
|
1407
|
+
# @param country [String]
|
|
1408
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
1409
|
+
# to `US`.
|
|
1410
|
+
#
|
|
1340
1411
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
1341
1412
|
#
|
|
1342
|
-
# @param state [String]
|
|
1413
|
+
# @param state [String]
|
|
1414
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
1415
|
+
# state, province, or region of the address. Required in certain countries.
|
|
1343
1416
|
#
|
|
1344
1417
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
1345
1418
|
end
|
|
@@ -1387,21 +1460,29 @@ module Increase
|
|
|
1387
1460
|
optional :passport, -> { Increase::EntityCreateParams::NaturalPerson::Identification::Passport }
|
|
1388
1461
|
|
|
1389
1462
|
# @!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
1463
|
# A means of verifying the person's identity.
|
|
1395
1464
|
#
|
|
1396
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method]
|
|
1465
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method]
|
|
1466
|
+
# A method that can be used to verify the individual's identity.
|
|
1397
1467
|
#
|
|
1398
|
-
# @param number [String]
|
|
1468
|
+
# @param number [String]
|
|
1469
|
+
# An identification number that can be used to verify the individual's identity,
|
|
1470
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
1471
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
1472
|
+
# separators. When testing in sandbox, use one of our
|
|
1473
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
1399
1474
|
#
|
|
1400
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense]
|
|
1475
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense]
|
|
1476
|
+
# Information about the United States driver's license used for identification.
|
|
1477
|
+
# Required if `method` is equal to `drivers_license`.
|
|
1401
1478
|
#
|
|
1402
|
-
# @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other]
|
|
1479
|
+
# @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other]
|
|
1480
|
+
# Information about the identification document provided. Required if `method` is
|
|
1481
|
+
# equal to `other`.
|
|
1403
1482
|
#
|
|
1404
|
-
# @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport]
|
|
1483
|
+
# @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport]
|
|
1484
|
+
# Information about the passport used for identification. Required if `method` is
|
|
1485
|
+
# equal to `passport`.
|
|
1405
1486
|
|
|
1406
1487
|
# A method that can be used to verify the individual's identity.
|
|
1407
1488
|
#
|
|
@@ -1502,20 +1583,20 @@ module Increase
|
|
|
1502
1583
|
optional :expiration_date, Date
|
|
1503
1584
|
|
|
1504
1585
|
# @!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
1586
|
# Information about the identification document provided. Required if `method` is
|
|
1510
1587
|
# equal to `other`.
|
|
1511
1588
|
#
|
|
1512
|
-
# @param country [String]
|
|
1589
|
+
# @param country [String]
|
|
1590
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1591
|
+
# document (e.g., `US`).
|
|
1513
1592
|
#
|
|
1514
1593
|
# @param description [String] A description of the document submitted.
|
|
1515
1594
|
#
|
|
1516
1595
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
1517
1596
|
#
|
|
1518
|
-
# @param back_file_id [String]
|
|
1597
|
+
# @param back_file_id [String]
|
|
1598
|
+
# The identifier of the File containing the back of the document. Not every
|
|
1599
|
+
# document has a reverse side.
|
|
1519
1600
|
#
|
|
1520
1601
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
1521
1602
|
end
|
|
@@ -1542,14 +1623,12 @@ module Increase
|
|
|
1542
1623
|
required :file_id, String
|
|
1543
1624
|
|
|
1544
1625
|
# @!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
1626
|
# Information about the passport used for identification. Required if `method` is
|
|
1550
1627
|
# equal to `passport`.
|
|
1551
1628
|
#
|
|
1552
|
-
# @param country [String]
|
|
1629
|
+
# @param country [String]
|
|
1630
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
1631
|
+
# document (e.g., `US`).
|
|
1553
1632
|
#
|
|
1554
1633
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
1555
1634
|
#
|
|
@@ -1573,15 +1652,15 @@ module Increase
|
|
|
1573
1652
|
required :rating, enum: -> { Increase::EntityCreateParams::RiskRating::Rating }
|
|
1574
1653
|
|
|
1575
1654
|
# @!method initialize(rated_at:, rating:)
|
|
1576
|
-
# Some parameter documentations has been truncated, see
|
|
1577
|
-
# {Increase::Models::EntityCreateParams::RiskRating} for more details.
|
|
1578
|
-
#
|
|
1579
1655
|
# An assessment of the entity's potential risk of involvement in financial crimes,
|
|
1580
1656
|
# such as money laundering.
|
|
1581
1657
|
#
|
|
1582
|
-
# @param rated_at [Time]
|
|
1658
|
+
# @param rated_at [Time]
|
|
1659
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
|
1660
|
+
# rating was performed.
|
|
1583
1661
|
#
|
|
1584
|
-
# @param rating [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
|
|
1662
|
+
# @param rating [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
|
|
1663
|
+
# The rating given to this entity.
|
|
1585
1664
|
|
|
1586
1665
|
# The rating given to this entity.
|
|
1587
1666
|
#
|
|
@@ -1634,9 +1713,6 @@ module Increase
|
|
|
1634
1713
|
required :terms_url, String
|
|
1635
1714
|
|
|
1636
1715
|
# @!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
1716
|
# @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
|
|
1641
1717
|
#
|
|
1642
1718
|
# @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
|
|
@@ -1664,7 +1740,8 @@ module Increase
|
|
|
1664
1740
|
#
|
|
1665
1741
|
# @param reference [String] The reference identifier for the third party verification.
|
|
1666
1742
|
#
|
|
1667
|
-
# @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor]
|
|
1743
|
+
# @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor]
|
|
1744
|
+
# The vendor that was used to perform the verification.
|
|
1668
1745
|
|
|
1669
1746
|
# The vendor that was used to perform the verification.
|
|
1670
1747
|
#
|
|
@@ -1747,27 +1824,35 @@ module Increase
|
|
|
1747
1824
|
optional :tax_identifier, String
|
|
1748
1825
|
|
|
1749
1826
|
# @!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
1827
|
# Details of the trust entity to create. Required if `structure` is equal to
|
|
1754
1828
|
# `trust`.
|
|
1755
1829
|
#
|
|
1756
|
-
# @param address [Increase::Models::EntityCreateParams::Trust::Address]
|
|
1830
|
+
# @param address [Increase::Models::EntityCreateParams::Trust::Address]
|
|
1831
|
+
# The trust's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
1832
|
+
# are disallowed.
|
|
1757
1833
|
#
|
|
1758
|
-
# @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category]
|
|
1834
|
+
# @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category]
|
|
1835
|
+
# Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
|
|
1836
|
+
# their own Employer Identification Number. Revocable trusts require information
|
|
1837
|
+
# about the individual `grantor` who created the trust.
|
|
1759
1838
|
#
|
|
1760
1839
|
# @param name [String] The legal name of the trust.
|
|
1761
1840
|
#
|
|
1762
1841
|
# @param trustees [Array<Increase::Models::EntityCreateParams::Trust::Trustee>] The trustees of the trust.
|
|
1763
1842
|
#
|
|
1764
|
-
# @param formation_document_file_id [String]
|
|
1843
|
+
# @param formation_document_file_id [String]
|
|
1844
|
+
# The identifier of the File containing the formation document of the trust.
|
|
1765
1845
|
#
|
|
1766
|
-
# @param formation_state [String]
|
|
1846
|
+
# @param formation_state [String]
|
|
1847
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state in
|
|
1848
|
+
# which the trust was formed.
|
|
1767
1849
|
#
|
|
1768
|
-
# @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor]
|
|
1850
|
+
# @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor]
|
|
1851
|
+
# The grantor of the trust. Required if `category` is equal to `revocable`.
|
|
1769
1852
|
#
|
|
1770
|
-
# @param tax_identifier [String]
|
|
1853
|
+
# @param tax_identifier [String]
|
|
1854
|
+
# The Employer Identification Number (EIN) for the trust. Submit nine digits with
|
|
1855
|
+
# no dashes or other separators. Required if `category` is equal to `irrevocable`.
|
|
1771
1856
|
|
|
1772
1857
|
# @see Increase::Models::EntityCreateParams::Trust#address
|
|
1773
1858
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -1803,9 +1888,6 @@ module Increase
|
|
|
1803
1888
|
optional :line2, String
|
|
1804
1889
|
|
|
1805
1890
|
# @!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
1891
|
# The trust's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
1810
1892
|
# are disallowed.
|
|
1811
1893
|
#
|
|
@@ -1813,7 +1895,9 @@ module Increase
|
|
|
1813
1895
|
#
|
|
1814
1896
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
1815
1897
|
#
|
|
1816
|
-
# @param state [String]
|
|
1898
|
+
# @param state [String]
|
|
1899
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
1900
|
+
# the address.
|
|
1817
1901
|
#
|
|
1818
1902
|
# @param zip [String] The ZIP code of the address.
|
|
1819
1903
|
#
|
|
@@ -1853,12 +1937,12 @@ module Increase
|
|
|
1853
1937
|
optional :individual, -> { Increase::EntityCreateParams::Trust::Trustee::Individual }
|
|
1854
1938
|
|
|
1855
1939
|
# @!method initialize(structure:, individual: nil)
|
|
1856
|
-
#
|
|
1857
|
-
#
|
|
1858
|
-
#
|
|
1859
|
-
# @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] The structure of the trustee.
|
|
1940
|
+
# @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure]
|
|
1941
|
+
# The structure of the trustee.
|
|
1860
1942
|
#
|
|
1861
|
-
# @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual]
|
|
1943
|
+
# @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual]
|
|
1944
|
+
# Details of the individual trustee. Within the trustee object, this is required
|
|
1945
|
+
# if `structure` is equal to `individual`.
|
|
1862
1946
|
|
|
1863
1947
|
# The structure of the trustee.
|
|
1864
1948
|
#
|
|
@@ -1910,22 +1994,25 @@ module Increase
|
|
|
1910
1994
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
1911
1995
|
|
|
1912
1996
|
# @!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
1997
|
# Details of the individual trustee. Within the trustee object, this is required
|
|
1918
1998
|
# if `structure` is equal to `individual`.
|
|
1919
1999
|
#
|
|
1920
|
-
# @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address]
|
|
2000
|
+
# @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address]
|
|
2001
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
2002
|
+
# PMB's are disallowed.
|
|
1921
2003
|
#
|
|
1922
2004
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
1923
2005
|
#
|
|
1924
|
-
# @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification]
|
|
2006
|
+
# @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification]
|
|
2007
|
+
# A means of verifying the person's identity.
|
|
1925
2008
|
#
|
|
1926
2009
|
# @param name [String] The person's legal name.
|
|
1927
2010
|
#
|
|
1928
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
2011
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
2012
|
+
# The identification method for an individual can only be a passport, driver's
|
|
2013
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
2014
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
2015
|
+
# Number).
|
|
1929
2016
|
|
|
1930
2017
|
# @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#address
|
|
1931
2018
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -1935,18 +2022,19 @@ module Increase
|
|
|
1935
2022
|
# @return [String]
|
|
1936
2023
|
required :city, String
|
|
1937
2024
|
|
|
1938
|
-
# @!attribute country
|
|
1939
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
1940
|
-
#
|
|
1941
|
-
# @return [String]
|
|
1942
|
-
required :country, String
|
|
1943
|
-
|
|
1944
2025
|
# @!attribute line1
|
|
1945
2026
|
# The first line of the address. This is usually the street number and street.
|
|
1946
2027
|
#
|
|
1947
2028
|
# @return [String]
|
|
1948
2029
|
required :line1, String
|
|
1949
2030
|
|
|
2031
|
+
# @!attribute country
|
|
2032
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
2033
|
+
# to `US`.
|
|
2034
|
+
#
|
|
2035
|
+
# @return [String, nil]
|
|
2036
|
+
optional :country, String
|
|
2037
|
+
|
|
1950
2038
|
# @!attribute line2
|
|
1951
2039
|
# The second line of the address. This might be the floor or room number.
|
|
1952
2040
|
#
|
|
@@ -1966,23 +2054,23 @@ module Increase
|
|
|
1966
2054
|
# @return [String, nil]
|
|
1967
2055
|
optional :zip, String
|
|
1968
2056
|
|
|
1969
|
-
# @!method initialize(city:,
|
|
1970
|
-
# Some parameter documentations has been truncated, see
|
|
1971
|
-
# {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address} for
|
|
1972
|
-
# more details.
|
|
1973
|
-
#
|
|
2057
|
+
# @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
|
|
1974
2058
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
1975
2059
|
# PMB's are disallowed.
|
|
1976
2060
|
#
|
|
1977
2061
|
# @param city [String] The city, district, town, or village of the address.
|
|
1978
2062
|
#
|
|
1979
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
1980
|
-
#
|
|
1981
2063
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
1982
2064
|
#
|
|
2065
|
+
# @param country [String]
|
|
2066
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
2067
|
+
# to `US`.
|
|
2068
|
+
#
|
|
1983
2069
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
1984
2070
|
#
|
|
1985
|
-
# @param state [String]
|
|
2071
|
+
# @param state [String]
|
|
2072
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
2073
|
+
# state, province, or region of the address. Required in certain countries.
|
|
1986
2074
|
#
|
|
1987
2075
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
1988
2076
|
end
|
|
@@ -2033,21 +2121,29 @@ module Increase
|
|
|
2033
2121
|
-> { Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport }
|
|
2034
2122
|
|
|
2035
2123
|
# @!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
2124
|
# A means of verifying the person's identity.
|
|
2041
2125
|
#
|
|
2042
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method]
|
|
2126
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method]
|
|
2127
|
+
# A method that can be used to verify the individual's identity.
|
|
2043
2128
|
#
|
|
2044
|
-
# @param number [String]
|
|
2129
|
+
# @param number [String]
|
|
2130
|
+
# An identification number that can be used to verify the individual's identity,
|
|
2131
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
2132
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
2133
|
+
# separators. When testing in sandbox, use one of our
|
|
2134
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
2045
2135
|
#
|
|
2046
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense]
|
|
2136
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense]
|
|
2137
|
+
# Information about the United States driver's license used for identification.
|
|
2138
|
+
# Required if `method` is equal to `drivers_license`.
|
|
2047
2139
|
#
|
|
2048
|
-
# @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other]
|
|
2140
|
+
# @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other]
|
|
2141
|
+
# Information about the identification document provided. Required if `method` is
|
|
2142
|
+
# equal to `other`.
|
|
2049
2143
|
#
|
|
2050
|
-
# @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport]
|
|
2144
|
+
# @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport]
|
|
2145
|
+
# Information about the passport used for identification. Required if `method` is
|
|
2146
|
+
# equal to `passport`.
|
|
2051
2147
|
|
|
2052
2148
|
# A method that can be used to verify the individual's identity.
|
|
2053
2149
|
#
|
|
@@ -2148,20 +2244,20 @@ module Increase
|
|
|
2148
2244
|
optional :expiration_date, Date
|
|
2149
2245
|
|
|
2150
2246
|
# @!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
2247
|
# Information about the identification document provided. Required if `method` is
|
|
2156
2248
|
# equal to `other`.
|
|
2157
2249
|
#
|
|
2158
|
-
# @param country [String]
|
|
2250
|
+
# @param country [String]
|
|
2251
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2252
|
+
# document (e.g., `US`).
|
|
2159
2253
|
#
|
|
2160
2254
|
# @param description [String] A description of the document submitted.
|
|
2161
2255
|
#
|
|
2162
2256
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
2163
2257
|
#
|
|
2164
|
-
# @param back_file_id [String]
|
|
2258
|
+
# @param back_file_id [String]
|
|
2259
|
+
# The identifier of the File containing the back of the document. Not every
|
|
2260
|
+
# document has a reverse side.
|
|
2165
2261
|
#
|
|
2166
2262
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
2167
2263
|
end
|
|
@@ -2188,14 +2284,12 @@ module Increase
|
|
|
2188
2284
|
required :file_id, String
|
|
2189
2285
|
|
|
2190
2286
|
# @!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
2287
|
# Information about the passport used for identification. Required if `method` is
|
|
2196
2288
|
# equal to `passport`.
|
|
2197
2289
|
#
|
|
2198
|
-
# @param country [String]
|
|
2290
|
+
# @param country [String]
|
|
2291
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2292
|
+
# document (e.g., `US`).
|
|
2199
2293
|
#
|
|
2200
2294
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
2201
2295
|
#
|
|
@@ -2242,20 +2336,24 @@ module Increase
|
|
|
2242
2336
|
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
2243
2337
|
|
|
2244
2338
|
# @!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
2339
|
# The grantor of the trust. Required if `category` is equal to `revocable`.
|
|
2249
2340
|
#
|
|
2250
|
-
# @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address]
|
|
2341
|
+
# @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address]
|
|
2342
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
2343
|
+
# PMB's are disallowed.
|
|
2251
2344
|
#
|
|
2252
2345
|
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
2253
2346
|
#
|
|
2254
|
-
# @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification]
|
|
2347
|
+
# @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification]
|
|
2348
|
+
# A means of verifying the person's identity.
|
|
2255
2349
|
#
|
|
2256
2350
|
# @param name [String] The person's legal name.
|
|
2257
2351
|
#
|
|
2258
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
2352
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
2353
|
+
# The identification method for an individual can only be a passport, driver's
|
|
2354
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
2355
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
2356
|
+
# Number).
|
|
2259
2357
|
|
|
2260
2358
|
# @see Increase::Models::EntityCreateParams::Trust::Grantor#address
|
|
2261
2359
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -2265,18 +2363,19 @@ module Increase
|
|
|
2265
2363
|
# @return [String]
|
|
2266
2364
|
required :city, String
|
|
2267
2365
|
|
|
2268
|
-
# @!attribute country
|
|
2269
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
2270
|
-
#
|
|
2271
|
-
# @return [String]
|
|
2272
|
-
required :country, String
|
|
2273
|
-
|
|
2274
2366
|
# @!attribute line1
|
|
2275
2367
|
# The first line of the address. This is usually the street number and street.
|
|
2276
2368
|
#
|
|
2277
2369
|
# @return [String]
|
|
2278
2370
|
required :line1, String
|
|
2279
2371
|
|
|
2372
|
+
# @!attribute country
|
|
2373
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
2374
|
+
# to `US`.
|
|
2375
|
+
#
|
|
2376
|
+
# @return [String, nil]
|
|
2377
|
+
optional :country, String
|
|
2378
|
+
|
|
2280
2379
|
# @!attribute line2
|
|
2281
2380
|
# The second line of the address. This might be the floor or room number.
|
|
2282
2381
|
#
|
|
@@ -2296,23 +2395,23 @@ module Increase
|
|
|
2296
2395
|
# @return [String, nil]
|
|
2297
2396
|
optional :zip, String
|
|
2298
2397
|
|
|
2299
|
-
# @!method initialize(city:,
|
|
2300
|
-
# Some parameter documentations has been truncated, see
|
|
2301
|
-
# {Increase::Models::EntityCreateParams::Trust::Grantor::Address} for more
|
|
2302
|
-
# details.
|
|
2303
|
-
#
|
|
2398
|
+
# @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
|
|
2304
2399
|
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
2305
2400
|
# PMB's are disallowed.
|
|
2306
2401
|
#
|
|
2307
2402
|
# @param city [String] The city, district, town, or village of the address.
|
|
2308
2403
|
#
|
|
2309
|
-
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
2310
|
-
#
|
|
2311
2404
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
2312
2405
|
#
|
|
2406
|
+
# @param country [String]
|
|
2407
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
2408
|
+
# to `US`.
|
|
2409
|
+
#
|
|
2313
2410
|
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
2314
2411
|
#
|
|
2315
|
-
# @param state [String]
|
|
2412
|
+
# @param state [String]
|
|
2413
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
2414
|
+
# state, province, or region of the address. Required in certain countries.
|
|
2316
2415
|
#
|
|
2317
2416
|
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
2318
2417
|
end
|
|
@@ -2360,21 +2459,29 @@ module Increase
|
|
|
2360
2459
|
optional :passport, -> { Increase::EntityCreateParams::Trust::Grantor::Identification::Passport }
|
|
2361
2460
|
|
|
2362
2461
|
# @!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
2462
|
# A means of verifying the person's identity.
|
|
2368
2463
|
#
|
|
2369
|
-
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method]
|
|
2464
|
+
# @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method]
|
|
2465
|
+
# A method that can be used to verify the individual's identity.
|
|
2370
2466
|
#
|
|
2371
|
-
# @param number [String]
|
|
2467
|
+
# @param number [String]
|
|
2468
|
+
# An identification number that can be used to verify the individual's identity,
|
|
2469
|
+
# such as a social security number. For Social Security Numbers and Individual
|
|
2470
|
+
# Taxpayer Identification Numbers, submit nine digits with no dashes or other
|
|
2471
|
+
# separators. When testing in sandbox, use one of our
|
|
2472
|
+
# [sandbox test values](https://increase.com/documentation/sandbox-test-values).
|
|
2372
2473
|
#
|
|
2373
|
-
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense]
|
|
2474
|
+
# @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense]
|
|
2475
|
+
# Information about the United States driver's license used for identification.
|
|
2476
|
+
# Required if `method` is equal to `drivers_license`.
|
|
2374
2477
|
#
|
|
2375
|
-
# @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other]
|
|
2478
|
+
# @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other]
|
|
2479
|
+
# Information about the identification document provided. Required if `method` is
|
|
2480
|
+
# equal to `other`.
|
|
2376
2481
|
#
|
|
2377
|
-
# @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport]
|
|
2482
|
+
# @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport]
|
|
2483
|
+
# Information about the passport used for identification. Required if `method` is
|
|
2484
|
+
# equal to `passport`.
|
|
2378
2485
|
|
|
2379
2486
|
# A method that can be used to verify the individual's identity.
|
|
2380
2487
|
#
|
|
@@ -2475,20 +2582,20 @@ module Increase
|
|
|
2475
2582
|
optional :expiration_date, Date
|
|
2476
2583
|
|
|
2477
2584
|
# @!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
2585
|
# Information about the identification document provided. Required if `method` is
|
|
2483
2586
|
# equal to `other`.
|
|
2484
2587
|
#
|
|
2485
|
-
# @param country [String]
|
|
2588
|
+
# @param country [String]
|
|
2589
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2590
|
+
# document (e.g., `US`).
|
|
2486
2591
|
#
|
|
2487
2592
|
# @param description [String] A description of the document submitted.
|
|
2488
2593
|
#
|
|
2489
2594
|
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
2490
2595
|
#
|
|
2491
|
-
# @param back_file_id [String]
|
|
2596
|
+
# @param back_file_id [String]
|
|
2597
|
+
# The identifier of the File containing the back of the document. Not every
|
|
2598
|
+
# document has a reverse side.
|
|
2492
2599
|
#
|
|
2493
2600
|
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
2494
2601
|
end
|
|
@@ -2515,14 +2622,12 @@ module Increase
|
|
|
2515
2622
|
required :file_id, String
|
|
2516
2623
|
|
|
2517
2624
|
# @!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
2625
|
# Information about the passport used for identification. Required if `method` is
|
|
2523
2626
|
# equal to `passport`.
|
|
2524
2627
|
#
|
|
2525
|
-
# @param country [String]
|
|
2628
|
+
# @param country [String]
|
|
2629
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
2630
|
+
# document (e.g., `US`).
|
|
2526
2631
|
#
|
|
2527
2632
|
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
2528
2633
|
#
|