ExtractionFamily Tree Extraction API

BQ Family Tree Extraction API

GET
/extraction/api/legal-entity

Corporate family tree: legal entities of the Organization with legal status, jurisdiction, parent/child relationships, establishments, ownership and officer indicators, and legal addresses. Up to 100 records per page.

Example: GET https://apigw.brightquery.com/extraction/api/legal-entity?bq_id=100073503151&page=1

Authorization

ApiKeyAuth
x-api-key<token>

Your BrightQuery API key, sent in the x-api-key request header.

In: header

Query Parameters

bq_id*integer

Unique ID assigned by BrightQuery to the Organization. Mandatory.

page?integer

The page number to retrieve (default 1).

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/extraction/api/legal-entity?bq_id=100003273517&page=1"
{  "status": 0,  "credit_balance": 0,  "data": {    "total": 0,    "size": 0,    "current_page": 0,    "next_page": 0,    "prev_page": 0,    "pages": 0,    "has_more": true,    "legal_entity": [      {        "bq_legal_entity_id": "string",        "bq_id": "string",        "bq_company_name": "string",        "bq_ticker": "string",        "bq_website": "string",        "bq_legal_entity_name": "string",        "bq_legal_entity_lfo": "string",        "bq_legal_entity_company_number": "string",        "bq_legal_entity_current_status": "string",        "bq_legal_entity_jurisdiction_code": "string",        "bq_legal_entity_ein": "string",        "bq_legal_entity_eins_related": "string",        "bq_legal_entity_ein_level": "string",        "bq_legal_entity_year_founded": "string",        "bq_legal_entity_date_founded": "string",        "bq_legal_entity_date_dissoluted": "string",        "bq_legal_entity_parent_id": "string",        "bq_legal_entity_ultimate_parent_id": "string",        "bq_legal_entity_parent_status": "string",        "bq_legal_entity_immediate_children_ids": "string",        "bq_legal_entity_immediate_children_count": 0,        "bq_legal_entity_children_ids": "string",        "bq_legal_entity_children_count": 0,        "bq_legal_entity_immediate_establishment_ids": "string",        "bq_legal_entity_immediate_establishment_count": 0,        "bq_legal_entity_establishment_ids": "string",        "bq_legal_entity_establishment_count": 0,        "bq_legal_entity_active_indicator": 0,        "bq_legal_entity_nonprofit_indicator": 0,        "bq_legal_entity_irs_taxlien_indicator": 0,        "bq_legal_entity_corporation_indicator": 0,        "bq_legal_entity_foreign_child_indicator": 0,        "bq_legal_entity_immediate_foreign_child_indicator": 0,        "bq_legal_entity_officerparent_indicator": 0,        "bq_legal_entity_officer_signatory_indicator": 0,        "bq_legal_entity_agent_indicator": 0,        "bq_legal_entity_minorityowned_indicator": 0,        "bq_legal_entity_veteranowned_indicator": 0,        "bq_legal_entity_womenowned_indicator": 0,        "bq_legal_entity_blackowned_indicator": 0,        "bq_legal_entity_hispanicowned_indicator": 0,        "bq_legal_entity_minority_in_officer_indicator": 0,        "bq_legal_entity_women_in_officer_indicator": 0,        "bq_legal_entity_black_in_officer_indicator": 0,        "bq_legal_entity_hispanic_in_officer_indicator": 0,        "bq_legal_entity_officer_parent_id": "string",        "bq_legal_entity_officer_parent_children_ids": "string",        "bq_legal_entity_officer_parent_children_count": 0,        "bq_legal_entity_address1_congressional_district": "string",        "bq_legal_entity_foreign_child_count": 0,        "bq_legal_entity_foreign_child_ids": "string",        "bq_legal_entity_immediate_foreign_child_count": 0,        "bq_legal_entity_immediate_foreign_child_ids": "string",        "bq_legal_entity_address1_valid_indicator": 0,        "bq_legal_entity_address1_type": "string",        "bq_legal_entity_address1_line_1": "string",        "bq_legal_entity_address1_line_2": "string",        "bq_legal_entity_address1_city": "string",        "bq_legal_entity_address1_state": "string",        "bq_legal_entity_address1_state_name": "string",        "bq_legal_entity_address1_county_fips": "string",        "bq_legal_entity_address1_county_name": "string",        "bq_legal_entity_fgn_address1_cntry": "string",        "bq_legal_entity_address1_zip5": "string",        "bq_legal_entity_address1_zip9": "string",        "bq_legal_entity_address1_zip_type": "string",        "bq_legal_entity_address1_latitude": 0,        "bq_legal_entity_address1_longitude": 0,        "bq_legal_entity_address1_summary": "string",        "bq_legal_entity_address1_rdi": "string",        "bq_legal_entity_address1_cbsa_name": "string",        "bq_legal_entity_address1_cbsa_code": "string",        "bq_legal_entity_address1_cbsa_type": "string",        "bq_legal_entity_address1_secondary_number": "string",        "bq_legal_entity_address1_dpv_match_code": "string",        "bq_legal_entity_address1_building_default_indicator": "string",        "bq_legal_entity_address1_administrative_area": "string",        "bq_legal_entity_address1_postal_code": "string",        "bq_legal_entity_address1_postal_code_ext": "string",        "bq_legal_entity_address1_country_code2": "string",        "bq_legal_entity_address1_country_code3": "string",        "extracted_on": "string"      }    ]  }}