TextKitDocs

Get a toll-free verification

Its status, the form, what would get it sent back (problems), its business, and the carriers' answer (rejection.reason) when it was sent back.

GET/v1/toll-free-verifications/{id}

Path Parameters

  • idstringrequired

    Example: tfv_a1B2c3D4e5F6.

Responses

  • 200TollFreeVerification

    Toll-free verification

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404Error

    Not found

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: tfv_a1B2c3D4e5F6.

  • objecttoll_free_verification
  • statusdraft, in_review, submitted, verified, rejected

    draft: not submitted. in_review: our team is checking it by hand; nothing has gone to the carriers yet. submitted: we sent it to the carriers; waiting on their answer. verified: its numbers text anyone who opted in. rejected: sent back; rejection.reason says why.

  • numbersarray of string
  • business_namestring
  • readyboolean

    Nothing the carriers require is missing (problems is empty).

  • problemsarray of object

    What the carriers would send it back for, one entry per answer to fix.

  • problems[].fieldstring

    Example: ein.

  • problems[].messagestring
  • editableboolean

    Whether PATCH may change it now (draft, in_review and rejected).

  • next_actoryou, textkit, carriers, nobody

    Who acts next.

  • formTollFreeVerificationInput

    The form as it stands, every field. contact_email is always our support address: the carriers write to us, and we forward what only you can answer.

  • businessobject

    The business on the form, as business verification sees it. Nullable.

  • business.statusnot_started, pending, verified, rejected
  • business.attestation_neededboolean

    Submit needs an attestation for these business details.

  • business.signedobject

    Nullable.

  • business.signed.signer_namestring
  • business.signed.signer_titlestring
  • business.signed.signed_atstring (date-time)
  • business.rejectionobject

    Nullable.

  • business.rejection.codestring
  • business.rejection.notestring

    Nullable.

  • rejectionobject

    Set while rejected: what the carriers or our team asked for. Nullable.

  • rejection.reasonstring
  • rejection.rejected_atstring (date-time)
  • carrier_referencestring

    The carriers' case number, once they give one. Nullable.

  • registration_idstring

    The registration it was filled in from, if any. Nullable.

  • historyarray of object
  • history[].atstring (date-time)
  • history[].statusdraft, in_review, submitted, verified, rejected
  • history[].actorcustomer, staff, system, carrier
  • history[].notestring

    Nullable.

  • created_atstring (date-time)
  • updated_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404

    Not found

  • 429

    Rate limit or quota exceeded