NimbusNexus

NimbusNexus V1:account:phone API

The v1:account:phone API from NimbusNexus — 2 operation(s) for v1:account:phone.

GitHub OpenAPI

Operations 4

GET /api/v1/phone/ Retrieve Phone #
POST /api/v1/phone/ Add Phone #
DELETE /api/v1/phone/ Delete Phone #
POST /api/v1/phone/phone_passcode_validation Phone Passcode Validation #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nimbusnexus/refs/heads/main/openapi/nimbusnexus-v1-account-phone-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/nimbusnexus:nimbusnexus-v1-account-phone-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

nimbusnexus-v1-account-phone-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NimbusNexus API — External V1:account:phone API
  description: 'External (public) API intended for client-facing integrations and the web portal.


    Authentication:

    - This API uses JWT Bearer authentication.

    - In Swagger UI, click ''Authorize'' and sign in via the configured token endpoint.

    - Swagger will automatically attach the header: Authorization: Bearer .'
  version: test
servers:
- url: /
  description: Current host
- url: https://fastapi.dev.nimbusnexus.net
  description: Development
security:
- SwaggerLogin: []
- ApiKeyAuth: []
tags:
- name: v1:account:phone
paths:
  /api/v1/phone/:
    get:
      tags:
      - v1:account:phone
      summary: Retrieve Phone
      description: Return the verified phone number on file for the current user, if any.
      operationId: retrieve_phone_api_v1_phone__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneOut'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
              example:
                success: false
                errors:
                  field:
                  - Invalid value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Not Found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Conflict
        '429':
          description: Too Many Requests
          headers:
            Retry-After:
              description: Seconds to wait before retrying the request
              schema:
                type: string
              example: '30'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                code: 429
                message: Too many requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
    post:
      tags:
      - v1:account:phone
      summary: Add Phone
      description: Stage a phone number for the current user and send a one-time SMS verification code to it.
      operationId: add_phone_api_v1_phone__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumber'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneSendCodeOut'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
              example:
                success: false
                errors:
                  field:
                  - Invalid value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Not Found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Conflict
        '429':
          description: Too Many Requests
          headers:
            Retry-After:
              description: Seconds to wait before retrying the request
              schema:
                type: string
              example: '30'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                code: 429
                message: Too many requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
    delete:
      tags:
      - v1:account:phone
      summary: Delete Phone
      description: Remove the current user's verified phone number and disable two-factor authentication.
      operationId: delete_phone_api_v1_phone__delete
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
              example:
                success: false
                errors:
                  field:
                  - Invalid value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Not Found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Conflict
        '429':
          description: Too Many Requests
          headers:
            Retry-After:
              description: Seconds to wait before retrying the request
              schema:
                type: string
              example: '30'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                code: 429
                message: Too many requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
  /api/v1/phone/phone_passcode_validation:
    post:
      tags:
      - v1:account:phone
      summary: Phone Passcode Validation
      description: Validate the SMS passcode and promote the staged phone number to verified.
      operationId: phone_passcode_validation_api_v1_phone_phone_passcode_validation_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Passcode'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneOut'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseValidationErrorOut'
              example:
                success: false
                errors:
                  field:
                  - Invalid value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Unauthorized | Invalid token | Expired token | Authentication required
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Not Found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Conflict
        '429':
          description: Too Many Requests
          headers:
            Retry-After:
              description: Seconds to wait before retrying the request
              schema:
                type: string
              example: '30'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                code: 429
                message: Too many requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBaseErrorOut'
              example:
                success: false
                message: Internal Server Error
      security:
      - SwaggerLogin: []
      - ApiKeyAuth: []
components:
  schemas:
    PhoneOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          $ref: '#/components/schemas/PhoneData'
      type: object
      required:
      - data
      title: PhoneOut
    PhoneSendCodeOut:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          $ref: '#/components/schemas/PhoneSendCodeData'
      type: object
      required:
      - data
      title: PhoneSendCodeOut
    PhoneData:
      properties:
        phone_verified:
          type: boolean
          title: Phone Verified
        phone_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone Code
        phone_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone Number
      type: object
      required:
      - phone_verified
      title: PhoneData
    Passcode:
      properties:
        passcode:
          type: string
          maxLength: 6
          minLength: 6
          pattern: ^[0-9]+$
          title: Passcode
      type: object
      required:
      - passcode
      title: Passcode
    ResponseBaseErrorOut:
      properties:
        success:
          type: boolean
          title: Success
          default: false
        message:
          type: string
          title: Message
      type: object
      required:
      - message
      title: ResponseBaseErrorOut
    PhoneSendCodeData:
      properties:
        code_sent:
          type: boolean
          title: Code Sent
        phone_code:
          type: string
          title: Phone Code
        phone_number:
          type: string
          title: Phone Number
      type: object
      required:
      - code_sent
      - phone_code
      - phone_number
      title: PhoneSendCodeData
    ResponseValidationErrorOut:
      properties:
        success:
          type: boolean
          title: Success
          default: false
        errors:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Errors
      type: object
      required:
      - errors
      title: ResponseValidationErrorOut
    PhoneNumber:
      properties:
        phone_code:
          type: string
          maxLength: 3
          minLength: 1
          pattern: ^[0-9]+$
          title: Phone Code
        phone_number:
          type: string
          maxLength: 20
          minLength: 6
          pattern: ^[0-9]+$
          title: Phone Number
      type: object
      required:
      - phone_code
      - phone_number
      title: PhoneNumber
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    SwaggerLogin:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/v1/account/login_swagger
          scopes: {}
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key format -  base64('<id>:<secret>')