Iterable

Iterable Verify API

The Verify API from Iterable — 2 operation(s) for verify.

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/verify/sms/begin Send an SMS verification code · Begin SMS Verification #
Ask an LLM
“How do I text a verification code to a phone number?”
“Which verification profile controls the code that gets sent?”
Tell an agent
Send a verification code to {phoneNumber} using profile {verificationProfileId}.
Begin SMS verification for {phoneNumber} with profile {verificationProfileId}.
POST /api/verify/sms/check Check an SMS verification code · Check SMS Verification Code #
Ask an LLM
“Is the code the user typed the right one for their phone?”
“Do expired verification codes still pass the check?”
Tell an agent
Check code {code} for {phoneNumber} under profile {verificationProfileId}.
Verify that {phoneNumber} entered {code} for profile {verificationProfileId}.

Documentation

📖
Documentation
https://api.iterable.com/api/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/iterable/refs/heads/main/openapi/iterable-verify-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/iterable:iterable-verify-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

iterable-verify-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  termsOfService: https://iterable.com/terms/
  title: Iterable Verify API
  version: '1.8'
servers:
- url: https://api.iterable.com/
security:
- api_key: []
tags:
- name: Verify
paths:
  /api/verify/sms/begin:
    post:
      description: 'Sends an SMS verification code to phoneNumber, using the specified verificationProfileId. Verification codes are sent from a pool of sender IDs reserved for this use, not from your sender IDs. Because of this, you don''t need to worry about competing message priority or throughput.


        Call this endpoint only for projects that use Iterable SMS to send SMS messages. If you use your own Twilio or Telnyx account, call their verification endpoints directly.


        To use this endpoint, first ask your Iterable customer success manager to add SMS phone verification to your project. To learn more, read SMS Phone Verification.'
      operationId: beginSmsVerification
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IterableApiResponse'
        '400':
          description: Invalid parameters
        '401':
          description: Invalid API key
      summary: Begin SMS Verification
      tags:
      - Verify
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeginSmsVerificationRequest'
        description: The number to authenticate
        required: true
  /api/verify/sms/check:
    post:
      description: 'Checks whether the code included in the request body matches the most recent, non-expired, not-yet-verified SMS verification code sent to phoneNumber by the specified verificationProfileId.


        If code is correct, the endpoint returns a 200 response with a JSON body that has a params object with status set to verified.


        If code is incorrect, the endpoint returns a 200 response with a JSON body that has a params object with status set to rejected.


        Call this endpoint only for projects that use Iterable SMS to send SMS messages. If you use your own Twilio or Telnyx account, call their verification endpoints directly.


        To use this endpoint, first ask your Iterable customer success manager to add SMS phone verification to your project. To learn more, read SMS Phone Verification.'
      operationId: checkSmsVerification
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IterableApiResponse'
        '400':
          description: Invalid parameters
        '401':
          description: Invalid API key
      summary: Check SMS Verification Code
      tags:
      - Verify
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckSmsVerificationRequest'
        description: The number to authenticate
        required: true
components:
  schemas:
    BeginSmsVerificationRequest:
      properties:
        phoneNumber:
          type: string
        verificationProfileId:
          format: int64
          type: integer
      required:
      - phoneNumber
      - verificationProfileId
      type: object
    CheckSmsVerificationRequest:
      properties:
        code:
          type: string
        phoneNumber:
          type: string
        verificationProfileId:
          format: int64
          type: integer
      required:
      - code
      - phoneNumber
      - verificationProfileId
      type: object
    IterableApiResponse:
      properties:
        code:
          enum:
          - Success
          - BadApiKey
          - BadAuthorizationHeader
          - BadJsonBody
          - BadParams
          - BatchTooLarge
          - DatabaseError
          - EmailAlreadyExists
          - ExternalKeyConflict
          - Forbidden
          - ForbiddenParamsError
          - ForgottenUserError
          - GenericError
          - InvalidEmailAddressError
          - InvalidJwtPayload
          - InvalidUserIdError
          - JwtUserIdentifiersMismatched
          - NotFound
          - QueueEmailError
          - RateLimitExceeded
          - RequestFieldsTypesMismatched
          - Unauthorized
          - UniqueFieldsLimitExceeded
          - UnknownEmailError
          - UnknownUserIdError
          - UserIdAlreadyExists
          type: string
        msg:
          description: Response description
          type: string
        params:
          description: Additional info
          type: object
      required:
      - code
      - msg
      type: object
  securitySchemes:
    api_key:
      in: header
      name: Api-Key
      type: apiKey