Ubble

Ubble Business applicants API

The Business applicants API from Ubble — 2 operation(s) for business applicants.

GitHub OpenAPI

Operations 2

POST /v2/business-applicants Create a Business Applicant #
GET /v2/business-applicants/{business_applicant_id} Retrieve a Business Applicant #

Documentation

📖
Documentation
https://docs.ubble.ai/docs/introduction/
📖
APIReference
https://docs.ubble.ai/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ubble/openapi/ubble-business-applicants-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/ubble:ubble-business-applicants-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

ubble-business-applicants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Checkout.com - Identity Verification Business applicants API
  version: 1.0.0
  x-logo:
    url: https://raw.githubusercontent.com/ubbleai/docs/main/cko_doc_logo.png
  description: ''
servers:
- url: https://api.ubble.ai
tags:
- name: Business applicants
paths:
  /v2/business-applicants:
    post:
      tags:
      - Business applicants
      summary: Create a Business Applicant
      description: This section describes all endpoints related to business applicants. It will enable you to create and manage business applicant objects.
      operationId: create_business_applicant
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessApplicantInputPost'
            examples:
              All possible data:
                $ref: '#/components/examples/business_applicant_creation_request_body'
      responses:
        '201':
          description: Business applicant successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessApplicantOutputPost'
              examples:
                Always replies:
                  $ref: '#/components/examples/business_applicant_response_body'
          links:
            RetrieveBusinessApplicantById:
              operationId: retrieve_business_applicant
              parameters:
                business_applicant_id: $response.body#/id
        '400':
          description: Bad request
          content:
            application/json:
              examples:
                Invalid request:
                  value:
                    error_type: request_invalid
                    error_codes:
                    - external_applicant_id__invalid
  /v2/business-applicants/{business_applicant_id}:
    get:
      tags:
      - Business applicants
      summary: Retrieve a Business Applicant
      operationId: retrieve_business_applicant
      parameters:
      - name: business_applicant_id
        required: true
        in: path
        description: ID of Business Applicant to return
        schema:
          $ref: '#/components/schemas/BusinessApplicantId'
      responses:
        '200':
          description: business applicant retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessApplicantOutputGet'
              examples:
                Always replies:
                  $ref: '#/components/examples/business_applicant_response_body'
        '404':
          description: Business applicant not found
components:
  schemas:
    BusinessApplicantsLinks:
      type: object
      required:
      - _links
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/SelfLink'
    BusinessApplicantOutputGet:
      type: object
      required:
      - id
      allOf:
      - $ref: '#/components/schemas/BusinessApplicantOutputBase'
    BusinessApplicantInputPost:
      type: object
      allOf:
      - $ref: '#/components/schemas/BusinessApplicantInputBase'
    BusinessApplicantOutputPost:
      type: object
      required:
      - id
      allOf:
      - $ref: '#/components/schemas/BusinessApplicantOutputBase'
    HalLink:
      type: object
      required:
      - href
      properties:
        href:
          type: string
          format: uri
    BusinessApplicantInputBase:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseBusinessApplicant'
    BaseBusinessApplicant:
      type: object
      properties:
        external_applicant_id:
          type: string
          example: ext_business_osdfdfdb4hryu5cei5vwoabrk5k
    DatedObject:
      type: object
      required:
      - created_on
      - modified_on
      properties:
        created_on:
          description: UTC Date time when the resource was created
          type: string
          format: date-time
          example: 2017-07-21 17:32:28+00:00
        modified_on:
          description: UTC Date time when the resource was modified
          type: string
          format: date-time
          example: 2017-07-21 17:40:32+00:00
    BusinessApplicantId:
      type: string
      description: Business Applicant unique identifier.
      pattern: ^bplt_\w+$
      example: bplt_tkoi5db4hryu5cei5vwoabr7we
    SelfLink:
      type: object
      required:
      - self
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
    BusinessApplicantOutputBase:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/BusinessApplicantId'
      allOf:
      - $ref: '#/components/schemas/DatedObject'
      - $ref: '#/components/schemas/BaseBusinessApplicant'
      - $ref: '#/components/schemas/BusinessApplicantsLinks'
  examples:
    business_applicant_response_body:
      value:
        id: bplt_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21 17:32:28+00:00
        modified_on: 2017-07-21 17:40:32+00:00
        external_applicant_id: ext_business_osdfdfdb4hryu5cei5vwoabrk5k
        _links:
          self:
            href: https://api.ubble.ai/v2/business-applicants/bplt_tkoi5db4hryu5cei5vwoabr7we
    business_applicant_creation_request_body:
      value:
        external_applicant_id: ext_business_osdfdfdb4hryu5cei5vwoabrk5k
x-tagGroups:
- name: Endpoints documentation
  tags:
  - Applicants
  - Business applicants
  - Identity verifications
  - ID document verifications
  - Face authentications
  - AML verifications
  - Website verifications (Coming soon)
  - Bank document verifications (Coming soon)
  - Company document verifications (Coming soon)
  - Address document verifications (Coming soon)
  - Service status
x-provenance:
  method: harvested
  publisher: Ubble
  source: https://docs.ubble.ai/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)