MyOTP.App

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['message_id'], 'properties': {'message_id': {'type': 'string', 'format': 'uuid', 'description': 'The UUID returned by `generate_otp` â\x80\x94 this identifies which OTP you want a status report on.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'DLR': {'type': 'string', 'description': "Delivery state: carrier status (ATES, DELIVRD, UNDELIV, EXPIRED, REJECTD) or sent/delivered/read/pending/failed.<reason>, a 'Pending: ...' hint, or a 'Not available ...' explanation. Absent when the message_id is unknown."}, 'DLR:': {'type': 'string', 'description': 'Deprecated alias of DLR.'}, 'message': {'type': 'string', 'description': 'Present instead of DLR when the message_id is not found.'}, 'Message:': {'type': 'string', 'description': 'Deprecated alias of message.'}, 'is_active': {'type': 'boolean', 'description': 'Whether the OTP can still be verified (it has not expired).'}, 'expires_at': {'type': 'string', 'description': 'ISO 8601 date-time the OTP expires. Absent when the message_id is unknown.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['email'], 'properties': {'name': {'type': 'string', 'maxLength': 64, 'description': 'Optional account, company, or product name (maximum 64 characters).'}, 'email': {'type': 'string', 'format': 'email', 'description': 'Email address for the new MyOTP.App account.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['account_id', 'api_key', 'email', 'email_verified', 'balance', 'plan_id', 'status'], 'properties': {'docs': {'type': 'string'}, 'email': {'type': 'string'}, 'topup': {'type': 'object', 'properties': {'note': {'type': 'string'}, 'quote': {'type': 'string'}, 'endpoint': {'type': 'string'}}, 'description': 'Where to buy credits.', 'additionalProperties': True}, 'status': {'type': 'string', 'description': "Account status, 'active' when the key can be used."}, 'api_key': {'type': 'string', 'description': 'The API key. Shown once, in this response only. Send it as the X-API-Key header.'}, 'balance': {'type': 'number', 'description': 'Credits on the balance. Zero at registration.'}, 'plan_id': {'type': 'integer'}, 'account_id': {'type': 'string', 'description': "Account identifier, 'a' followed by 12 hex characters."}, 'api_key_note': {'type': 'string'}, 'email_verified': {'type': 'boolean', 'description': 'True once the human has confirmed the emailed link. Unlocks card top-ups.'}, 'verification_email_sent': {'type': 'boolean', 'description': 'Whether the confirmation email was queued.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['message_id', 'duration'], 'properties': {'duration': {'type': 'integer', 'maximum': 14400, 'minimum': 60, 'description': "Additional seconds to add to the OTP's expiry. Range 60-14400 (1 minute to 4 hours). The new expiry will be the current expiry + this duration."}, 'message_id': {'type': 'string', 'format': 'uuid', 'description': 'The UUID returned by `generate_otp` â\x80\x94 identifies the OTP you want to extend.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['status', 'message', 'expires_at'], 'properties': {'status': {'type': 'string', 'description': 'Status of the request.'}, 'message': {'type': 'string', 'description': 'Message describing the result.'}, 'expires_at': {'type': 'string', 'description': 'The new ISO 8601 expiry date-time.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['phone_number'], 'properties': {'brand': {'type': 'string', 'pattern': '^[a-zA-Z0-9.]+$', 'maxLength': 16, 'minLength': 3, 'description': "Sender brand name shown to the recipient (3-16 alphanumeric characters plus dots). Defaults to the brand registered against the API key, or 'MyOTP.App' if none."}, 'channel': {'enum': ['sms', 'whatsapp', 'telegram'], 'type': 'string', 'description': "Delivery channel. 'sms' (default) works in 190+ countries. 'whatsapp' is best for India/Brazil/Indonesia/Mexico/Nigeria/Turkey. 'telegram' is best for privacy-focused users. Same API for all three."}, 'otp_code': {'type': 'string', 'pattern': '^\\d{3,8}$', 'description': 'Provide your own pre-generated numeric OTP code (3-8 digits, 4-8 for telegram) instead of letting MyOTP generate one. Useful when you already have a code from another system.'}, 'force_send': {'type': 'boolean', 'description': 'If true, send a new OTP even if one is already active for this phone number. By default the API returns 409 in that case. Use sparingly â\x80\x94 repeated sends to the same number can hit carrier-level spam filters.'}, 'otp_length': {'type': 'integer', 'maximum': 8, 'minimum': 3, 'description': 'Number of digits in the auto-generated OTP. Range 3-8 (4-8 for telegram). Default 6. Requires CUSTOM_OTP_LENGTH entitlement (Business plan or above).'}, 'return_otp': {'type': 'boolean', 'description': 'If true, the API response will include the generated OTP code in plain text. Useful for testing or when you want to deliver the OTP via your own channel. Defaults to false. SECURITY: never enable this in production user flows.'}, 'otp_validity': {'type': 'integer', 'maximum': 14400, 'minimum': 30, 'description': 'How long the OTP stays valid, in seconds. Range 30-14400 (30-3600 for telegram). Default 300 (5 minutes). Requires CUSTOM_OTP_EXPIRY entitlement (Business plan or above).'}, 'phone_number': {'type': 'string', 'pattern': '^[1-9]\\d{6,14}$', 'maxLength': 15, 'minLength': 7, 'description': "Destination phone number in international format with NO leading + or 0. Must be 7-15 digits and start with a non-zero digit. Example: '14155551234' for a US number, '447911123456' for a UK number."}, 'template_order': {'type': 'integer', 'maximum': 99, 'minimum': 1, 'description': "Pick a specific message template by its order number (1-99). WhatsApp has four: 12 (English, 5-minute code), 13 (English, 10 minutes), 14 (Spanish es_MX, 5 minutes), 15 (Spanish es_MX, 10 minutes). On WhatsApp the template's own expiry overrides otp_validity. Requires the ACCESS_TO_TEMPLATES entitlement (Business plan and up). Not supported on telegram (Telegram generates its own message text)."}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['message_id', 'status', 'message', 'date_sent', 'expires_at', 'cost'], 'properties': {'otp': {'type': 'string', 'description': 'The OTP value, present only when return_otp was true.'}, 'cost': {'type': 'number', 'description': 'Credits charged for this send.'}, 'status': {'type': 'string', 'description': "Always 'accepted' on success; delivery state comes from check_otp_status."}, 'message': {'type': 'string', 'description': 'Message describing the status of the request.'}, 'date_sent': {'type': 'string', 'description': 'ISO 8601 date-time the OTP was sent.'}, 'expires_at': {'type': 'string', 'description': 'ISO 8601 date-time the OTP expires.'}, 'message_id': {'type': 'string', 'description': 'ID of the message sent. Pass it to verify_otp, check_otp_status and extend_otp.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['email'], 'properties': {'email': {'type': 'string', 'description': 'Email address of the account the API key belongs to.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'resend_verification': {'type': 'boolean', 'description': 'Send another confirmation email before returning account status.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['email_verified', 'balance', 'plan_id', 'status', 'hint'], 'properties': {'hint': {'type': 'string', 'description': 'What to do next: verify the email, top up, or start sending.'}, 'status': {'type': 'string', 'description': "Account status, 'active' when the key can be used."}, 'balance': {'type': 'number', 'description': 'Credits on the balance.'}, 'plan_id': {'type': 'integer'}, 'email_verified': {'type': 'boolean', 'description': 'True once the human has confirmed the emailed link. Unlocks card top-ups.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'credits': {'type': 'integer', 'default': 100, 'maximum': 50000, 'minimum': 25, 'description': 'Number of credits to quote. Integer from 25 to 50,000; defaults to 100.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['credits', 'amount_usd', 'price_per_credit_usd', 'min_credits', 'max_credits', 'currency', 'methods', 'rules', 'how_to_pay'], 'properties': {'rules': {'type': 'string', 'description': 'Top-up limits: unit price, minimum, maximum and the card cap.'}, 'credits': {'type': 'integer', 'description': 'The number of credits priced.'}, 'methods': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Human-readable list of the accepted payment methods.'}, 'currency': {'type': 'string', 'description': "Always 'usd'."}, 'amount_usd': {'type': 'string', 'description': 'Total price in US dollars, as a decimal string.'}, 'how_to_pay': {'type': 'object', 'required': ['usdc', 'card'], 'properties': {'card': {'type': 'string', 'description': 'Stripe Link CLI command that pays the challenge by card.'}, 'usdc': {'type': 'string', 'description': 'mppx command that pays the challenge in USDC on Tempo.'}}, 'description': 'Ready-to-run client commands for this amount.', 'additionalProperties': True}, 'max_credits': {'type': 'integer'}, 'min_credits': {'type': 'integer'}, 'price_per_credit_usd': {'type': 'number', 'description': 'Unit price. Currently 0.02.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'page': {'type': 'integer', 'minimum': 1, 'description': 'Page number for paginated results, starting at 1. Default 1.'}, 'end_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'End date in YYYY-MM-DD format (UTC). If omitted, defaults to today. The range start_date..end_date cannot exceed 31 days.'}, 'per_page': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Results per page, 1-100. Default 10.'}, 'start_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'description': 'Start date in YYYY-MM-DD format (UTC). If omitted, defaults to 7 days before today. The range start_date..end_date cannot exceed 31 days.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'message': {'type': 'string', 'description': 'Present when the endpoint has no data for the range.'}, 'per_page': {'type': 'integer', 'description': 'Rows per page.'}, 'total_count': {'type': 'integer', 'description': 'Total transactions matching the date range.'}, 'total_pages': {'type': 'integer', 'description': 'Number of pages at the requested per_page.'}, 'current_page': {'type': 'integer', 'description': 'The page returned.'}, 'transactions': {'type': 'array', 'items': {'type': 'object', 'properties': {'cost': {'type': 'number', 'description': 'Credits charged.'}, 'status': {'type': 'string', 'description': 'Transaction status, e.g. delivered, read, failed.NoBalance.'}, 'channel': {'type': 'string', 'description': 'sms, whatsapp or telegram.'}, 'country': {'type': 'string'}, 'client_ip': {'type': ['string', 'null']}, 'force_send': {'type': 'boolean'}, 'message_id': {'type': 'string'}, 'application': {'type': ['string', 'null']}, 'description': {'type': ['string', 'null']}, 'message_type': {'type': 'integer', 'description': 'Whether this was an OTP send or a verification.'}, 'phone_number': {'type': 'string'}, 'message_timestamp': {'type': 'string', 'description': 'ISO 8601 date-time of the transaction.'}}, 'additionalProperties': True}, 'description': 'Transaction rows for the page. May be empty or absent when there is no data.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['credits'], 'properties': {'credits': {'type': 'integer', 'maximum': 50000, 'minimum': 25, 'description': 'Number of credits to buy. Integer from 25 to 50,000.'}, 'dry_run': {'type': 'boolean', 'description': 'If true, return only the quote and explanation without requesting a payment challenge.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'quote': {'type': 'object', 'required': ['credits', 'amount_usd', 'price_per_credit_usd', 'min_credits', 'max_credits', 'currency', 'methods'], 'properties': {'credits': {'type': 'integer', 'description': 'The number of credits priced.'}, 'methods': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Human-readable list of the accepted payment methods.'}, 'currency': {'type': 'string', 'description': "Always 'usd'."}, 'amount_usd': {'type': 'string', 'description': 'Total price in US dollars, as a decimal string.'}, 'max_credits': {'type': 'integer'}, 'min_credits': {'type': 'integer'}, 'price_per_credit_usd': {'type': 'number', 'description': 'Unit price. Currently 0.02.'}}, 'description': 'The quote for the requested credits (dry run and 402 results).', 'additionalProperties': True}, 'retry': {'type': 'object', 'required': ['url', 'method', 'headers', 'body'], 'properties': {'url': {'type': 'string'}, 'body': {'type': 'object', 'additionalProperties': {}}, 'method': {'type': 'string'}, 'headers': {'type': 'object', 'description': 'Headers to send; placeholders mark the API key and payment credential.', 'additionalProperties': {'type': 'string'}}}, 'description': 'The request to replay with a payment credential (402 result).', 'additionalProperties': True}, 'offers': {'type': 'array', 'items': {'type': 'object', 'required': ['method', 'intent', 'id', 'expires', 'amount', 'amount_unit', 'currency'], 'properties': {'id': {'type': 'string'}, 'amount': {'type': ['string', 'number']}, 'intent': {'type': 'string'}, 'method': {'type': 'string', 'description': 'tempo (USDC) or stripe (card).'}, 'expires': {'type': 'string', 'description': 'ISO 8601 expiry of the offer.'}, 'currency': {'type': 'string'}, 'amount_usd': {'type': 'string', 'description': 'amount converted to USD with two decimals when the unit is known.'}, 'amount_unit': {'type': 'string', 'description': 'What amount is denominated in: USDC atomic units for tempo, cents for stripe.'}}, 'additionalProperties': True}, 'description': 'Decoded Payment offers from the WWW-Authenticate challenge (402 result).'}, 'status': {'type': 'string', 'description': "'credited' or 'already_credited' (settled result)."}, 'balance': {'type': 'number', 'description': 'Account balance in credits after the top-up (settled result).'}, 'credits': {'type': 'integer', 'description': 'Credits bought in this call (settled result).'}, 'payment': {'type': 'object', 'properties': {'method': {'type': 'string'}, 'reference': {'type': 'string'}}, 'description': 'Payment method and reference (settled result).', 'additionalProperties': True}, 'plan_id': {'type': 'integer'}, 'currency': {'type': 'string'}, 'amount_usd': {'type': 'string', 'description': 'Amount paid in US dollars (settled result).'}, 'how_to_pay': {'type': 'object', 'required': ['usdc', 'card'], 'properties': {'card': {'type': 'string', 'description': 'Stripe Link CLI command that pays the challenge by card.'}, 'usdc': {'type': 'string', 'description': 'mppx command that pays the challenge in USDC on Tempo.'}}, 'description': 'Ready-to-run client commands (402 result).', 'additionalProperties': True}, 'challengeId': {'type': 'string', 'description': 'The MPP challenge id from the 402 response.'}, 'explanation': {'type': 'string', 'description': 'What happened and what the caller must do next (dry run and 402 results).'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['otp'], 'properties': {'otp': {'type': 'string', 'pattern': '^\\d{3,8}$', 'description': "The OTP code the end user typed in (3-8 numeric digits). This is the code you're trying to verify against what was sent."}, 'message_id': {'type': 'string', 'format': 'uuid', 'description': 'The UUID returned by `generate_otp`. Provide either this OR `phone_number`. Prefer this when you have it â\x80\x94 it disambiguates if the same number got multiple OTPs.'}, 'phone_number': {'type': 'string', 'pattern': '^[1-9]\\d{6,14}$', 'description': 'Phone number the OTP was originally sent to, in international format without + or leading 0. Provide either this OR `message_id` â\x80\x94 `message_id` is more precise.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['status', 'message'], 'properties': {'reason': {'type': 'string', 'description': "Why verification failed: 'invalid', 'expired' or 'not found'. Absent on success."}, 'status': {'type': 'string', 'description': "'success' when the code matched and the OTP was consumed, otherwise 'failed' (or 'expired')."}, 'message': {'type': 'string', 'description': 'Message describing the verification result.'}}, 'additionalProperties': True}