Ubble Company document verifications (Coming soon) API

openapi: 3.0.3
info:
  title: Checkout.com - Identity Verification Address document verifications (Coming soon) Address document verifications (Coming soon) Company document verifications (Coming soon) 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: Company document verifications (Coming soon)
paths:
  /v2/company-document-verifications:
    post:
      tags:
      - Company document verifications (Coming soon)
      summary: Create a Company Document Verification
      operationId: create_company_document_verification
      description: Creates a Company Document Verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              company_document_verification_creation_request_body_min:
                $ref: '#/components/examples/company_document_verification_creation_request_body_min'
              company_document_verification_creation_request_body_max:
                $ref: '#/components/examples/company_document_verification_creation_request_body_max'
            schema:
              $ref: '#/components/schemas/CompanyDocumentVerificationInputPost'
      responses:
        '201':
          description: Company Document Verification created successfully
          content:
            application/json:
              examples:
                company_document_verification_creation_response_body:
                  $ref: '#/components/examples/company_document_verification_creation_response_body'
              schema:
                allOf:
                - $ref: '#/components/schemas/CompanyDocumentVerificationOutputPost'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable entity
        '500':
          description: Internal server error
        '503':
          description: Service unavailable
  /v2/company-document-verifications/{company_document_verification_id}:
    get:
      tags:
      - Company document verifications (Coming soon)
      summary: Retrieve a Company Document Verification
      description: This endpoint allows you to get the detailed results of a Company Document Verification
      operationId: retrieve_company_document_verification
      parameters:
      - name: company_document_verification_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/CompanyDocumentVerificationId'
      responses:
        '200':
          description: Company Document Verification retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/CompanyDocumentVerificationOutputGet'
        '404':
          description: Company Document Verification not found
        '500':
          description: Internal server error
  /v2/company-document-verifications/{company_document_verification_id}/anonymize:
    post:
      tags:
      - Company document verifications (Coming soon)
      summary: Anonymize a Company Document Verification
      operationId: anonymize_company_document_verification
      description: Anonymize the personal data of a Company Document Verification with the specified ID.
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the document verification to anonymize
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Company Document Verification anonymized
          content:
            application/json:
              examples:
                company_document_verification_anonymization_response_body:
                  $ref: '#/components/examples/company_document_verification_anonymization_response_body'
              schema:
                required:
                - applicant_id
                - user_journey_id
                allOf:
                - $ref: '#/components/schemas/CompanyDocumentVerificationOutputAnonymize'
        '404':
          description: Company Document Verification not found
        '500':
          description: Internal server error
  /v2/company-document-verifications/{company_document_verification_id}/attempts:
    get:
      tags:
      - Company document verifications (Coming soon)
      summary: List Company Document Verification attempts
      operationId: list_attempts_company_document_verification
      description: 'This endpoint allows you to list all attempts of a Company Document Verification.


        Attempts are returned ordered by creation date, newest first.


        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).

        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.

        '
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the document verification
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/limitParam'
      responses:
        '200':
          description: Company Document Verification attempts retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_attempt_list_response_body:
                  $ref: '#/components/examples/company_document_verification_attempt_list_response_body'
              schema:
                allOf:
                - $ref: '#/components/schemas/CompanyDocumentVerificationAttemptOutputList'
        '404':
          description: The provided document verification ID is not valid
        '500':
          description: An error occurred while fetching the attempts
    post:
      tags:
      - Company document verifications (Coming soon)
      summary: Create a Company Document Verification attempt
      description: 'This endpoint allows you to create a Company Document Verification attempt. It is possible when the Company Document Verification is one of the following statuses: `created`, `retry_required`'
      operationId: create_company_document_verification_attempt
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the document verification
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            examples:
              company_document_verification_attempt_creation_request_body_min:
                $ref: '#/components/examples/company_document_verification_attempt_creation_request_body_min'
              company_document_verification_attempt_creation_request_body_max:
                $ref: '#/components/examples/company_document_verification_attempt_creation_request_body_max'
            schema:
              $ref: '#/components/schemas/CompanyDocumentVerificationAttemptInputPost'
      responses:
        '201':
          description: Company Document Verification attempt created
          content:
            application/json:
              examples:
                company_document_verification_attempt_creation_response_body:
                  $ref: '#/components/examples/company_document_verification_attempt_creation_response_body'
              schema:
                $ref: '#/components/schemas/CompanyDocumentVerificationAttemptOutputPost'
        '404':
          description: The provided Company Document Verification ID is not valid
        '409':
          description: The Company Document Verification is not in a valid state to create an attempt. The Company Document Verification status must be `created` or `retry_required`
        '500':
          description: An error occurred while creating the attempt
  /v2/company-document-verifications/{company_document_verification_id}/attempts/{attempt_id}:
    get:
      tags:
      - Company document verifications (Coming soon)
      summary: Retrieve a Company Document Verification attempt
      description: This endpoint allows you to retrieve the details for a given Company Document Verification attempt.
      operationId: fetch_attempts_company_document_verification
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the document verification
        required: true
        schema:
          type: string
      - name: attempt_id
        in: path
        description: ID of the document verification attempt
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Company Document Verification attempt retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_attempt_get_response_body:
                  $ref: '#/components/examples/company_document_verification_attempt_get_response_body'
              schema:
                allOf:
                - $ref: '#/components/schemas/CompanyDocumentVerificationAttemptOutputGet'
        '404':
          description: The provided document verification attempt ID is not valid
        '500':
          description: An error occurred while fetching the attempt
  /v2/company-document-verifications/{company_document_verification_id}/attempts/{attempt_id}/assets:
    get:
      tags:
      - Company document verifications (Coming soon)
      summary: Retrieve a Company Document Verification attempt asset
      operationId: fetch_asset_company_document_verification_attempt
      description: 'This endpoint allows you to retrieve the assets associated with a Company Document Verification.

        This includes the document image.


        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).

        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.

        '
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the Company Document Verification
        required: true
        schema:
          type: string
      - name: attempt_id
        in: path
        description: ID of the Company Document Verification attempt
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/limitParam'
      responses:
        '200':
          description: Company Document Verification attempt asset retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_attempt_output_assets_response_body:
                  $ref: '#/components/examples/company_document_verification_attempt_output_assets_response_body'
              schema:
                $ref: '#/components/schemas/CompanyDocumentVerificationAttemptAssetsOutput'
  /v2/company-document-verifications/{company_document_verification_id}/notify:
    post:
      tags:
      - Company document verifications (Coming soon)
      summary: Request webhook notification
      operationId: notify_company_document_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of a Company Document Verification
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the document verification to notify
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        '204':
          description: Notification successfully requested
  /v2/company-document-verifications/{company_document_verification_id}/pdf-report:
    get:
      tags:
      - Company document verifications (Coming soon)
      summary: Retrieve PDF report of a Company Document Verification
      operationId: pdf_company_document_verification
      description: 'This endpoint allows you to retrieve a PDF report of a Company Document Verification.


        Please note that the PDF report is only available for company document verifications that are

        in status `declined` and `approved` once you receive the `company_document_verification_report_created` event.

        '
      parameters:
      - name: company_document_verification_id
        in: path
        description: ID of the Company Document Verification
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Company Document Verification PDF report retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_pdf_report_response_body:
                  $ref: '#/components/examples/company_document_verification_pdf_report_response_body'
              schema:
                $ref: '#/components/schemas/CompanyDocumentVerificationOutputPdfReport'
        '404':
          description: The PDF report is not available
