Stellar API Component Schemas

OpenAPI 3.0.0 Specification

Documentation Information

Version: 1.0.0

Title: Component Schemas

Description: This document demonstrates my ability to create and maintain OpenAPI YAML schemas to support developer onboarding and integration clarity. The schema defines customer KYC flows, transaction structures, and SEP protocol status mappings.

Format: YAML (OpenAPI 3.0.0)

Author: Taylor McNeil

📋 Component Schemas YAML
openapi: 3.0.0
info:
  version: "1.0.0"
  title: Component Schemas
  description: |
    This document specifies the schemas used for all APIs.
tags:
  - name: "Component Schemas"
    description: "Component Schemas"
paths: { }
components:
  schemas:
    PutCustomerRequest:
      type: object
      properties:
        id:
          description: The ID of the customer as returned in the response of a previous PUT request.
          type: string
        account:
          description: The Stellar or Muxed Account authenticated with the Platform via SEP-10.
          type: string
        memo:
          description: The memo value identifying a customer with a shared account, where the shared account is `account`.
          type: string
        memo_type:
          description: The type of memo used to identify a customer with a shared account.
          type: string
          enum:
            - id
            - hash
            - text
        type:
          description: |
            The type of action the customer is being KYCd for. 
            See the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.
            For SEP-31 you can define your own types in the assets configuration.
            For SEP-24 pre-defined value `sep24-customer` is used.
          type: string
        first_name:
          type: string
        last_name:
          type: string
        additional_name:
          type: string
        address_country_code:
          type: string
        state_or_province:
          type: string
        city:
          type: string
        postal_code:
          type: string
        address:
          type: string
        mobile_number:
          type: string
        email_address:
          type: string
        birth_date:
          type: string
          format: date
        birth_place:
          type: string
        birth_country_code:
          type: string
        bank_account_number:
          type: string
        bank_account_type:
          type: string
        bank_number:
          type: string
        bank_phone_number:
          type: string
        bank_branch_number:
          type: string
        tax_id:
          type: string
        tax_id_name:
          type: string
        occupation:
          type: string
        employer_name:
          type: string
        employer_address:
          type: string
        language_code:
          type: string
        id_type:
          type: string
        id_country_code:
          type: string
        id_issue_date:
          type: string
          format: date
        id_expiration_date:
          type: string
          format: date
        id_number:
          type: string
        ip_address:
          type: string
        sex:
          type: string

    PutCustomerResponse:
      type: object
      properties:
        id:
          type: string

    # Additional schemas truncated for brevity - full content available in downloadable version

Stellar API Component Schemas - OpenAPI 3.0.0 Specification by Taylor McNeil