AM/FA/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

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
Host: 
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"
    }
  }
]