Gnosis Pay

Gnosis Pay Auth API

The Auth API from Gnosis Pay — 5 operation(s) for auth.

Documentation GitHub OpenAPI

Operations 5

GET /auth/siwe/{address} Get Siwe message #

POST /auth/siwe Get Access Token #

POST /email-verification Request Email Verification #

POST /auth/refresh Refresh Access Token #

POST /auth/logout Logout #

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/gnosis-pay:gnosis-pay-auth-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 Auth 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: Auth
paths:
  /auth/siwe/{address}:
    get:
      operationId: Auth_getSiweMessage
      summary: Get Siwe message
      description: Retrieve the message that users need to Sign in with Ethereum (SIWE)
      parameters:
      - name: address
        in: path
        required: true
        description: Ethereum address
        schema:
          type: string
      - name: domain
        in: query
        required: true
        description: Domain requesting authentication
        schema:
          type: string
          minLength: 1
        explode: false
      - name: uri
        in: query
        required: true
        description: URI of the application
        schema:
          type: string
          format: uri
        explode: false
      - name: appName
        in: query
        required: true
        description: Application name to display in wallet
        schema:
          type: string
          minLength: 1
        explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSiweMessageResponse'
        '400':
          description: Validation failure on auth routes (decoder / request constraints).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthValidationError'
        '422':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSiweMessageUnprocessableEntity'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Auth
      x-ogen-operation-group: Auth
  /auth/siwe:
    post:
      operationId: Auth_verifySiwe
      summary: Get Access Token
      description: 'Verify a signed SIWE message. Returns both a short-lived access token and a

        longer-lived refresh token in the response body. The client is responsible

        for storing the refresh token securely.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifySiweSuccess'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthBadRequest'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Auth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifySiweRequest'
      x-ogen-operation-group: Auth
  /email-verification:
    post:
      operationId: EmailVerification_request
      summary: Request Email Verification
      description: 'Send a 6-digit one-time password to the given email.


        Returns 422 `EMAIL_VERIFICATION_NOT_REQUIRED` when you do not require

        email verification. Registration then accepts the email without a code,

        and that email is not verified.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEmailVerificationSuccess'
        '400':
          description: Validation failure on email-verification.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailVerificationValidationError'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEmailVerificationUnauthorized'
        '422':
          description: 'You do not require email verification. `error` is

            `EMAIL_VERIFICATION_NOT_REQUIRED`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEmailVerificationUnprocessable'
        '429':
          description: Send rate limit exceeded. `error` is `OTP_SEND_COOLDOWN` or `OTP_SEND_DAILY_CAP`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEmailVerificationTooManyRequests'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEmailVerificationInternalError'
        '503':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEmailVerificationServiceUnavailable'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Auth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestEmailVerificationRequest'
      security:
      - BearerAuth: []
      x-ogen-operation-group: EmailVerification
  /auth/refresh:
    post:
      operationId: AuthSession_refresh
      summary: Refresh Access Token
      description: 'Exchange a valid refresh token for a new access token and rotated refresh

        token. The refresh token must be sent in the request body.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshSuccess'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthBadRequest'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Auth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshRequest'
      x-ogen-operation-group: Auth
  /auth/logout:
    post:
      operationId: AuthSession_logout
      summary: Logout
      description: 'Invalidate the current session by revoking all refresh tokens in the token

        family. The client is responsible for deleting the refresh token from its

        storage.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogoutSuccess'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthBadRequest'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Auth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogoutRequest'
      x-ogen-operation-group: Auth
components:
  schemas:
    GetSiweMessageResponse:
      type: object
      required:
      - success
      - message
      properties:
        success:
          type: boolean
          enum:
          - true
        message:
          type: string
    RequestEmailVerificationInternalError:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    EmailVerificationValidationError:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ValidationErrorDetail'
      description: Validation failure on email-verification.
    RequestEmailVerificationTooManyRequests:
      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`.
    LogoutSuccess:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          enum:
          - true
    RequestEmailVerificationUnauthorized:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    LogoutRequest:
      type: object
      required:
      - refreshToken
      properties:
        refreshToken:
          type: string
          minLength: 1
    RequestEmailVerificationUnprocessable:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
      description: 'You do not require email verification. `error` is

        `EMAIL_VERIFICATION_NOT_REQUIRED`.'
    ValidationErrorDetail:
      type: object
      required:
      - name
      - message
      properties:
        name:
          type: string
          enum:
          - ValidationError
        message:
          type: string
    VerifySiweSuccess:
      type: object
      required:
      - success
      - accessToken
      - refreshToken
      properties:
        success:
          type: boolean
          enum:
          - true
        accessToken:
          type: string
        refreshToken:
          type: string
    RequestEmailVerificationServiceUnavailable:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    Error:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    RefreshSuccess:
      type: object
      required:
      - success
      - accessToken
      - refreshToken
      properties:
        success:
          type: boolean
          enum:
          - true
        accessToken:
          type: string
        refreshToken:
          type: string
    RefreshRequest:
      type: object
      required:
      - refreshToken
      properties:
        refreshToken:
          type: string
          minLength: 1
    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).
    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).
    VerifySiweRequest:
      type: object
      required:
      - address
      - signature
      - message
      properties:
        address:
          type: string
          pattern: ^0x[a-fA-F0-9]{40}$
        signature:
          type: string
        message:
          type: string
          minLength: 1
    RequestEmailVerificationSuccess:
      type: object
      required:
      - ok
      properties:
        ok:
          type: boolean
          enum:
          - true
    RequestEmailVerificationRequest:
      type: object
      required:
      - email
      properties:
        email:
          type: string
          format: email
    GetSiweMessageUnprocessableEntity:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    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`.'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer