Documents and Notes

Embarc provides two extensions for every major entity—notes
(free-form commentary) and documents (file attachments). You can use them
with customers, loans, transactions, or any entity the API exposes.

Notes

Purpose: Capture commentary, call logs, underwriting decisions, or any
text you want to persist with the record.
API pattern: POST /<entity>/<id>/notes

Example – add a note to a customer

POST /clients/9876/notes
{
  "note": "Customer confirmed phone number and provided updated address."
}

Fetch notes: GET /clients/9876/notes
Update note: PUT /clients/9876/notes/{noteId}
Delete note: DELETE /clients/9876/notes/{noteId}

Works everywhere: Swap clients with loans, accounts,
etc., to attach notes to other entities.

Documents (File Attachments)

Purpose: Store contracts, KYC files, collateral images, signed
agreements, or any other supporting files.
API pattern: POST /<entity>/<id>/documents (multipart upload).

Example – upload a document for a customer

POST /clients/9876/documents
Content-Type: multipart/form-data

[email protected];type=application/pdf
name=Government ID
description=Scanned passport (2025 renewal)

List documents: GET /clients/9876/documents
Download: GET /clients/9876/documents/{documentId}/attachment
Update metadata or file: PUT /clients/9876/documents/{documentId}
Delete: DELETE /clients/9876/documents/{documentId}

Same infrastructure for loans: Use loans/{loanId}/documents to attach
promissory notes, collateral appraisals, or payout proofs. All other entities
follow the same pattern.

Practical Tips

Permission control: Notes and documents respect Embarc’s role-based
permissions. Ensure only authorised roles can view or upload sensitive
content.
Metadata first: Use meaningful titles and descriptions so notes/
documents remain searchable.
Audit-ready: Both notes and document operations show up in the audit
trail, keeping compliance simple.

With a single API pattern, you can enrich customers, loans, and other records
with commentary and attachments.