AM/FA - Create Batch NAV Unitized

Details

/external/v1/nav-reporting/batch-create

Synopsis

Create batch NAV Unitized

post

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".

Required scopes

This endpoint requires the following scopes:

• : manageNAV

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. the security id to which all the NAVs in the list belong to

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

Responses

201

Successfully triggered the process to create a list of NAV records.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

400

The following error codes can be returned: - GN0002 - IS0008 - IS0003 - NV0005 - NV0007 - NV0014 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 - IS0099 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - IS0009 - NV0007 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0119 - IS0013 - IS0010 - IS0003 - IS0012 - IS0117 - NV0002 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/nav-reporting/batch-create

HTTPcURLJavaScriptPython

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"
}