Fetch Sub-Entity By Id
This endpoint retrieves the full profile of a specific sub-institution by its unique internal ID (passed as a path parameter) and the institution associated with the authentication token.
GET {{host}}/api/v1/institutions/fetch/sub-entity/{id}Content-Type: application/json
Response Message Field Description
| # | Field Name | Description |
|---|---|---|
| 1 | success | Indicates whether the request was successful (true for success) |
| 2 | responseCode | HTTP-like response code (e.g. 200 for success) |
| 3 | responseMessage | Human-readable result message (e.g. Success) |
| 4 | data | Object containing the sub-institution profile |
| 4.1 | data.id | Unique internal ID of the sub-entity |
| 4.2 | data.createdOn | Timestamp when the sub-institution was created (ISO 8601) |
| 4.3 | data.lastUpdatedOn | Timestamp of the most recent update to the sub-institution (ISO 8601) |
| 4.4 | data.institutionId | Unique internal ID of the institution associated to the sub-entity |
| 4.5 | data.institutionCode | Short unique code identifying the institution associated to the sub-entity |
| 4.6 | data.name | Name of the sub-entity |
| 4.7 | data.vaultId | Vault identifier associated with the sub-entity |
| 4.8 | data.kycStatus | KYC verification status of the sub-entity (e.g. DISABLED) |
| 4.9 | data.kycLevel | KYC tier level assigned to the sub-entity (e.g. TIER_1) |
| 4.10 | data.enabled | Indicates whether the sub-entity is currently active (true/false) |
| 4.11 | data.additionalInfo | JSON string containing extra metadata for the sub-entity (e.g. description, address) |
Updated about 11 hours ago
Did this page help you?