components:
  schemas:
    CompanyDocumentVerificationOutputAnonymize:
      type: object
      required:
      - id
      - status
      - applicant_id
      - user_journey_id
      - response_codes
      - _links
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationOutputBase'
    CompanyDocumentVerificationOutputBase:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/CompanyDocumentVerificationId'
        status:
          $ref: '#/components/schemas/CompanyDocumentVerificationStatus'
        response_codes:
          type: array
          items:
            $ref: '#/components/schemas/ResponseCodes'
        risk_labels:
          $ref: '#/components/schemas/RiskLabels'
        company_document:
          $ref: '#/components/schemas/CompanyDocument'
        _links:
          $ref: '#/components/schemas/CompanyDocumentVerificationLinks'
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationBase'
      - $ref: '#/components/schemas/DatedObject'
    CountryCodeIso2:
      type: string
      format: ISO 3166-1 alpha-2
      pattern: ^[A-Za-z]{2}$
      example: US
    RiskLabels:
      type: array
      items:
        $ref: '#/components/schemas/RiskLabel'
      description: Risk assessment labels
    CompanyDocumentVerificationAttemptOutputGet:
      type: object
      required:
      - id
      - status
      - response_codes
      - _links
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationAttemptOutputBase'
    UserJourneyId:
      type: string
      description: User journey unique identifier.
      pattern: ^usj_\w+$
      example: usj_tkoi5db4hryu5cei5vwoabr7we
    ListLinks:
      type: object
      required:
      - self
      properties:
        self:
          description: Link to the current page
          $ref: '#/components/schemas/HalLink'
        previous:
          description: Link to the previous page (null if on the first page)
          $ref: '#/components/schemas/HalLink'
        next:
          description: Link to the next page (null if on the last page)
          $ref: '#/components/schemas/HalLink'
    RiskLabel:
      type: string
      description: Risk assessment label.
      enum:
      - multiple_faces_detected
      - mcc_not_confident
      - risky_document_format
    CompanyDocumentVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
          - $ref: '#/components/schemas/UserJourneyId'
        applicant_id:
          allOf:
          - $ref: '#/components/schemas/BusinessApplicantId'
        webhook_url:
          type: string
          format: uri
        declared_data:
          $ref: '#/components/schemas/CompanyDocumentVerificationDeclaredData'
    CompanyDocumentVerificationAttemptAsset:
      type: object
      required:
      - type
      - _links
      properties:
        type:
          type: string
          description: Type of asset
          enum:
          - document
        _links:
          type: object
          properties:
            asset_url:
              type: object
              properties:
                href:
                  type: string
                  format: uri
    SelfLink:
      type: object
      required:
      - self
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
    ResponseSummary:
      type: string
      description: A descriptive code of the response code.
    CompanyDocumentVerificationInputBase:
      type: object
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationBase'
    CompanyDocumentVerificationOutputPdfReport:
      type: object
      required:
      - pdf_report
      properties:
        pdf_report:
          type: string
          format: uri
    BusinessApplicantId:
      type: string
      description: Business Applicant unique identifier.
      pattern: ^bplt_\w+$
      example: bplt_tkoi5db4hryu5cei5vwoabr7we
    CompanyDocumentVerificationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: '#/components/schemas/CompanyDocumentVerificationAttemptStates'
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/ResponseCodes'
        _links:
          $ref: '#/components/schemas/SelfLink'
      allOf:
      - $ref: '#/components/schemas/DatedObject'
    CompanyDocumentVerificationAttemptStates:
      type: string
      description: Company Document Verification attempt state.
      enum:
      - quality_checks_in_progress
      - checks_in_progress
      - completed
      - quality_checks_aborted
      - checks_inconclusive
      - terminated
    Address:
      type: object
      properties:
        address_line1:
          type: string
          maxLength: 250
        address_line2:
          type: string
          maxLength: 250
        city:
          type: string
          maxLength: 50
        state:
          type: string
          maxLength: 50
        zip:
          type: string
          maxLength: 50
        country:
          $ref: '#/components/schemas/CountryCodeIso2'
    CompanyDocumentVerificationAttemptOutputList:
      type: object
      required:
      - total_count
      - skip
      - limit
      - _links
      - data
      properties:
        data:
          type: array
          description: Array of Company Document Verification attempts for the current page
          minItems: 0
          items:
            $ref: '#/components/schemas/CompanyDocumentVerificationAttemptOutputGet'
      allOf:
      - $ref: '#/components/schemas/BaseOutputList'
    CompanyDocumentVerificationStatus:
      type: string
      description: Company Document Verification status.
      enum:
      - created
      - quality_checks_in_progress
      - checks_in_progress
      - approved
      - declined
      - retry_required
      - inconclusive
    CompanyDocumentVerificationAttemptInputBase:
      type: object
      properties:
        document:
          type: string
          format: binary
    CompanyDocumentVerificationOutputPost:
      type: object
      required:
      - id
      - status
      - applicant_id
      - response_codes
      - user_journey_id
      - _links
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationOutputBase'
    ResponseCodes:
      type: object
      description: The code giving more details about the result.
      properties:
        code:
          $ref: '#/components/schemas/ResponseCode'
        summary:
          $ref: '#/components/schemas/ResponseSummary'
      required:
      - code
      - summary
    BaseOutputList:
      type: object
      properties:
        total_count:
          type: integer
          description: Total number of items available across all pages
        skip:
          type: integer
          description: Number of items skipped (offset from the start)
        limit:
          type: integer
          description: Maximum number of items returned in this page
        _links:
          $ref: '#/components/schemas/ListLinks'
    CompanyDocumentVerificationInputPost:
      type: object
      required:
      - applicant_id
      - user_journey_id
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationInputBase'
    ResponseCode:
      type: integer
      description: The numeric code of the response code.
      minimum: 10000
      maximum: 69999
    CompanyDocumentType:
      type: string
      description: Type of document.
      enum:
      - ein_letter
    CompanyDocumentVerificationLinks:
      type: object
      allOf:
      - $ref: '#/components/schemas/SelfLink'
    CompanyDocumentVerificationOutputGet:
      type: object
      required:
      - id
      - status
      - applicant_id
      - response_codes
      - user_journey_id
      - _links
      allOf:
      - $ref: '#/components/schemas/DatedObject'
      - $ref: '#/components/schemas/CompanyDocumentVerificationOutputBase'
    CompanyDocumentVerificationAttemptInputPost:
      type: object
      required:
      - document
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationAttemptInputBase'
    CompanyDocument:
      type: object
      properties:
        company_number:
          type: string
          maxLength: 255
        company_name:
          type: string
          minLength: 2
          maxLength: 510
        registered_address:
          $ref: '#/components/schemas/Address'
        issue_date:
          type: string
          format: date
        registration_date:
          type: string
          format: date
        document_type:
          $ref: '#/components/schemas/CompanyDocumentType'
    CompanyDocumentVerificationAttemptAssetsOutput:
      type: object
      required:
      - total_count
      - skip
      - limit
      - _links
      - data
      properties:
        data:
          type: array
          description: Array of Company Document Verification attempt assets for the current page
          minItems: 0
          items:
            $ref: '#/components/schemas/CompanyDocumentVerificationAttemptAsset'
      allOf:
      - $ref: '#/components/schemas/BaseOutputList'
    HalLink:
      type: object
      required:
      - href
      properties:
        href:
          type: string
          format: uri
    CompanyDocumentVerificationId:
      type: string
      description: Company Document Verification unique identifier.
      pattern: ^cdv_\w+$
      example: cdv_tkoi5db4hryu5cei5vwoabr7we
    CompanyDocumentVerificationAttemptOutputPost:
      type: object
      required:
      - id
      - status
      - response_codes
      - _links
      allOf:
      - $ref: '#/components/schemas/CompanyDocumentVerificationAttemptOutputBase'
    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
    CompanyDocumentVerificationDeclaredData:
      type: object
      required:
      - registered_name
      properties:
        registered_name:
          type: string
          minLength: 2
          maxLength: 255
  examples:
    company_document_verification_creation_request_body_min:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          registered_name: Acme Corporation
    company_document_verification_attempt_creation_request_body_min:
      value:
        document: 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…

          '
    company_document_verification_attempt_get_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21 17:32:28+00:00
        modified_on: 2017-07-21 17:40:32+00:00
        status: completed
        response_codes: []
        _links:
          self:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123
    company_document_verification_creation_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: '2017-07-21T17:32:28Z'
        modified_on: '2017-07-21T17:40:32Z'
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        status: created
        response_codes: []
        declared_data:
          registered_name: Acme Corporation
        company_document:
          company_number: 12-3456789
          registered_name: Acme Corporation
          legal_address:
            address_line1: 123 Main St
            city: New York
            state: NY
            zip: '10001'
            country: US
          issue_date: 2023-01-15
          registration_date: 2020-05-10
          document_type: ein_letter
        webhook_url: https://my.api/events/
        _links:
          self:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we
    company_document_verification_attempt_list_response_body:
      value:
        total_count: 2
        skip: 10
        limit: 10
        data:
        - id: cdv_tkoi5db4hryu5cei5vwoabr7we
          created_on: 2017-07-21 17:32:28+00:00
          modified_on: 2017-07-21 17:40:32+00:00
          status: completed
          response_codes: []
          _links:
            self:
              href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123
        _links:
          self:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts
          next:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/...
          previous:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/...
    company_document_verification_attempt_creation_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21 17:32:28+00:00
        modified_on: 2017-07-21 17:40:32+00:00
        status: completed
        response_codes: []
        _links:
          self:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123
    company_document_verification_pdf_report_response_body:
      value:
        pdf_report: https://www.example.com/reports/cdv_123.pdf
    company_document_verification_creation_request_body_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          registered_name: Acme Corporation
        webhook_url: https://my.api/events/
    company_document_verification_attempt_creation_request_body_max:
      value:
        document: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…

          '
    company_document_verification_attempt_output_assets_response_body:
      value:
        total_count: 1
        skip: 10
        limit: 10
        _links:
          self:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets
          next:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/...
          previous:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/...
        data:
        - type: document
          _links:
            asset_url:
              href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/document
    company_document_verification_anonymization_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21 17:32:28+00:00
        modified_on: 2017-07-21 17:40:32+00:00
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        status: created
        response_codes: []
        webhook_url: https://my.api/events/
        _links:
          self:
            href: https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we
  parameters:
    skipParam:
      name: skip
      in: query
      description: Number of items to skip (offset)
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return per page
      required: false
      schema:
        type: integer
        minimum: 1
        default: 10
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