Create a note

POST

/api/v1/notes

Authorizations

• apiKey

Request Body^required

Media type application/json

object

content

required

Content of the note

string

>= 1 characters

attachments

File attachments

Array<object>

object

key

required

S3 key of the attachment

string

fileName

required

Original file name

string

contentType

required

MIME type of the file

string

fileUrl

required

URL to access the file

string

entityType

required

Type of parent entity this note is attached to

string

Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION AUDIT_LOG

entityId

required

ID of the parent entity

string

Examples

{
  "content": "",
  "entityType": "APPLICATION",
  "entityId": "507f1f77bcf86cd799439011"
}

{
  "content": "Applicant confirmed ownership structure during call",
  "attachments": [
    {
      "key": "uploads/uuid_document.pdf",
      "fileName": "document.pdf",
      "contentType": "application/pdf",
      "fileUrl": "https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf"
    }
  ],
  "entityType": "APPLICATION",
  "entityId": "507f1f77bcf86cd799439011"
}

Responses

201

Note created successfully

Media type application/json

object

id

required

Note ID

string

entityType

required

Type of parent entity this note belongs to

string

Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION AUDIT_LOG

entityId

required

ID of the parent entity

string

content

required

Content of the note

string

attachments

required

File attachments

Array<object>

object

key

required

S3 key of the attachment

string

fileName

required

Original file name

string

contentType

required

MIME type of the file

string

fileUrl

required

URL to access the file

string

createdBy

required

ID of the user who created the note

string

updatedBy

ID of the user who last updated the note

string

createdByUser

required

User who created the note

object

firstName

required

First name of the user

string

lastName

required

Last name of the user

string

email

required

Email address of the user

string

updatedByUser

User who last updated the note

object

firstName

required

First name of the user

string

lastName

required

Last name of the user

string

email

required

Email address of the user

string

createdAt

required

Date the note was created

string format: date-time

updatedAt

required

Date the note was last updated

string format: date-time

stewardOnly

required

True when the note was written as Steward-only and stays off the client feed. Customer writes cannot set it.

boolean

sourceLabel

Label for the parent entity, for cross-entity listings that render notes from several sources in one feed. The document file name for DOCUMENT notes, “Screening” for SCREENING_HIT notes, the annotated event headline for AUDIT_LOG notes, null for APPLICATION notes. Only populated by the by-application listing.

string

nullable

sourceLinkId

ID the client needs to navigate back to the note’s source. The document ID for DOCUMENT notes; for SCREENING_HIT notes the screened entity (individual or business) ID, which is what the Screening tab keys its deep link on, not the hit ID; for AUDIT_LOG notes the audit entry ID, which the Audit Log tab opens off ?auditLogId=. Null for APPLICATION notes. Only populated by the by-application listing.

string

nullable

Examples

{
  "id": "507f1f77bcf86cd799439011",
  "entityType": "APPLICATION",
  "entityId": "507f1f77bcf86cd799439011",
  "content": "Applicant confirmed ownership structure during call",
  "attachments": [],
  "createdBy": "60d5ecb54b24003a7c8e92b2",
  "createdByUser": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com"
  },
  "createdAt": "2026-03-30T12:00:00.000Z",
  "updatedAt": "2026-03-30T12:00:00.000Z",
  "stewardOnly": false,
  "sourceLabel": null,
  "sourceLinkId": null
}

{
  "id": "507f1f77bcf86cd799439011",
  "entityType": "APPLICATION",
  "entityId": "507f1f77bcf86cd799439011",
  "content": "Applicant confirmed ownership structure during call",
  "attachments": [
    {
      "key": "uploads/uuid_document.pdf",
      "fileName": "document.pdf",
      "contentType": "application/pdf",
      "fileUrl": "https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf"
    }
  ],
  "createdBy": "60d5ecb54b24003a7c8e92b2",
  "updatedBy": "60d5ecb54b24003a7c8e92b2",
  "createdByUser": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com"
  },
  "updatedByUser": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@example.com"
  },
  "createdAt": "2026-03-30T12:00:00.000Z",
  "updatedAt": "2026-03-30T12:00:00.000Z",
  "stewardOnly": false,
  "sourceLabel": null,
  "sourceLinkId": null
}

404

Parent entity not found