This route is used to trigger the creation of a list of NAV records for unitized instruments on the blockchain for a particular security.
It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.
This can be called either by the issuer organization that owns the security or by an assigned fund administrator to update the new price per share.
This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"].
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can't be invoked if the security is restricted.
This endpoint can't be invoked if the security is share class.
This endpoint can be called by applications with access to scope "manageNAV".
This property contains the transactional data information, i.e. the security id to which all the NAVs in the list belong to
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}POST /external/v1/nav-reporting/batch-create HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"navData": [
{
"securityId": "USS3JKS01I00",
"navRecords": [
{
"date": "2024-09-12",
"price": 10.123456
},
{
"date": "2024-09-13",
"price": 10.123459
}
]
}
]
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the update a list of NAV records for unitized instruments on the blockchain for a particular security.
It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.
This can be called either by the issuer organization that owns the security or by an assigned fund administrator to update the new price per share.
This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"].
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "manageNAV".
This property contains the transactional data information, i.e. the security id to which all the NAVs in the list belong to
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/nav-reporting/batch-update HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"navData": [
{
"securityId": "USS3JKS01I00",
"navRecords": [
{
"date": "2024-09-12",
"price": 10.123456
},
{
"date": "2024-09-13",
"price": 10.123459
}
]
}
]
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger delete a list of NAV records for unitized instruments on the blockchain for a particular security.
It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.
This can be called either by the issuer organization that owns the security or by an assigned fund administrator to update the new price per share.
This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"].
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "manageNAV".
This property contains the transactional data information, i.e. the security id to which all the NAVs in the list belong to
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/nav-reporting/batch-delete HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"navData": [
{
"securityId": "USS3JKS01I00",
"timestamps": [
"2024-09-13",
"2024-09-15"
]
}
]
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to retrieve active nav(s) given a set of filters such as security identifiers or date range.
This endpoint returns paginated data. Up to 500 can be extracted per call.
This endpoint can be called by applications with access to scope "readNAV".
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 start date from which the nav records are to be retrieved.
The end date until which the nav records are to be retrieved.
The comma delimited list of security ids to filter the nav records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the nav records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/nav-reporting HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"price": 100,
"timestamp": "2024-09-12",
"status": "published",
"securityId": "USS3JKS01I00"
}
]This route is used to retrieve the history data entries of nav(s) given a set of filters such as blockchain details or security identifiers.
The history entries will reflect the state of the nav(s) on a particular block on the ledger.
This endpoint returns paginated data. Up to 500 can be extracted per call.
This endpoint can be called by applications with access to scope "readNAV".
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.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of security ids to filter the nav records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the nav records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/nav-reporting/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"securityId": "USS3JKS01I00",
"timestamp": "2024-09-12",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"update": {
"status": "published",
"price": 100,
"timestamp": "2023-02-27"
},
"event": "Created",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"signerData": {
"email": "[email protected]",
"name": "John Doe",
"id": "[email protected]_TEST1234"
}
}
]