Skip to main content

Check Storefront Domain TXT Record (v1)

Method & Path​

GET /api/v1/workspace/:workspaceId/storefront/domain/:domainId/check-txt

Description​

Check if the verification TXT record exists in DNS. This endpoint is used for polling to check verification status without triggering full verification.

Authentication​

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with store.manage permission.

Headers​

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
domainIdstringYesDomain identifier

Response 200 OK​

{
  "found": true,
  "shouldPoll": false,
  "error": null,
  "actualRecords": [
    "google-site-verification=abc123"
  ]
}

Response when TXT record not found​

{
  "found": false,
  "shouldPoll": true,
  "error": null,
  "actualRecords": []
}

Response Fields​

  • found (boolean): Whether the verification TXT record was found
  • shouldPoll (boolean): Whether frontend should continue polling (true if not found)
  • error (string | null): Error message if DNS check failed
  • actualRecords (string[]): Array of actual TXT records found for the domain

Common Errors​

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have store.manage permission

404 Not Found: Workspace or domain not found

500 Internal Server Error: Server error occurred while processing the request

Notes​

  • This endpoint is optimized for polling (lightweight DNS check)
  • Frontend should poll every 10-30 seconds when shouldPoll is true
  • Stop polling when found is true or shouldPoll is false