Skip to main content
POST
Add Profile Comment

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Path Parameters

profileId
string
required

Profile ID that should receive the comment.

Body

application/json

Profile comment creation request

Request body for adding an analyst comment to a profile. Use kind to indicate whether the note is profile-level or tied to a potential match.

text
string
required

Comment text. Must be a non-empty string.

Example:

"Reviewed the sanctions hit and determined it is a false match because the date of birth does not align."

kind
enum<string>
required

Comment category. Use profile for a general profile note or match for a potential match note.

Available options:
profile,
match
Example:

"profile"

matchId
string

Optional potential match ID to associate with the comment when kind is match.

Example:

"665f1c2b16f5adbb8e1d3f41"

Response

201 - application/json

Comment created successfully

msg
string
Example:

"OK"

result
object
status
integer
Example:

201