Nestcoin

Nestcoin Auth Userauth API

The auth-userauth API from Nestcoin — 3 operation(s) for auth-userauth.

GitHub OpenAPI

Operations 3

POST /auth/user-auth/initiate Initiate authentication for a user #
POST /auth/user-auth/verify-otp Verify OTP #
POST /auth/user-auth/resend-otp Resend a new otp to a user #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nestcoin/openapi/nestcoin-auth-userauth-api-openapi.yml

Other Resources

🔗
Webhooks
https://artifacts.apis.io/nestcoin/asyncapi/nestcoin-webhooks.yml
🔗
ErrorCatalog
https://artifacts.apis.io/nestcoin/errors/nestcoin-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/nestcoin/data-model/nestcoin-data-model.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/nestcoin:nestcoin-auth-userauth-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

nestcoin-auth-userauth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 3.0.2
  title: Onboard External API Gateway Auth Userauth API
  description: '**Introduction**

    API Gateway for Onboard


    This specification describes API endpoints that are available to the public internet via the API gateway.'
  contact:
    name: Nestcoin TechOps
    email: techops@nestcoin.com
  license:
    name: UNLICENSED
servers:
- url: https://external.dev.onboardpay.co
  description: Gateway for external API on staging environment.
tags:
- name: auth-userauth
paths:
  /auth/user-auth/initiate:
    x-original-path: /user-auth/initiate
    post:
      tags:
      - auth-userauth
      summary: Initiate authentication for a user
      description: Initiate authentication for a user. If the email address is for a new user, a new onboard profile will be created
      operationId: initiateUserLogin
      x-visibility: external
      security:
      - authSignature: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthInitRequest'
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAuthInitResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
  /auth/user-auth/verify-otp:
    x-original-path: /user-auth/verify-otp
    post:
      tags:
      - auth-userauth
      summary: Verify OTP
      operationId: verifyAuthOtp
      x-visibility: external
      security:
      - authSignature: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthOtpVerificationRequest'
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessTokenResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
  /auth/user-auth/resend-otp:
    x-original-path: /user-auth/resend-otp
    post:
      tags:
      - auth-userauth
      summary: Resend a new otp to a user
      operationId: resendAuthOtp
      x-visibility: external
      security:
      - authSignature: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthOtpResendRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAuthOtpResendResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessageDto'
components:
  schemas:
    UserAuthOtpResendResponse:
      type: object
      properties:
        sent:
          type: boolean
        authSessionId:
          type: string
      x-source-svc: auth
    UserAuthInitRequest:
      required:
      - email
      type: object
      properties:
        email:
          type: string
          description: user's email
      x-source-svc: auth
    Token:
      properties:
        token:
          type: string
          description: Token string (Request, Access, Refresh)
        expiry:
          type: string
          format: date-time
          description: Timestamp field.
          x-source-svc: auth
      required:
      - token
      - expiry
      x-source-svc: auth
    UserAuthInitResponse:
      type: object
      properties:
        authSessionId:
          type: string
          description: The log in session ID of the user, valid for the duration of the OTP validity
          format: uuid
        isReturning:
          type: boolean
          description: Indicates if user is a returning user, i.e. previously verified
          default: false
      x-source-svc: auth
    UserAuthOtpResendRequest:
      type: object
      required:
      - authSessionId
      properties:
        authSessionId:
          type: string
          format: uuid
      x-source-svc: auth
    AccessTokenResponse:
      properties:
        userId:
          type: string
          description: Onboard unique User ID
        accessToken:
          $ref: '#/components/schemas/Token'
        refreshToken:
          $ref: '#/components/schemas/Token'
      required:
      - userId
      - accessToken
      - refreshToken
      x-source-svc: auth
    ErrorMessageDto:
      description: Default error object for services. This gives consistent error object that all services may use.
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Error code
          example: UNKNOWN_ERROR
        message:
          type: string
          description: Descriptive error message
          example: Request could not be completed due to an error
        data:
          type: object
          description: Additional data for this error message.
          additionalProperties: true
          properties: {}
      x-common-model: ErrorMessageDto
    UserAuthOtpVerificationRequest:
      required:
      - authSessionId
      - otp
      type: object
      properties:
        authSessionId:
          type: string
          description: The log in session ID of the user, valid for the duration of the OTP validity
          format: uuid
        otp:
          type: string
          description: The verification code sent to user (partner) email
      x-source-svc: auth
  securitySchemes:
    authSignature:
      type: apiKey
      name: x-signature
      in: header
    authToken:
      type: apiKey
      name: x-auth-token
      in: header
      description: Auth Token header for inter-service communication
x-organization: onboard
x-service-id: external-gateway
x-preserve-refs:
- '#/components/schemas/IntegrationProduct'
- '#/components/schemas/AdAppliedEscrowBalanceDto'
- '#/components/schemas/P2PWalletRecipient'
- '#/components/schemas/BankAccountRecipient'
- '#/components/schemas/MobileMoneyRecipient'
- '#/components/schemas/OrderEvent'
- '#/components/schemas/PaymentMethodEventAction'
- '#/components/schemas/PaymentMethodEventPayload'
- '#/components/schemas/TransactionServiceErrorCode'
- '#/components/schemas/ErrorCodes'