TextKitDocs

Retrieve a verification

GET/v1/verify/{id}

Path Parameters

  • idstringrequired

Responses

  • 200Verification

    The 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: ver_a1B2c3D4e5F6g7H8.

  • objectverification
  • channelsms, email

    The channel the current code went out on

  • phonestring

    null on an email verification Nullable.

  • emailstring

    null until a code is emailed Nullable.

  • statuspending, approved, expired, max_attempts, blocked
  • attemptsinteger
  • testboolean
  • chargedboolean
  • created_atstring (date-time)
  • expires_atstring (date-time)
  • fallback_atstring (date-time)

    When the verification moved from text to email. Present only then.

  • customer_idstring

    The customer this is attributed to. Present only when set.

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