Ordo

Ordo Account Verification - Client Hosted API

The Account Verification - Client Hosted API from Ordo — 6 operation(s) for account verification - client hosted.

GitHub OpenAPI

Operations 6

POST /account/verification/create Creates a new AV request #
POST /account/verification/initiate Initiate an AV request #
GET /account/verification/institutions Gets a list of AV enabled institutions #
GET /account/verification/{avId} Get an AV request #
GET /account/verification/account Gets all AV accounts for a participant #
GET /account/verification/account/{avId} Get AV account data #

Documentation

📖
Documentation
https://ordopay.com/products/payments
📖
APIReference
https://docs.myordo.com/docs/introduction-single-payments
📖
Documentation
https://ordopay.com/products/vrp
📖
APIReference
https://docs.myordo.com/docs/introduction-recurring-payment-mandates
📖
Documentation
https://ordopay.com/products/account/data
📖
APIReference
https://docs.myordo.com/docs/introduction-account-data
📖
Documentation
https://ordopay.com/products/account/verify
📖
APIReference
https://docs.myordo.com/docs/client-hosted-account-data
📖
APIReference
https://docs.myordo.com/docs/financial-institution

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-account-verification-client-hosted-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/ordo-account-verification-client-hosted-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

ordo-account-verification-client-hosted-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ACCOUNT DATA - Client Hosted Account Verification - Client Hosted API
  version: '1.0'
servers:
- url: https://test.api.ordopay.com/client
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Account Verification - Client Hosted
paths:
  /account/verification/create:
    post:
      tags:
      - Account Verification - Client Hosted
      summary: Creates a new AV request
      description: Creates a new AV request
      operationId: post-account-verification-create
      parameters:
      - name: participantId
        in: header
        description: Format - int32.
        schema:
          type: integer
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AVRequest'
            example:
              clientReference: string
              expiryDate: string
              avurLs:
                redirectURL: string
                cancelURL: string
                errorURL: string
          text/json:
            schema:
              $ref: '#/components/schemas/AVRequest'
            example:
              clientReference: string
              expiryDate: string
              avurLs:
                redirectURL: string
                cancelURL: string
                errorURL: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/AVRequest'
            example:
              clientReference: string
              expiryDate: string
              avurLs:
                redirectURL: string
                cancelURL: string
                errorURL: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AVPostResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/AVPostResponse'
              example:
                av:
                  avId: string
                  createdDate: string
                  createdBy: string
                  expiryDate: string
                  updatedDate: string
                  updatedBy: string
                  clientReference: string
                  participantId: 0
                  status: string
                avAuthUrl: string
                avURLs:
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
            text/json:
              schema:
                $ref: '#/components/schemas/AVPostResponse'
              example:
                av:
                  avId: string
                  createdDate: string
                  createdBy: string
                  expiryDate: string
                  updatedDate: string
                  updatedBy: string
                  clientReference: string
                  participantId: 0
                  status: string
                avAuthUrl: string
                avURLs:
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/verification/initiate:
    post:
      tags:
      - Account Verification - Client Hosted
      summary: Initiate an AV request
      description: Initiate an AV request
      operationId: post-account-verification-clienthostedinitiate
      parameters:
      - name: participantId
        in: header
        description: Format - int32.
        schema:
          type: integer
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientHostedInitiateAVRequest'
            example:
              ordoInstitutionId: string
              avId: string
          text/json:
            schema:
              $ref: '#/components/schemas/ClientHostedInitiateAVRequest'
            example:
              ordoInstitutionId: string
              avId: string
          application/*+json:
            schema:
              $ref: '#/components/schemas/ClientHostedInitiateAVRequest'
            example:
              ordoInstitutionId: string
              avId: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AccountAuthResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/AccountAuthResponse'
              example:
                authorisationUrl: string
            text/json:
              schema:
                $ref: '#/components/schemas/AccountAuthResponse'
              example:
                authorisationUrl: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/verification/institutions:
    get:
      tags:
      - Account Verification - Client Hosted
      summary: Gets a list of AV enabled institutions
      description: Gets a list of AV enabled institutions
      operationId: get-account-verification-institutions
      parameters:
      - name: OrdoInstitutionId
        in: query
        schema:
          type: string
      - name: participantId
        in: header
        description: Format - int32. Participant ID in the header
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InstitutionResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/InstitutionResponse'
              example:
                ordoInstitutionId: string
                name: string
                media:
                  iconUrl: string
                  logoUrl: string
                refundDataAvailable: true
                aisEnabled: true
                features:
                - string
            text/json:
              schema:
                $ref: '#/components/schemas/InstitutionResponse'
              example:
                ordoInstitutionId: string
                name: string
                media:
                  iconUrl: string
                  logoUrl: string
                refundDataAvailable: true
                aisEnabled: true
                features:
                - string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorCode: string
                errorMessage: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/verification/{avId}:
    get:
      tags:
      - Account Verification - Client Hosted
      summary: Get an AV request
      description: Returns AV Record
      operationId: get-account-verification-avid
      parameters:
      - name: avId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: participantId
        in: header
        description: Format - int32.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetAVRecord'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/GetAVRecord'
              example:
                avId: string
                participantId: 0
                billerApprovedName: string
                clientReference: string
                status: string
                createdDate: string
                createdBy: string
                expiryDate: string
                avURLs:
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
            text/json:
              schema:
                $ref: '#/components/schemas/GetAVRecord'
              example:
                avId: string
                participantId: 0
                billerApprovedName: string
                clientReference: string
                status: string
                createdDate: string
                createdBy: string
                expiryDate: string
                avURLs:
                  redirectURL: string
                  cancelURL: string
                  errorURL: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/verification/account:
    get:
      tags:
      - Account Verification - Client Hosted
      summary: Gets all AV accounts for a participant
      description: Returns all AV accounts for a participant
      operationId: get-account-verification-account
      parameters:
      - name: participantId
        in: header
        description: Format - int32.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AVAccountGetResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/AVAccountGetResponse'
              example:
                avId: string
                participantId: 0
                accounts:
                - accountId: string
                  type: string
                  subType: string
                  schemeName: string
                  currency: string
                  accountName: string
                  sortCode: string
                  accountNumber: string
                  iban: string
                  pan: string
            text/json:
              schema:
                $ref: '#/components/schemas/AVAccountGetResponse'
              example:
                avId: string
                participantId: 0
                accounts:
                - accountId: string
                  type: string
                  subType: string
                  schemeName: string
                  currency: string
                  accountName: string
                  sortCode: string
                  accountNumber: string
                  iban: string
                  pan: string
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        '422':
          description: Client Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              examples:
                default:
                  value: null
            application/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
            text/json:
              schema:
                $ref: '#/components/schemas/OrdoValidationProblemDetails'
              example:
                title: string
                status: 0
                detail: string
                code: string
                errors: {}
                type: string
                instance: string
  /account/verification/account/{avId}:
    get:
      tags:
      - Account Verification - Client Hosted
      summary: Get AV account data
      description: Returns AV Account Details for specified AV ID
      operationId: get-account-verification-account-avid
      parameters:
      - name: avId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: participantId
        in: header
        description: Format - int32.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AVAccountGetResponse'
              examples:
                default:
                  value: null
            application/json:
              schema:
            

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-account-verification-client-hosted-api-openapi.yml