Get a collection of legal entities

API Reference
Solutions
Features
Resources
- SDKs and Libraries
- Payments 101

Nothing Found

Get a collection of legal entities

get/legal_entities

The GET /legal_entities call allows your platform to look up a collection of legal entities. 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.

SecurityappIdAuth and appTokenAuth

Request

query Parameters

page	string Return elements from this page.
page_size	integer [ 1 .. 50 ] Default: 10 Return no more than this many elements per page. If not specified, `page_size` defaults to 10. Maximum value allowed is 50.
create_time_start	integer <int64> >= 0 The create time epoch timestamp (in seconds) for the start of the search window, inclusive.
create_time_end	integer <int64> >= 0 The create time epoch timestamp (in seconds) for the end of the search window, inclusive.
reference_id	string Return elements having this reference_id.

header Parameters

Api-Version required	string Example: 3.0
Unique-Key	string

Responses

200

Response Schema: application/json

required	Array of objects unique An array of legal entity objects.
next required	string or null An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.
previous required	string or null An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.
api_version	string

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples

Response samples

application/json

{"results": [{"terms_of_service": {"acceptance_time": 1490656130,
"original_ip": "12.37.161.213"
},
"controller": null,
"entity_name": "Top Cookie",
"phone": {"country_code": "+1",
"phone_number": "2817389195"
},
"primary_url": null,
"description": "Top Cookie is happy to deliver delicous cookies to the community.",
"address": {"line1": "123 candy st",
"city": "Beverly Hills",
"postal_code": "90210",
"region": "CA",
"country": "US"
},
"entity_country_info": {"US": {"legal_form": "government_entity",
"employer_identification_number": "321121234"
},
"country_of_formation": null,
"operates_in_sanctioned_countries": null,
"year_of_formation": null
},
"additional_representatives": null,
"custom_data": null,
"significant_donors": null,
"significant_beneficiaries": {"entities": null,
"geographies": null,
"affiliations": null,
"non_domestic_location_beneficiaries": null
},
"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"
}
}
},
"controller_type": "account_controller",
"account_controller": {"email": "matthewt+tst_merchant_2@wepay.com",
"name": {"first": "Foo",
"last": "bar"
},
"phone": {"country_code": "+1",
"phone_number": "125556667777"
},
"address": {"line1": "456 Nocturn Alley",
"city": "Beverly Hills",
"postal_code": "90210",
"region": "CA",
"country": "US"
},
"email_is_verified": false
},
"entity_purpose_or_ideology": "Family Foundation",
"source_and_use_of_funds": "Charity",
"has_significant_wealth_contributors": true,
"significant_wealth_contributors": {"contributor_0": {"name": {"first": "Test",
"last": "Bar",
"middle": "Foo",
"suffix": "Ms"
},
"address": {"address_type": "primary_residence",
"city": "San Francisco",
"country": "US",
"line1": "123 Fake Street",
"postal_code": "94101",
"region": "CA"
}
}
},
"country": "US",
"create_time": 1626192190,
"id": "1ba4cb4d-f842-4478-8c96-c62b9b360465",
"resource": "legal_entities",
"path": "/legal_entities/1ba4cb4d-f842-4478-8c96-c62b9b360465",
"owner": {"id": "183700",
"resource": "applications",
"path": null
},
"api_version": "3.0"
},
{"terms_of_service": {"acceptance_time": 1490656130,
"original_ip": "12.37.161.213"
},
"controller": {"is_beneficial_owner": null,
"name": {"first": "Foo",
"last": "Bar"
},
"phone": {"country_code": "+1",
"phone_number": "5556667777"
},
"address": {"line1": "456 Nocturn Alley",
"city": "Beverly Hills",
"postal_code": "90210",
"region": "CA",
"country": "US"
},
"email": "example@example.com",
"email_is_verified": false,
"personal_country_info": {"US": {"social_security_number_last_four_is_present": true,
"social_security_number_is_present": true
}
},
"job_title": null,
"date_of_birth_is_present": true
},
"entity_name": "Hermes Test Charity",
"phone": null,
"primary_url": null,
"description": "The Hermes Test Charity is very important",
"address": {"line1": "123 Fake Street",
"city": "San Francisco",
"postal_code": "94101",
"region": "CA",
"country": "US"
},
"entity_country_info": {"US": {"legal_form": "individual",
"employer_identification_number": "123211230"
},
"country_of_formation": null,
"operates_in_sanctioned_countries": null,
"year_of_formation": null
},
"additional_representatives": null,
"custom_data": null,
"significant_donors": null,
"significant_beneficiaries": {"entities": null,
"geographies": null,
"affiliations": null,
"non_domestic_location_beneficiaries": null
},
"public_ownership": {"is_publicly_traded": false,
"is_subsidiary": false,
"parent_company_name": null,
"primary_exchange": null,
"traded_exchanges": { }
},
"country": "US",
"create_time": 1626191603,
"id": "7b6cb66c-3df4-4869-b115-58e7cdc7bf33",
"resource": "legal_entities",
"path": "/legal_entities/7b6cb66c-3df4-4869-b115-58e7cdc7bf33",
"owner": {"id": "183700",
"resource": "applications",
"path": null
},
"api_version": "3.0-alpha.1"
}
],
"next": "/legal_entities?page=AQQHAAEXtz_V9KPMrlPgme_I5pIcbszHp0DPyrUcrGhnVrJRyzda-opQzSTM6imFTfuqVEq6IWykF90G8ve0OzjLWTvigfnVLoX9WkVniQEXJeNMyVRfVHXGros8",
"previous": null,
"api_version": "3.0-alpha.1"
}