AM/TA/Inv - Get Comment Details

Details

/external/v1/comment

Synopsis

Get Comment Details

get

This route is used to retrieve the details of an comment, given a set of search filters. This endpoint can be called by applications with access to scope "readComments".

Required scopes

This endpoint requires the following scopes:

• : readComments

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

assetIdsFilterstringOptional

The comma delimited list of asset ids to filter the comment records. Up to 50 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

assetCorrelationIdsFilterstringOptional

The comma delimited list of asset correlation ids to filter the comment records. Up to 50 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

assetCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "assetCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

commentIdsFilterstringOptional

The comma delimited list of comment ids to filter the comment records. Up to 250 records can be provided. Each record should not exceed 16 characters.

Example: USCCWSF01I00,USCCWSF01I01

Responses

200

Successfully retrieved the Comment details

application/json

commentIdstringRequired

The id of the comment

Example: US9QICOMMENT1

replyToCommentIdstringOptional

The id of the comment that this comment is replying to

Example: US9QICOMMENT1

messagestringOptional

The message content of the comment

Example: This is a comment

statusall ofRequired

The status of the comment. - preSync - interim status while the comment is being published to the blockchain - noBroadcast - when a comment is internal for the current organization and not broadcast to any counterparty - broadcast - the comment was successfully published to the blockchain and broadcast to all counterparties - deleted - the comment failed to be published and was marked as deleted

Example: broadcast

string · enumOptional

The status of the comment. - preSync - interim status while the comment is being published to the blockchain - noBroadcast - when a comment is internal for the current organization and not broadcast to any counterparty - broadcast - the comment was successfully published to the blockchain and broadcast to all counterparties - deleted - the comment failed to be published and was marked as deleted

Possible values:

viewOrgsstring[]Optional

The unique identifiers of the organizations that can view the comment

Example: ["US9QIORG1","US9QIORG2"]

fileIdsstring[]Optional

The list of unique identifiers of the files that were attached to this comment. The "Files API" can be used to get the details regarding these files.

Example: ["US9QIFILE1","US9QIFILE2"]

typeall ofRequired

The type of comment.

Example: review

string · enumOptional

The type of comment.

Possible values:

categoryall ofOptional

An optional category that can be used to classify the issue found. Only applicable for comments of type review. EC001 - Tax Document Deficiencies. EC002 - Investor Information & AML/KYC Issue(s). EC003 - Sub Doc Issue(s) EC004 - Account information Issue(s) EC005 - Trade data Issue(s) EC006 - Other Issue(s)

Example: EC002

string · enumOptional

An optional category that can be used to classify the issue found. EC001 - Tax Document Deficiencies. EC002 - Investor Information & AML/KYC Issue(s). EC003 - Sub Doc Issue(s) EC004 - Account information Issue(s) EC005 - Trade data Issue(s) EC006 - Other Issue(s)

Possible values:

reviewStatusall ofOptional

The review status of the comment. It will only be present for comments of type review. - draft - comment is being drafted as part of the asset review process. - pending - initial status, it is pending a reply/fix from the counterparty. - fix_provided - the party that needs to address the review comment (e.g. remediation comment) has done it and signals as such to the reviewer. - fixRejected - the reviewer acknowledges that the comment is NOT resolved. This can be used for a second "remediation request" after a remediation where the "pending" comment was incorrectly marked as fixed. - declined - the party that needs to address the review comment (e.g. remediation comment) declines to do so. This action is usually accompanied by a reply comment explaining why. - resolved - the reviewer acknowledges that the comment is resolved or no longer applicable. - not_resolved - the reviewer marks the comment as unresolved (e.g. when an asset is rejected because a comment failed to be properly addressed).

Example: resolved

string · enumOptional

The review status of the comment. It will only be present for comments of type review. - draft - comment is being drafted as part of the asset review process. - pending - initial status, it is pending a reply/fix from the counterparty. - fix_provided - the party that needs to address the review comment (e.g. remediation comment) has done it and signals as such to the reviewer. - fixRejected - the reviewer acknowledges that the comment is NOT resolved. This can be used for a second "remediation request" after a remediation where the "pending" comment was incorrectly marked as fixed. - declined - the party that needs to address the review comment (e.g. remediation comment) declines to do so. This action is usually accompanied by a reply comment explaining why. - resolved - the reviewer acknowledges that the comment is resolved or no longer applicable. - not_resolved - the reviewer marks the comment as unresolved (e.g. when an asset is rejected because a comment failed to be properly addressed).

Possible values:

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 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 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 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/comment

HTTPcURLJavaScriptPython

GET /external/v1/comment HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "commentId": "US9QICOMMENT1",
    "replyToCommentId": "US9QICOMMENT1",
    "message": "This is a comment",
    "userInfo": {
      "name": "John Doe",
      "email": "[email protected]",
      "team": "Compliance"
    },
    "status": "broadcast",
    "viewOrgs": [
      "US9QIORG1",
      "US9QIORG2"
    ],
    "fileIds": [
      "US9QIFILE1",
      "US9QIFILE2"
    ],
    "type": "review",
    "category": "EC002",
    "flaggedDocument": {
      "document": {
        "fileId": "FILE3JUS03I04"
      },
      "details": {
        "issueType": "mismatch",
        "pageNumber": 1,
        "additionalNotes": "The signature on the top of the page is different than expected according to the provided ID document"
      }
    },
    "reviewStatus": "resolved",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "associatedEntities": {
      "assetIds": [
        "US9QIASSET1",
        "US9QIASSET2"
      ]
    }
  }
]