This API retrieves comprehensive sender profile information including server data, domain authentication records (SPF, DKIM, Return Path), and email deliverability settings. Essential for monitoring email authentication status and ensuring optimal deliverability.

💡 Pro Tip

Use this API to monitor your email authentication status and troubleshoot deliverability issues. Check the verification status of SPF, DKIM, and Return Path records to ensure your emails are properly authenticated and reach recipients' inboxes.

Request Endpoint: https://app.zyntrohq.com/apis/public/fetchSenderRecords.php

Request Method: POST

Request Payload:

{
  "api_key": "your_zyntro_api_key",
  "org_id": "your_organization_id",
  "brand_id": "your_brand_id"
}

Response (JSON):

{
  "status": "success",
  "data": {
    "server_id": "server_unique_id",
    "inbound_address": "[email protected]",
    "sending_domain": "yourdomain.com",
    "spf_verified": true,
    "spf_record": "v=spf1 include:spf.postmarkapp.com ~all",
    "dkim_verified": true,
    "dkim_key": "pm._domainkey.yourdomain.com",
    "dkim_value": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC...",
    "return_path_domain": "bounce.yourdomain.com",
    "return_path_verified": true,
    "return_path_record": "pm-bounces.yourdomain.com"
  }
}

Response Fields:

  • status: Indicates success or error status
  • data: Object containing sender profile information
  • server_id: Unique identifier for the email server
  • inbound_address: Inbound email address for receiving emails
  • sending_domain: Domain used for sending emails
  • spf_verified: SPF record verification status (boolean)
  • spf_record: SPF record text value
  • dkim_verified: DKIM record verification status (boolean)
  • dkim_key: DKIM key hostname
  • dkim_value: DKIM key text value
  • return_path_domain: Return path domain for bounces
  • return_path_verified: Return path domain verification status (boolean)
  • return_path_record: Return path CNAME record value

Required Fields:

  • api_key: Zyntro API authentication key
  • org_id: Organization identifier (UUID format)
  • brand_id: Brand identifier (numeric format)

Developer Recommendations

🔧 DNS Configuration Best Practices

DKIM Key Verification:

  • Check DNS propagation of your DKIM keys using https://dkimcore.org/c/keycheck
  • Verify that your DKIM key is properly propagated across all DNS servers
  • Ensure the DKIM key format is correct and matches the expected value

DMARC Policy Setup:

  • Set up a DMARC policy for your sending domain or top-level domain
  • Start with a monitoring policy (p=none) to analyze email authentication results
  • Gradually move to quarantine (p=quarantine) and then reject (p=reject) policies
  • Monitor DMARC reports to identify and fix authentication issues

SPF Record Management:

  • Ensure your SPF record includes all authorized sending sources
  • Keep SPF record under 10 DNS lookups to avoid SPF failures
  • Use SPF record flattening tools if you have multiple includes
  • Regularly audit SPF records to remove unused sources

Return Path Configuration:

  • Verify that your return path domain is properly configured
  • Ensure CNAME records are correctly set up for bounce handling
  • Test bounce processing to ensure proper handling of undeliverable emails

Email Authentication Explained:

  • SPF (Sender Policy Framework): Verifies that emails are sent from authorized servers
  • DKIM (DomainKeys Identified Mail): Adds a digital signature to verify email authenticity
  • Return Path: Specifies where bounces and delivery notifications should be sent
  • DMARC (Domain-based Message Authentication): Policy framework that builds on SPF and DKIM

Notes:

  • This is a public API and requires an API Key. You can get your API Key from inside your Zyntro Account under Me > API Keys
  • Ensure that the api_key, org_id, and brand_id are valid and correspond to your Zyntro account credentials
  • The org_id should correspond to an existing organization within your account
  • The brand_id should correspond to an existing brand within your organization
  • Organization must be active for API calls to be processed successfully
  • Sender profile must be set up before this API can return data
  • All verification statuses are boolean values (true/false)
  • Use this API to monitor email authentication status and troubleshoot deliverability issues
  • Regular monitoring of authentication records helps maintain high email deliverability rates
  • Contact support if sender profile appears corrupted or cannot be retrieved