AM/TA/Inv - Get Issuing Legal Entity Details

Details

/external/v1/issuing-legal-entity

Synopsis

Get Issuing Legal Entity Details

get

This route is used to get the details of an issuing legal entity given a set of search filters. This endpoint is paginated, up to 20 records can be retrieved per call. This endpoint can be called by applications with access to scope "readIssuingLegalEntity".

Required scopes

This endpoint requires the following scopes:

• : readIssuingLegalEntity

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

legalEntityIdsFilterstringOptional

The comma delimited list of legal entity ids to filter the legal entity records. Up to 20 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

legalEntityCorrelationIdsFilterstringOptional

The comma delimited list of legal entity correlation ids to filter the legal entity records. Up to 20 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

legalEntityCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "legalEntityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully extracted the issuing legal entity details

application/json

descriptionstring · max: 500Optional

A description of the legal entity. Can be used to provide more context when the type is set to "Other"

Example: A custom legal entity type

taxIdstringOptional

The tax id of the legal entity.

incorporationDatestringOptional

This is the date in which the legal entity was incorporated. It is optional.

Example: 2024-09-12

incorporationCountrystring · min: 2 · max: 2Optional

Legal Entity's incorporation country ISO code. It is optional.

Example: US

incorporationStatestring · max: 100Optional

State code of legal entity's incorporation state. It can be provided to complement "incorporationCountry" information.If the country is the United States, the value should comply with ISO 3166-2:US standard.Available values: - US - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY - DC - AS - GU - MP - PR - UM - VI - AA - AE - AP - FM - MH - PW

Example: FL

isUsEntitybooleanOptional

True if the entity is considered a US entity, false otherwise.

domicileCountrystring · min: 2 · max: 2Optional

Legal Entity's domicile ISO country code. It is optional.

Example: US

jurisdictionCountrystring · min: 2 · max: 2Optional

Legal Entity's jurisdiction ISO country code. It is optional.

Example: US

jurisdictionStatestringOptional

Legal Entity's jurisdiction state. It can be provided to complement "jurisdictionCountry" information.If the country is the United States, the value should comply with ISO 3166-2:US standard.Available values: - US - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY - DC - AS - GU - MP - PR - UM - VI - AA - AE - AP - FM - MH - PW

Example: TX

countryIssuingTaxIdstring · min: 2 · max: 2Optional

The ISO code of the country that issued the taxId of this legal entity

Example: US

taxYearEndstringOptional

This field represents the end date of the tax year. It is a date field that specifies the final day of the tax year for accounting and tax reporting purposes. This field is used to determine the period for which financial records and tax calculations are applicable.

Example: 09-12

natureOfBusinessstring · max: 500Optional

This field represents the type or category of business activities that this legal entity is engaged in. This is used to classify the primary business operations and industry sector of the entity, which can be important for regulatory, tax, and reporting purposes.

Example: Semiconductor device fabrication

namestring · max: 500Optional

The name of the legal entity. It is optional if legalEntityId is provided. It is mandatory for new legal entities.

Example: Test Legal Entity

typeall ofOptional

The type of legal entity. It is optional if legalEntityId is provided. It is mandatory for new legal entities.

Example: LP

string · enumOptional

The type of legal entity. It is optional if legalEntityId is provided. It is mandatory for new legal entities.

Possible values:

legalEntityIdstring · max: 12Required

This is the id that uniquely identifies a legal entity. For new legal entity this should not be provided.

Example: US1G14EGN

statusall ofRequired

The status of the legal entity

Example: sync

string · enumOptional

The status of the legal entity

Possible values:

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/issuing-legal-entity

HTTPcURLJavaScriptPython

GET /external/v1/issuing-legal-entity HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "secureExtraData": {
      "some": "Sensitive Data"
    },
    "description": "A custom legal entity type",
    "taxId": "text",
    "address": {
      "addressLineOne": "8 Greenway Plaza",
      "addressLineTwo": "Suite 1515",
      "country": "US",
      "state": "Texas",
      "city": "Houston",
      "zipCode": "77046 USA"
    },
    "mailingAddress": {
      "addressLineOne": "8 Greenway Plaza",
      "addressLineTwo": "Suite 1515",
      "country": "US",
      "state": "Texas",
      "city": "Houston",
      "zipCode": "77046 USA"
    },
    "placeOfBusinessAddress": [
      {
        "addressLineOne": "8 Greenway Plaza",
        "addressLineTwo": "Suite 1515",
        "country": "US",
        "state": "Texas",
        "city": "Houston",
        "zipCode": "77046 USA"
      }
    ],
    "incorporationDate": "2024-09-12",
    "incorporationCountry": "US",
    "incorporationState": "FL",
    "isUsEntity": true,
    "domicileCountry": "US",
    "jurisdictionCountry": "US",
    "jurisdictionState": "TX",
    "contactInfo": [
      {
        "email": "[email protected]",
        "phoneNumber": "832-426-4242"
      }
    ],
    "countryIssuingTaxId": "US",
    "taxYearEnd": "09-12",
    "natureOfBusiness": "Semiconductor device fabrication",
    "name": "Test Legal Entity",
    "type": "LP",
    "fundInfo": {
      "name": "New fund name",
      "description": "Fund description",
      "type": "Hedge Fund",
      "strategy": "Early Stage",
      "taxReporting": "K-1",
      "is1031Eligible": true,
      "exemption": "REIT",
      "commoditiesInfo": {
        "CFTCRegisteredCommodityPoolOperator": true
      }
    },
    "legalEntityId": "US1G14EGN",
    "status": "sync",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    }
  }
]