Get SMTP Setting

---

Get the partner's shared SMTP setting, used to send mail for every linked company.

Endpoint

Property	Value
URL	GET /white-label-partner/smtp-setting
Method	GET
Auth	R-Auth: <partner-jwt>
Base URL	Stage Environment https://api-stage.docnova.ai/ Production Environment https://api.docnova.ai/

Example Request

curl --location '{{baseUrl}}/white-label-partner/smtp-setting' \
--header 'accept: */*' \
--header 'R-Auth: {{partnerJwt}}'

Request fields

This endpoint takes no parameters or request body.

Response

{
  "createdAt": "2026-01-15T12:00:00.000Z",
  "fromEmail": "noreply@example.com",
  "host": "smtp.example.com",
  "id": "f5e6d7c8-1234-5678-9abc-def012345678",
  "passwordMasked": "********",
  "port": 587,
  "securityProtocol": "TLS",
  "username": "{{username}}"
}

Response fields

Field	Type	Description
id	string (UUID)	Unique identifier of the SMTP setting
fromEmail	string	Sender address shown on outgoing emails
host	string	SMTP server host
port	number	SMTP server port
username	string	SMTP authentication username
passwordMasked	string	Masked SMTP password; the actual password is never returned
securityProtocol	string (enum)	Connection security protocol. See the reference table below.
createdAt	string (ISO 8601)	Time the SMTP setting was created

Security protocol values

Value	Description
NONE	Unencrypted connection
SSL	SSL/TLS encrypted connection (typically port 465)
TLS	Connection upgraded to TLS via STARTTLS (typically port 587)

Response Codes

Code	Description
200	OK — Returns the partner's SMTP setting (see Response above for an example)
401	Unauthorized — R-Auth header missing or invalid
403	Forbidden — Partner is not authorized for this operation
404	Not Found