This route is used to get the history data entries of issuing legal entity given a set of filters such as blockchain details or legal entity identifiers.
The history entries will reflect the state of the legal entities on a particular block on the ledger.
This endpoint returns paginated data. Up to 20 can be extracted per call.
This endpoint can be called by applications with access to scope "readIssuingLegalEntity".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350
The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JH
Pattern: ^[a-zA-Z0-9-]*$
The name of the channel where the action was recorded on the ledger.
OG123
Pattern: ^[a-zA-Z0-9-]*$
The comma delimited list of legal entity ids to filter the legal entity history records. Up to 20 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01
The comma delimited list of legal entity correlation ids to filter the legal entity history records. Up to 20 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890
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.
GET /external/v1/issuing-legal-entity/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"update": {
"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"
}
},
"hash": "$argon2id$v=19$m=4096,t=3,p=1$8AVpNOnlBvN/reiv7Rdkpw$lzXOuG0H4SibMa0elrEZ5sq3YAvdu+Y5L+ta0oSSMTg"
}
]