Investor Data Access Request
Clients who registered an investor that already has a unique registration need to request access to the investor's data so they can issue operations with that investor as a party.
When making this request, the investor will receive an email with instructions to approve or deny access.
Access Request (POST)
Request
ENDPOINT
/investor_management/investor/INVESTOR-KEY/data_access_requestMETHOD
POSTPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
INVESTOR-KEY * | string | Unique investor key (UUID v4). | 36 |
Request Body
No request body is required.
Response
STATUS
201Response Body
{
"data_access_request_key": "6beb9e44-1513-4d3b-9af5-f3c39ebbf2d0",
"requested_at": "2025-02-22T10:45:49.609517",
"responded_at": null,
"data_access_request_status": "in_analysis"
}
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
data_access_request_key * | string | Unique access request key (UUID v4). | 36 |
requested_at * | string | Date and time of the request (ISO 8601 format). | - |
responded_at | string | Date and time of the response to the request, if already responded. | - |
data_access_request_status * | string | Request status. | data_access_request_status Enumerators |
Request Status Query (GET)
Clients can check if their request was approved, denied or is still under analysis.
Request
ENDPOINT
/investor_management/investor/INVESTOR-KEY/data_access_requestMETHOD
GETPath Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
INVESTOR-KEY * | string | Unique investor key (UUID v4). | 36 |
Response
STATUS
200Response Body
[
{
"data_access_request_key": "6beb9e44-1513-4d3b-9af5-f3c39ebbf2d0",
"requested_at": "2025-02-22T10:45:49.609517",
"responded_at": null,
"data_access_request_status": "in_analysis"
}
]
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
data_access_request_key * | string | Unique access request key (UUID v4). | 36 |
requested_at * | string | Date and time of the request (ISO 8601 format). | - |
responded_at | string | Date and time of the response to the request, if already responded. | - |
data_access_request_status * | string | Request status. | data_access_request_status Enumerators |
data_access_request_status Enumerators
| Enum | Description |
|---|---|
in_analysis | The request is under analysis by the investor. |
approved | Access was approved and the client can view the investor's data. |
reproved | The request was denied and the client will not be able to access the investor's data. |