This route is used to add a comment associated to entities. This action can be broadcast to all the counterparties that have access to these entities.
This will trigger an asynchronous process which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageComments".
This property contains the transactional data information
{"signer":{"email":"[email protected]","name":"John Doe"},"extraData":{"someCustom":"property to be shared"}}This property defines if the comment information will be sent to all counterparties.
falseExample: trueThis property contains the counterparties that will receive the comment information. It is optional.
If not provided it will be sent to all counterparties that are entitled to the entity this comment is related to.
["ORG1","ORG2"]This is the booked unique identifier of the comment. It is optional.
USS3JKS01I00SW24This property contains the comment message. It is optional. Should be provided if no documents are attached.
an example comment messageThe list of entities to associate to the comment
{"assetIds":["US9QIASSET1","US9QIASSET2"]}POST /external/v1/comment HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 710
{
"transactionData": {
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"extraData": {
"someCustom": "property to be shared"
}
},
"broadcastToCounterparty": true,
"counterparties": [
"ORG1",
"ORG2"
],
"bookedCommentId": "USS3JKS01I00SW24",
"message": "an example comment message",
"associatedEntities": {
"assetIds": [
"US9QIASSET1",
"US9QIASSET2"
]
},
"documents": [
{
"uploadData": {
"type": "IdentityVerification",
"extension": "pdf",
"name": "John Doe ID",
"link": "https://test-storage.s3.amazonaws.com/some-id.pdf",
"correlationData": [
{
"broadcastToCounterparty": true,
"correlationId": "123245573717",
"origin": "Identifies file on backoffice",
"extraData": {
"some": "Custom Property"
}
}
]
},
"extraData": {
"someCustom": "property to be shared"
}
}
]
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}