> ## Documentation Index > Fetch the complete documentation index at: https://docs.useboom.ai/llms.txt > Use this file to discover all available pages before exploring further. # Verify a one-time code > Check a code the person typed. Identify the code by `otpId` (from otp_send), or by `phone` / `personExternalId` plus the same `reference` used when sending. A wrong code is a normal 200 answer with `valid: false` and `attemptsRemaining`; the code locks once attempts run out. Returns 404 when no code matches and 422 when the code can no longer be checked. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/otp/verify openapi: 3.1.0 info: title: Boom API version: 1.0.0 description: >- Boom's public REST API — one uniform surface over every platform capability. CDP: upsert people and custom objects, define object and relationship types, link and unlink relationships, and record behavioral events — one record per request or up to 1000 per request via the `/batch` endpoints. Segments: read (list, read, membership) and full authoring — discover the filterable catalog, validate a filter, create and update segments, preview match counts, and trigger evaluation. Initiatives: create and configure outreach initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel, archive), and read collected-data summaries. Participants: enroll people into an active initiative, track their status, read conversation transcripts, and stop outreach. Journeys: read-only access to always-on message flows and their metrics. WhatsApp templates: list your WhatsApp numbers and list, read, and create message templates. The same capabilities are exposed as MCP tools with identical schemas. servers: - url: https://www.useboom.ai description: Production - url: https://dev.useboom.ai description: Development (sandbox — use a development organization API key) security: - bearerAuth: [] paths: /api/v1/otp/verify: post: tags: - One-time codes summary: Verify a one-time code description: >- Check a code the person typed. Identify the code by `otpId` (from otp_send), or by `phone` / `personExternalId` plus the same `reference` used when sending. A wrong code is a normal 200 answer with `valid: false` and `attemptsRemaining`; the code locks once attempts run out. Returns 404 when no code matches and 422 when the code can no longer be checked. operationId: otp_verify requestBody: required: true content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: otpId: type: string minLength: 1 phone: type: string minLength: 1 description: Recipient phone in E.164 format, e.g. +5215512345678. personExternalId: type: string minLength: 1 description: Your own ID for the person; Boom uses their stored phone. reference: type: string maxLength: 255 description: >- Your label for what the code is for, e.g. an appointment ID. People sharing a phone get separate codes when this or `personExternalId` is passed. code: type: string pattern: ^\d{6,10}$ description: The digits the person entered. required: - code responses: '200': description: Success content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: valid: type: boolean status: type: string enum: - PENDING - VERIFIED - EXPIRED - LOCKED attemptsRemaining: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - valid - status - attemptsRemaining additionalProperties: false '400': description: Validation failed or the request cannot proceed. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '401': description: Missing, malformed, or revoked API key. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '404': description: The resource does not exist in this organization. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '409': description: >- Conflicts with the current state (duplicates, wrong lifecycle state). content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '422': description: The request is well-formed but semantically invalid. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '429': description: Rate limit exceeded — retry after `Retry-After`. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '500': description: Internal server error. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error '503': description: Transient error — retry with a narrower request. content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: Stable machine-readable error code (snake_case). message: type: string required: - code - message required: - error components: securitySchemes: bearerAuth: type: http scheme: bearer description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.