The POST /legal_entities/{id} call allows your platform to update and add custom data to a legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
Api-Version required | string Example: 3.0 |
Content-Type required | stringapplication/json Example: application/json |
Unique-Key | string |
WePay-Risk-Token | string This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used. |
object or null Personal details of the account controller. Note: An account controller is an authorized representative who controls the merchant account and can call in for support. The | |||||||
object or null Personal information for additional representatives of the legal entity. WePay collects additional representatives information for businesses. The additional representatives could a beneficial owners or an auxiliary controller. This is determined by setting the parameters on the representative. Note: You can pass | |||||||
object or null Address of the legal entity, controller, or additional representatives. When representing the entity's address, send the entity's address of operation. When representing the controller or additional representative send the individual's residential address. | |||||||
annual_credit_card_volume | integer Annual credit card volume in dollars of the merchant. | ||||||
annual_sales_volume | integer or null Annual sales volume in dollars of the merchant, using the currency specified in annual_sales_volume_currency. | ||||||
annual_sales_volume_currency | string or null The currency used in annual sales volume. Possible values include: CAD, USD
| ||||||
object or null Indicate that the controller has attested to the validity of CIP/KYC details submitted. Find more information here. | |||||||
average_ticket_size | integer or null Actual sales per transaction on an average. It's in dollars. | ||||||
object or null Personal details of the controller. Note: A controller is an individual with significant responsibility to control or manage a legal entity. Examples of controllers include, but are not limited to, a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer, or any other individual who regularly performs similar functions as part of a control prong. | |||||||
controller_type | string Describes the type of controller for an account. Can be either
| ||||||
object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | |||||||
description | string or null <= 1024 characters Description of the Legal Entity. WePay uses this information for underwriting purposes. | ||||||
string or null <= 254 characters ^([^,:;=@"'\\\s()\[\]]+)+@([a-zA-Z-0-9-]+\.)+... Email associated with the Legal Entity (business email). Note that each domain label (parts that are separated by dots) must not exceed 63 characters. | |||||||
object Information about the Legal Entity. | |||||||
entity_name | string or null [ 1 .. 255 ] characters ^(?!.*[Ww][Ee][Pp][Aa][Yy]).*$ The name of the legal entity. This should not contain a merchant's DBA; DBAs can be included on the Account resource. Must not contain the word | ||||||
entity_purpose_or_ideology | string or null Information on how you would classify your organization's purpose.
| ||||||
has_significant_wealth_contributors | boolean Indicates if there are significant wealth contributors to the organization. A significant wealth contributor is any person or entity who contributes 10% or more to the organization's funding, also known as investors. Note: This field is only required if the | ||||||
non_delivery_days | integer or null Non delivery days specified by the merchant. | ||||||
object or null | |||||||
preferred_locale | string or null The preferred locale of the legal entity. For merchants using the WePay Merchant Center, or receiving payments emails from WePay, this option will set the language preference.
| ||||||
primary_url | string or null <= 2063 characters ^https?://.+$ Primary URL of the legal entity. | ||||||
object or null Information regarding public ownership of an entity. Required for publicly traded companies. | |||||||
Array of objects or null Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects. | |||||||
reference_id | string or null [ 1 .. 255 ] characters A custom reference ID for your platform to track the object. It can be any string. | ||||||
object Information regarding the referring representative | |||||||
object Identify significant beneficiaries. Note: A significant beneficiary either receives or is responsible for 10% or more of the organization's funds. | |||||||
object or null Identify significant donors. Note: A significant donor contributes 10% or more of the organization's total volume. | |||||||
object or null Information of up to 10 significant wealth contributors to the organization. A significant wealth contributor is any person or entity who contributes 10% or more to the organization's funding, also known as investors. Note: This field is only required if the | |||||||
source_and_use_of_funds | string or null <= 4000 characters Describe source of funding (not revenue sources) for the organization to operate. Examples include: funding from members (i.e. fees, dues, etc.), donations, business operations, and possibly local, state, or federal funding. | ||||||
object Data regarding the legal entity's acceptance of the WePay terms of service. | |||||||
object A previously created token. Note: Using tokens to pass highly-sensitive data directly to WePay may help your platform avoid certain compliance and regulatory overhead. Learn more about tokens here. |
required | object or null Personal information for additional representatives of the legal entity. | ||||||
required | object or null Address of the legal entity, controller, or additional representatives. When representing the entity's address, send the entity's address of operation. When representing the controller or additional representative send the individual's residential address. | ||||||
api_version required | string | ||||||
required | object or null Personal details of the controller. Note: A controller is an individual with significant responsibility to control or manage a legal entity. Examples of controllers include, but are not limited to, a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer, or any other individual who regularly performs similar functions as part of a control prong. | ||||||
country required | string
| ||||||
create_time required | integer <int64> >= 0 The UNIX timestamp for when the object was created. | ||||||
description required | string or null <= 1024 characters Description of the Legal Entity. WePay uses this information for underwriting purposes. | ||||||
required | object Information about the Legal Entity. | ||||||
entity_name required | string or null [ 1 .. 255 ] characters ^(?!.*[Ww][Ee][Pp][Aa][Yy]).*$ The name of the legal entity. This should not contain a merchant's DBA; DBAs can be included on the Account resource. Must not contain the word | ||||||
id required | string or null ID of the legal entity, generated by WePay when the legal entity is created. | ||||||
required | object This owner resource and owner path of the object. | ||||||
path required | string The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it. | ||||||
required | object or null | ||||||
primary_url required | string or null <= 2063 characters ^https?://.+$ Primary URL of the legal entity. | ||||||
resource required | string Helps organize information by identifying the resource type of the object data.
| ||||||
required | object Data regarding the legal entity's acceptance of the WePay terms of service. | ||||||
object or null Personal details of the account controller. Note: An account controller is an authorized representative who controls the merchant account and can call in for support. The | |||||||
annual_credit_card_volume | integer Annual credit card volume in dollars of the merchant. | ||||||
annual_sales_volume | integer or null Annual sales volume in dollars of the merchant, using the currency specified in annual_sales_volume_currency. | ||||||
annual_sales_volume_currency | string or null The currency used in annual sales volume. Possible values include: CAD, USD
| ||||||
object or null Indicate that the controller has attested to the validity of CIP/KYC details submitted. Find more information here. | |||||||
average_ticket_size | integer or null Actual sales per transaction on an average. It's in dollars. | ||||||
controller_type | string Describes the type of controller for an account. Can be either
| ||||||
object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | |||||||
string or null <= 254 characters ^([^,:;=@"'\\\s()\[\]]+)+@([a-zA-Z-0-9-]+\.)+... Email associated with the Legal Entity (business email). Note that each domain label (parts that are separated by dots) must not exceed 63 characters. | |||||||
enterprise_customer_id | string or null [ 1 .. 20 ] characters ^\d{1,20}$ The Chase ID of the enterprise customer to use as the external resource for legal entity data. Note: This parameter requires permission from WePay to use. | ||||||
entity_purpose_or_ideology | string or null Information on how you would classify your organization's purpose.
| ||||||
has_significant_wealth_contributors | boolean Indicates if there are significant wealth contributors to the organization. A significant wealth contributor is any person or entity who contributes 10% or more to the organization's funding, also known as investors. Note: This field is only required if the | ||||||
non_delivery_days | integer or null Non delivery days specified by the merchant. | ||||||
preferred_locale | string or null The preferred locale of the legal entity. For merchants using the WePay Merchant Center, or receiving payments emails from WePay, this option will set the language preference.
| ||||||
object Information regarding public ownership of an entity. Required for publicly traded companies. | |||||||
reference_id | string or null [ 1 .. 255 ] characters A custom reference ID for your platform to track the object. It can be any string. | ||||||
object Information regarding the referring representative | |||||||
object Identify significant beneficiaries. Note: A significant beneficiary either receives or is responsible for 10% or more of the organization's funds. | |||||||
object or null Identify significant donors. Note: A significant donor contributes 10% or more of the organization's total volume. | |||||||
object or null Information of up to 10 significant wealth contributors to the organization. A significant wealth contributor is any person or entity who contributes 10% or more to the organization's funding, also known as investors. Note: This field is only required if the | |||||||
source_and_use_of_funds | string or null <= 4000 characters Describe source of funding (not revenue sources) for the organization to operate. Examples include: funding from members (i.e. fees, dues, etc.), donations, business operations, and possibly local, state, or federal funding. |
INVALID_PARAMS, UNSUPPORTED_COUNTRY
NOT_AUTHORIZED
RESOURCE_CONFLICT
UNEXPECTED_ERROR
{- "address": {
- "city": "San Francisco",
- "country": "US",
- "line1": "123 Fake Street",
- "postal_code": "94101",
- "region": "CA"
}, - "attestation": {
- "attester_type": "other_representative",
- "other_representative": {
- "attest_time": 1490656130,
- "job_title": "CEO",
- "name": {
- "first": "Foo",
- "last": "Bar"
}, - "original_ip": "12.37.161.213"
}
}, - "controller": {
- "reference_id": "reference_id_0",
- "address": {
- "city": "Beverly Hills",
- "country": "US",
- "line1": "456 Nocturn Alley",
- "postal_code": "90210",
- "region": "CA"
}, - "date_of_birth": {
- "day": 1,
- "month": 1,
- "year": 1900
}, - "email": "example@example.com",
- "name": {
- "first": "Foo",
- "last": "Bar"
}, - "personal_country_info": {
- "US": {
- "social_security_number": "012-34-5678"
}
}, - "phone": {
- "country_code": "+1",
- "phone_number": "5556667777"
}, - "job_title": "CFO"
}, - "account_controller": null,
- "controller_type": "controller",
- "description": "The Foo Bar Shop on 5th ave.",
- "entity_country_info": {
- "US": {
- "employer_identification_number": "123211230"
}
}, - "entity_name": "Foo Bar Shop",
- "email": "example@email.com",
- "significant_beneficiaries": {
- "affiliations": {
- "affiliation_0": {
- "name": "charity_a",
- "countries": [
- "US",
- "CA"
], - "association_types": {
- "contractual_obligation": true,
- "donor": false,
- "funding_recipient": false,
- "other": "other association_type",
- "parent_organization": true,
- "program_affiliation": false,
- "resource_delivery_provider": false,
- "transfer_retention_or_expenditure": false
}
}
}, - "entities": {
- "art_and_culture": false,
- "education": true,
- "individual": false,
- "labor_union": true,
- "other": "some significant beneficiary",
- "political_organization": false,
- "religious": true,
- "social_service_and_economic_development": false
}, - "geographies": {
- "local": true,
- "regional": true,
- "national": false,
- "international": [
- "US",
- "CA"
]
}, - "non_domestic_location_beneficiaries": [
- "US",
- "CA"
]
}, - "significant_donors": {
- "corporate_entity": true,
- "endowment_fund": true,
- "government": false,
- "individual": true,
- "institutional": false,
- "other": "some significant donor",
- "other_charitable_organization": true
}
}
{- "additional_representatives": null,
- "address": {
- "city": "San Francisco",
- "country": "US",
- "line1": "123 Fake Street",
- "postal_code": "94101",
- "region": "CA"
}, - "attestation": {
- "attester_type": "other_representative",
- "other_representative": {
- "attest_time": 1490656130,
- "job_title": "CEO",
- "name": {
- "first": "Foo",
- "last": "Bar"
}, - "original_ip": "12.37.161.213"
}
}, - "controller": {
- "reference_id": "reference_id_0",
- "address": {
- "city": "Beverly Hills",
- "country": "US",
- "line1": "456 Nocturn Alley",
- "postal_code": "90210",
- "region": "CA"
}, - "date_of_birth_is_present": true,
- "email": "example@example.com",
- "name": {
- "first": "Foo",
- "last": "Bar"
}, - "personal_country_info": {
- "US": {
- "social_security_number_is_present": true
}
}, - "phone": {
- "country_code": "+1",
- "phone_number": "5556667777"
}, - "job_title": "CFO"
}, - "account_controller": null,
- "controller_type": "controller",
- "public_ownership": {
- "is_publicly_traded": true,
- "is_subsidiary": false,
- "parent_company_name": null,
- "primary_exchange": "NASDAQ",
- "traded_exchanges": {
- "NYSE": {
- "symbol": "ABCD",
- "country": "US",
- "name": "New York stock exchange"
}, - "NASDAQ": {
- "symbol": "ABCD",
- "country": "US",
- "name": "NASDAQ stock exchange"
}
}
}, - "country": "US",
- "create_time": 1480700534,
- "custom_data": null,
- "api_version": "3.0",
- "description": "The Foo Bar Shop on 5th ave.",
- "entity_country_info": {
- "US": {
- "employer_identification_number": "123211230"
}, - "country_of_formation": null,
- "operates_in_sanctioned_countries": null,
- "year_of_formation": null
}, - "entity_name": "Foo Bar Shop",
- "email": "example@email.com",
- "id": "b116768c-dac0-4ef1-8024-7d3056c6b186",
- "owner": {
- "id": "9dac302a-9d88-4bb7-bba2-8bd8a373acc5",
- "path": null,
- "resource": "applications"
}, - "path": "/legal_entities/b116768c-dac0-4ef1-8024-7d3056c6b186",
- "phone": null,
- "resource": "legal_entities",
- "significant_beneficiaries": {
- "affiliations": null,
- "entities": null,
- "geographies": null,
- "non_domestic_location_beneficiaries": null
}, - "significant_donors": null,
- "terms_of_service": {
- "acceptance_time": 1490656130,
- "original_ip": "12.37.161.213",
- "terms_of_service_version": "platform"
}, - "reference_id": null,
- "enterprise_customer_id": "12345",
- "entity_purpose_or_ideology": "Other"
}