Toqio

Toqio Onboarding API

The Onboarding API from Toqio — 4 operation(s) for onboarding.

GitHub OpenAPI

Operations 4

POST /customers/{customerId}/onboarding/createMerchant Create Merchant #
POST /customers/{customerId}/onboarding/client/{clientId}/hostedOnboarding Get Hosted Onboarding Link for a Merchant #
PUT /customers/{customerId}/onboarding/{clientId} Update Merchant #
PUT /customers/{customerId}/onboarding/{clientId}/updateEnduser Update Merchant Directors #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/toqio/refs/heads/main/openapi/toqio-onboarding-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/toqio-onboarding-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 email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

toqio-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Toqio Integration Hub Onboarding API
  version: v0
servers:
- url: https://your_connector_url
  description: This is an example url that you could use for testing purposes as this documentation describes the API that you must develop in your connector.
security:
- bearerAuth: []
tags:
- name: Onboarding
paths:
  /customers/{customerId}/onboarding/createMerchant:
    post:
      tags:
      - Onboarding
      summary: Create Merchant
      description: Creates a new merchant for the specified customer. This is the first step in the onboarding process and will only be called if canRunCompliance capability is set to true.
      operationId: createMerchant
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMerchantRequest'
      responses:
        '200':
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ToqioHttpOkVoidResponse'
        '404':
          description: CUSTOMER_NOT_FOUND
  /customers/{customerId}/onboarding/client/{clientId}/hostedOnboarding:
    post:
      tags:
      - Onboarding
      summary: Get Hosted Onboarding Link for a Merchant
      description: Returns a link that will allow a merchant to complete the onboarding process. This is the second step in the onboarding process and will only be called if canRunCompliance capability is set to true.
      operationId: hostedOnboarding
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostedOnboardingRequest'
      responses:
        '200':
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ToqioHttpOkHostedOnboardingResponse'
        '404':
          description: CUSTOMER_NOT_FOUND
  /customers/{customerId}/onboarding/{clientId}:
    put:
      tags:
      - Onboarding
      summary: Update Merchant
      description: ''
      operationId: updateEndUser
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ToqioHttpOkVoidResponse'
        '404':
          description: CUSTOMER_NOT_FOUND
  /customers/{customerId}/onboarding/{clientId}/updateEnduser:
    put:
      tags:
      - Onboarding
      summary: Update Merchant Directors
      description: ''
      operationId: updateEndUserDirectors
      parameters:
      - name: customerId
        in: path
        required: true
        schema:
          type: string
      - name: clientId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignUpRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ToqioHttpOkVoidResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomException'
