curl --request GET \
--url https://sandbox.finhub.cloud/api/v2.1/organization/shareholder/get/{organizationId} \
--header 'X-Forwarded-For: <x-forwarded-for>'
{
"success": true,
"message": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"role": "<string>",
"ownershipPercentage": 123,
"customerId": "<string>",
"organizationId": "<string>",
"status": "<string>",
"personDetails": {
"id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2022-03-10T00:00:00.000Z",
"nationality": "<string>",
"countryOfResidence": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"gender": "<string>",
"addresses": [
{
"id": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"purpose": "<string>",
"isPrimary": true,
"addressType": "<string>",
"primary": true
}
],
"documents": [
{
"id": "<string>",
"documentType": "<string>",
"documentNumber": "<string>",
"issuingCountry": "<string>",
"issueDate": "2022-03-10T00:00:00.000Z",
"expiryDate": "2022-03-10T00:00:00.000Z",
"purpose": "<string>",
"status": "<string>",
"fileUrl": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": "<string>",
"uploadedAt": "2022-03-10T00:00:00.000Z"
}
],
"placeOfBirth": "<string>"
},
"organizationDetails": {
"id": "<string>",
"tenantId": "<string>",
"name": "<string>",
"registrationNumber": "<string>",
"vatNumber": "<string>",
"countryOfIncorporation": "<string>",
"dateOfIncorporation": "2022-03-10T00:00:00.000Z",
"status": "<string>",
"type": "<string>",
"industry": "<string>",
"subIndustry": "<string>",
"size": "<string>",
"website": "<string>",
"addresses": [
{
"id": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"purpose": "<string>",
"isPrimary": true,
"addressType": "<string>",
"primary": true
}
],
"documents": [
{
"id": "<string>",
"documentType": "<string>",
"documentNumber": "<string>",
"issuingCountry": "<string>",
"issueDate": "2022-03-10T00:00:00.000Z",
"expiryDate": "2022-03-10T00:00:00.000Z",
"purpose": "<string>",
"status": "<string>",
"fileUrl": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": "<string>",
"uploadedAt": "2022-03-10T00:00:00.000Z"
}
],
"shareholders": [
{}
],
"createdAt": "2022-03-10T00:00:00.000Z",
"updatedAt": "2022-03-10T00:00:00.000Z"
}
}
]
}
Get shareholders for an organization
curl --request GET \
--url https://sandbox.finhub.cloud/api/v2.1/organization/shareholder/get/{organizationId} \
--header 'X-Forwarded-For: <x-forwarded-for>'
{
"success": true,
"message": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"role": "<string>",
"ownershipPercentage": 123,
"customerId": "<string>",
"organizationId": "<string>",
"status": "<string>",
"personDetails": {
"id": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2022-03-10T00:00:00.000Z",
"nationality": "<string>",
"countryOfResidence": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"gender": "<string>",
"addresses": [
{
"id": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"purpose": "<string>",
"isPrimary": true,
"addressType": "<string>",
"primary": true
}
],
"documents": [
{
"id": "<string>",
"documentType": "<string>",
"documentNumber": "<string>",
"issuingCountry": "<string>",
"issueDate": "2022-03-10T00:00:00.000Z",
"expiryDate": "2022-03-10T00:00:00.000Z",
"purpose": "<string>",
"status": "<string>",
"fileUrl": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": "<string>",
"uploadedAt": "2022-03-10T00:00:00.000Z"
}
],
"placeOfBirth": "<string>"
},
"organizationDetails": {
"id": "<string>",
"tenantId": "<string>",
"name": "<string>",
"registrationNumber": "<string>",
"vatNumber": "<string>",
"countryOfIncorporation": "<string>",
"dateOfIncorporation": "2022-03-10T00:00:00.000Z",
"status": "<string>",
"type": "<string>",
"industry": "<string>",
"subIndustry": "<string>",
"size": "<string>",
"website": "<string>",
"addresses": [
{
"id": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"purpose": "<string>",
"isPrimary": true,
"addressType": "<string>",
"primary": true
}
],
"documents": [
{
"id": "<string>",
"documentType": "<string>",
"documentNumber": "<string>",
"issuingCountry": "<string>",
"issueDate": "2022-03-10T00:00:00.000Z",
"expiryDate": "2022-03-10T00:00:00.000Z",
"purpose": "<string>",
"status": "<string>",
"fileUrl": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": "<string>",
"uploadedAt": "2022-03-10T00:00:00.000Z"
}
],
"shareholders": [
{}
],
"createdAt": "2022-03-10T00:00:00.000Z",
"updatedAt": "2022-03-10T00:00:00.000Z"
}
}
]
}
Forwarded client IP address
Client user agent information
Tenant identifier for multi-tenant operations
OK
The response is of type object
.