Skip to main content

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_request
METHOD
POST

Path Params

FieldTypeDescriptionMax Characters
INVESTOR-KEY *stringUnique investor key (UUID v4).36

Request Body

No request body is required.


Response

STATUS
201
Response 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

FieldTypeDescriptionMax Characters
data_access_request_key *stringUnique access request key (UUID v4).36
requested_at *stringDate and time of the request (ISO 8601 format).-
responded_atstringDate and time of the response to the request, if already responded.-
data_access_request_status *stringRequest 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_request
METHOD
GET

Path Params

FieldTypeDescriptionMax Characters
INVESTOR-KEY *stringUnique investor key (UUID v4).36

Response

STATUS
200
Response 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

FieldTypeDescriptionMax Characters
data_access_request_key *stringUnique access request key (UUID v4).36
requested_at *stringDate and time of the request (ISO 8601 format).-
responded_atstringDate and time of the response to the request, if already responded.-
data_access_request_status *stringRequest status.data_access_request_status Enumerators

data_access_request_status Enumerators

EnumDescription
in_analysisThe request is under analysis by the investor.
approvedAccess was approved and the client can view the investor's data.
reprovedThe request was denied and the client will not be able to access the investor's data.