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/gnosis-pay:gnosis-pay-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

openapi: 3.2.0
info:
  title: User Service Phone API
  version: 0.0.0
servers:
- url: https://core.prod.gnosispay.com/user-api
  description: Production
  variables: {}
- url: https://core.sandbox.gnosispay.in/user-api
  description: Sandbox
  variables: {}
tags:
- name: Phone
paths:
  /phone:
    get:
      operationId: Phone_getPhone
      summary: Get Phone Number
      description: Returns the user's phone number if at least one card was created.
      parameters: []
      responses:
        '200':
          description: Phone number retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPhoneResponse'
        '401':
          description: Unauthorized - Invalid JWT
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found or no phone number registered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Phone
      security:
      - BearerAuth: []
      x-ogen-operation-group: Phone
    post:
      operationId: Phone_createPhone
      summary: Set Phone Number
      description: 'Sets the user''s phone number. Creates a cardholder if the user does not have one yet.


        If you require users to verify their phone, include `code` from POST /phone/verification; `phone` is optional. Otherwise send `phone` and omit `code`.'
      parameters: []
      responses:
        '200':
          description: Phone number updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneSuccess'
        '400':
          description: Bad Request - validation or invalid phone number
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneBadRequestBody'
        '401':
          description: Unauthorized - Invalid JWT
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found or no cardholder record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The request conflicts with the current state of the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneConflict'
        '422':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationUnprocessable'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePhoneRequest'
      security:
      - BearerAuth: []
      x-ogen-operation-group: Phone
    patch:
      operationId: Phone_updatePhone
      summary: Update Phone Number
      description: 'Updates the user''s phone number on their existing cardholder record.

        Returns 404 if the user has no cardholder yet — this method never creates one.


        If you require users to verify their phone, include `code` from POST /phone/verification; `phone` is optional. Otherwise send `phone` and omit `code`.'
      parameters: []
      responses:
        '200':
          description: Phone number updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneSuccess'
        '400':
          description: Bad Request - validation or invalid phone number
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneBadRequestBody'
        '401':
          description: Unauthorized - Invalid JWT
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found or no cardholder record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The request conflicts with the current state of the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePhoneConflict'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePhoneRequest'
      security:
      - BearerAuth: []
      x-ogen-operation-group: Phone
  /phone/verification:
    post:
      operationId: Phone_requestVerification
      summary: Request Phone Verification
      description: Send a one-time code to prove ownership of a phone number.
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationSuccess'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthBadRequest'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationUnprocessable'
        '429':
          description: Send rate limit exceeded. `error` is `OTP_SEND_COOLDOWN` or `OTP_SEND_DAILY_CAP`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationTooManyRequests'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPhoneVerificationRequest'
      security:
      - BearerAuth: []
      x-ogen-operation-group: Phone
components:
  schemas:
    UpdatePhoneConflict:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    UpdatePhoneValidationError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - validation
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ValidationErrorDetail'
      description: Validation failure on update phone (decoder / request constraints).
    UpdatePhoneSuccess:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          enum:
          - true
      description: Phone number updated successfully
    ValidationErrorDetail:
      type: object
      required:
      - name
      - message
      properties:
        name:
          type: string
          enum:
          - ValidationError
        message:
          type: string
    AuthBusinessError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - business
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
      description: Domain/business failure on auth routes (returned by handlers).
    UpdatePhoneRequest:
      type: object
      properties:
        phone:
          type: string
          minLength: 6
          maxLength: 20
          description: Required unless you require phone verification and send `code`.
        code:
          type: string
          minLength: 6
          maxLength: 6
          pattern: ^[0-9]{6}$
          description: One-time SMS code from POST /phone/verification. Required if you require phone verification for your users; omit otherwise.
    AuthBadRequest:
      type: object
      oneOf:
      - $ref: '#/components/schemas/AuthValidationError'
      - $ref: '#/components/schemas/AuthBusinessError'
      discriminator:
        propertyName: kind
        mapping:
          validation: '#/components/schemas/AuthValidationError'
          business: '#/components/schemas/AuthBusinessError'
      description: 'Discriminated 400 body for auth POST routes. The `kind` field is additive

        and not a breaking change. Clients can keep reading `success` and `error`.'
    Error:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    PhoneVerificationSuccess:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          enum:
          - true
    UpdatePhoneBadRequestBody:
      type: object
      oneOf:
      - $ref: '#/components/schemas/UpdatePhoneValidationError'
      - $ref: '#/components/schemas/UpdatePhoneBusinessError'
      discriminator:
        propertyName: kind
        mapping:
          validation: '#/components/schemas/UpdatePhoneValidationError'
          business: '#/components/schemas/UpdatePhoneBusinessError'
      description: 'Discriminated 400 body for PATCH/POST /phone. The `kind` field is additive

        and not a breaking change. Clients can keep reading `success` and `error`.'
    RequestPhoneVerificationRequest:
      type: object
      required:
      - phone
      properties:
        phone:
          type: string
          minLength: 6
          maxLength: 20
    UpdatePhoneBusinessError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - business
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
      description: Domain/business failure on update phone (INVALID_PHONE).
    GetPhoneResponse:
      type: object
      required:
      - phone
      - countryCode
      properties:
        phone:
          type: string
        countryCode:
          type: string
      description: Phone number retrieved successfully
    PhoneVerificationBadGateway:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    AuthValidationError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - validation
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ValidationErrorDetail'
      description: Validation failure on auth routes (decoder / request constraints).
    PhoneVerificationTooManyRequests:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
      description: Send rate limit exceeded. `error` is `OTP_SEND_COOLDOWN` or `OTP_SEND_DAILY_CAP`.
    PhoneVerificationUnprocessable:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer