Sign in
Phone Numbers

Respond to the regulatory reviewer (message + corrections)

Send a single response to the reviewer on a number awaiting remediation: a free-text message and/or corrected requirement documents, in one call. If corrections are present they are PATCHed onto the requirement group and re-submitted (the number goes back to "in review"); if a message or file attachments are present they are posted to the reviewer's comment thread. When both are present, your message is the thread comment and the resubmit drives the state change. At least one of message, corrections, or attachments is required. documents correct requirement slots; attachments are loose files (their links are added to your message).

post/v1/phone-numbers/{id}/remediate/respond

Path parameters

idstring required

Request body

messagestring

Your message to the reviewer.

addressobject

A corrected address record, keyed to its requirement.

entityType'individual' | 'business' | 'null' nullable

Response

Response sent.

status'resubmitted' | 'replied'

resubmitted when corrections were submitted, replied when it was message-only.

postedboolean

Whether a message/attachments were posted to the reviewer.

siblingsResubmittedinteger

Other numbers on the same registration the correction fanned out to.

Changes

Changed in 3 of the 56 revisions of this API.8

  • 2c04683ce6944See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3e6ddf2a99ea2See the full diff
    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0dba7d004d752See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added