Standard API Response Object

Standard Response Format

All API responses use a simple, consistent envelope so your integration can handle results the same way across endpoints.

• status: "success" or "failure" indicating the overall result.
• message: A short, human-friendly description (for example, "Verified successfully", "Addresses retrieved", "Email processed successfully", or "Invalid request parameters").
• data: The returned object for successful requests. Example shapes in this API:
  • /ext/verify: an object with foundNumbers and notFoundNumbers arrays.
  • /ext/reach: a mapping of mobile numbers to arrays of Address objects.
  • /ext/notify: a confirmation object containing to, subject, and eventId.
  This field may be absent for some responses.
• errors: An array of detailed error messages when a request fails (validation errors, missing fields, etc.).
• correlationId: A unique identifier for the request you can share with support to speed troubleshooting.
• timestamp: The date and time the request was processed in ISO 8601 UTC (for example, "2024-09-01T10:15:30Z").