Phone Numbers

Get a line reputation audit

Returns the audit's status and, once complete, the report. Audits are scoped to the line in the URL — an auditId started on a different line returns 404.

get/v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId}

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/phone_numbers/{phoneNumber}/reputation_audit/{auditId}
  • Auth: HTTP bearer

Path parameters

phoneNumberstring required

The line in E.164 format.

auditIdstring required

The audit_id returned when the audit was started. Audits are retained for 24 hours.

Response

Audit retrieved

audit_idstring required
phonestring

The line audited, E.164.

status'pending' | 'complete' | 'error' required

pending until the report is ready — poll until complete or error.

generated_atstring date-time

When the report was generated; signals reflect the line at this moment.

errorstring

Present only when status is error. Short, generic reason safe to display.

Example response

{
  "report": {
    "severity": "HEALTHY",
    "summary_markdown": "## Line reputation summary\n\n**Status:** AT_RISK\n..."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.