components:
  schemas:
    CustomException:
      type: object
      properties:
        code:
          type: string
          example: OK
        errorSeverity:
          type: string
          example: NONE
        message:
          type: string
          example: Ok
        httpStatus:
          type: integer
          format: int32
          example: 200
        requestId:
          type: string
          example: 26b0f78a-79f9-426d-a20b-79841345ae51
        date:
          type: string
          example: '2024-08-01T00:00:00.000Z'
        errorOrigin:
          type: string
    SignUpRequest:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        cif:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        dateOfBirth:
          type: string
          format: date-time
        partnerProduct:
          type: string
          enum:
          - Railsbank-Direct-Debit-1
          - Railsbank-KYC-5
          - PayrNet-Multi-CCY-1
          - Goldbloc-Conversion-1
          - Railsbank-AML-Screening-1
          - Onfido-IDV-1
          - Railsbank-Debit-Card-1
          - Railsbank-Debit-Card-2
          - Railsbank-Virtual-1
          - Railsbank-Identity-and-Verification-Service-1
          - ExampleBank-Direct-Debit-1
          - PayrNet-FX-1
          - Railsbank-Debit-Card-3
          - Railsbank-Credit-Card-1
          - Railsbank-Conversion-1
          - Banking-EU-1
          - ExampleBank-EUR-1
          - ExampleBank-FX-1
          - ExampleBank-GBP-1
          - ExampleBank-GBP-2
          - PayrNet-EUR-1
          - PayrNet-EUR-3
          - PayrNet-GBP-1
          - PayrNet-GBP-2
          - PFS-EUR
          - MODULR-GBP
          - MODULR-EUR
          - CLEARBANK_GBP
          - CLEARBANK_EUR
          - CLEARBANK_CHF
          - CLEARBANK_CZK
          - CLEARBANK_DKK
          - CLEARBANK_HUF
          - CLEARBANK_NOK
          - CLEARBANK_PLN
          - CLEARBANK_RON
          - CLEARBANK_SEK
          - CLEARBANK_USD
          - Railsbank-USD-Credit-1
          - Railsbank-KYC-1
          - Railsbank-KYC-2
          - Railsbank-Rewards-1
          - LOOMIS_EUR
        countryCode:
          type: string
        postalCode:
          type: string
        clientType:
          type: string
          enum:
          - BUSINESS
          - CONSUMER
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        subOrganisationType:
          type: string
          enum:
          - SOLE_TRADER
          - LIMITED
          - PARTNERSHIP
          - CHARITY
          - PUBLIC_LIMITED
          - ASSOCIATION
          - SUPPORT_GROUP
          - NON_REG_PARTNERSHIP
          - NOT_YET_REGISTERED
      required:
      - id
      - email
      - endUserId
      - registrationDate
    HostedOnboardingRequest:
      type: object
      properties:
        locale:
          type: string
          example: en-GB
        redirectUrl:
          type: string
    ToqioHttpOkVoidResponse:
      type: object
      properties:
        data:
          type: object
          writeOnly: true
        code:
          type: string
          example: OK
        errorSeverity:
          type: string
          example: NONE
        message:
          type: string
          example: Ok
        httpStatus:
          type: integer
          format: int32
          example: 200
        requestId:
          type: string
          example: 26b0f78a-79f9-426d-a20b-79841345ae51
        date:
          type: string
          example: '2024-08-01T00:00:00.000Z'
    ToqioHttpOkHostedOnboardingResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/HostedOnboardingResponse'
        code:
          type: string
          example: OK
        errorSeverity:
          type: string
          example: NONE
        message:
          type: string
          example: Ok
        httpStatus:
          type: integer
          format: int32
          example: 200
        requestId:
          type: string
          example: 26b0f78a-79f9-426d-a20b-79841345ae51
        date:
          type: string
          example: '2024-08-01T00:00:00.000Z'
    HostedOnboardingResponse:
      type: object
      properties:
        link:
          type: string
    Director:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        dateOfBirth:
          type: string
          format: date-time
          description: yyyy-MM-dd'T'HH:mm:ss.SSS'Z
        countryOfResidence:
          type: string
        postalCode:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        email:
          type: string
          format: email
    CreateMerchantRequest:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        cif:
          type: string
        countryCode:
          type: string
        postalCode:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        businessCode:
          type: string
        currencies:
          type: array
          items:
            type: string
            enum:
            - aud
            - chf
            - cad
            - sek
            - usd
            - nok
            - jpy
            - nzd
            - gold
            - gbp
            - eur
            - czk
            - dkk
            - huf
            - pln
            - ron
            - ils
            - rub
            - bhd
            - sar
            - bgn
            - kes
            - sgd
            - kwd
            - zar
            - cny
            - myr
            - hrk
            - mxn
            - thb
            - try
            - omr
            - ugx
            - hkd
            - php
            - aed
            - inr
            - qar
            - idr
        subOrganisationType:
          type: string
          enum:
          - SOLE_TRADER
          - LIMITED
          - PARTNERSHIP
          - CHARITY
          - PUBLIC_LIMITED
          - ASSOCIATION
          - SUPPORT_GROUP
          - NON_REG_PARTNERSHIP
          - NOT_YET_REGISTERED
        directors:
          type: array
          items:
            $ref: '#/components/schemas/Director'
        legalPhoneNumber:
          type: string
        statementDescriptor:
          type: string
          description: It will appear on the end customer's bank or card statement, if supported by the banking service provider, to help identifying a transaction.
      required:
      - id
      - cif
      - name
      - subOrganisationType
    UpdateClientRequest:
      type: object
      properties:
        id:
          type: string
        cif:
          type: string
        industryCode:
          type: string
          deprecated: true
        businessCode:
          type: string
        endUserId:
          type: string
        citizenship:
          type: string
        docIdType:
          type: string
        docIdIssuedAt:
          type: string
          format: date-time
        docIdNumber:
          type: string
        docIdCountry:
          type: string
        clientType:
          type: string
          enum:
          - BUSINESS
          - CONSUMER
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-source-pages:
- https://integrate.toq.io/reference/acceptloanoffer-1
- https://integrate.toq.io/reference/applydirectdebit-1
- https://integrate.toq.io/reference/createaccount-1
- https://integrate.toq.io/reference/createbeneficiary-1
- https://integrate.toq.io/reference/createcustomer-1
- https://integrate.toq.io/reference/createlenderconfiguration-1
- https://integrate.toq.io/reference/createlendingrequest-1
- https://integrate.toq.io/reference/createmerchant-1
- https://integrate.toq.io/reference/deleteaccount-1
- https://integrate.toq.io/reference/deletebeneficiary-1
- https://integrate.toq.io/reference/deletemeawalletapiconfig-1
- https://integrate.toq.io/reference/fetchtransactions-1
- https://integrate.toq.io/reference/findaccounttransactionliststatement
- https://integrate.toq.io/reference/findaccounttransactionliststatement_1
- https://integrate.toq.io/reference/findbeneficiary-1
- https://integrate.toq.io/reference/findcustomer-1
- https://integrate.toq.io/reference/getaccount-1
- https://integrate.toq.io/reference/getaccountownershipcertificate-1
- https://integrate.toq.io/reference/getaccounts-1
- https://integrate.toq.io/reference/getassettypes-1
- https://integrate.toq.io/reference/getbankpaymentschemes-1
- https://integrate.toq.io/reference/getbankstatementfooter-1
- https://integrate.toq.io/reference/getbeneficiary-1
- https://integrate.toq.io/reference/getbeneficiaryfilters-1
- https://integrate.toq.io/reference/getbillingcurrencies-1
- https://integrate.toq.io/reference/getcapabilities-1
- https://integrate.toq.io/reference/getcompany-1
- https://integrate.toq.io/reference/getcontract-1
- https://integrate.toq.io/reference/getcustomerconnectionstatus-1
- https://integrate.toq.io/reference/getdefaultrepaymentterms-1
- https://integrate.toq.io/reference/getdynamicaccountbalances
- https://integrate.toq.io/reference/getdynamicbuttonconfiguration-1
- https://integrate.toq.io/reference/getlenderconfiguration-1
- https://integrate.toq.io/reference/getlendingrequest-1
- https://integrate.toq.io/reference/getlendingrequestsbyfilter-1
- https://integrate.toq.io/reference/getloan-1
- https://integrate.toq.io/reference/getloanoffer-1
- https://integrate.toq.io/reference/getloansbyfilter-1
- https://integrate.toq.io/reference/getloantransactions-1
- https://integrate.toq.io/reference/getmandatedetail-1
- https://integrate.toq.io/reference/getmandates-1
- https://integrate.toq.io/reference/getmeawalletapiconfig-1
- https://integrate.toq.io/reference/getpartnerproducts-1
- https://integrate.toq.io/reference/getpaymentoptions
- https://integrate.toq.io/reference/getproviderpartnerproducts-1
- https://integrate.toq.io/reference/getquoteforcurrencypair-1
- https://integrate.toq.io/reference/gettransactionstatus-1
- https://integrate.toq.io/reference/hostedonboarding-1
- https://integrate.toq.io/reference/notifycustomnotificationerrors-1
- https://integrate.toq.io/reference/notifyproductchanges
- https://integrate.toq.io/reference/resendotp-1
- https://integrate.toq.io/reference/savetransfer-1
- https://integrate.toq.io/reference/searchbeneficiaries-1
- https://integrate.toq.io/reference/sendemailnotification-1
- https://integrate.toq.io/reference/synctransactions-1
- https://integrate.toq.io/reference/synctransactionstatus-1
- https://integrate.toq.io/reference/synctransactionstatus_1-1
- https://integrate.toq.io/reference/updateaccount-1
- https://integrate.toq.io/reference/updatebeneficiary-1
- https://integrate.toq.io/reference/updateenduser-1
- https://integrate.toq.io/reference/updateenduserdirectors-1
- https://integrate.toq.io/reference/updatelenderconfiguration-1
- https://integrate.toq.io/reference/updatelendingrequest-1
- https://integrate.toq.io/reference/updatemeawalletapiconfig-1
- https://integrate.toq.io/reference/validatecompany-1
- https://integrate.toq.io/reference/verifybeneficiarycompany
- https://integrate.toq.io/reference/webhook_3-1
- https://integrate.toq.io/reference/webhook_4-1