> ## Documentation Index
> Fetch the complete documentation index at: https://docs.engine.usesophic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a customer

> Retrieve a customer by ID.



## OpenAPI

````yaml /openapi.json get /customers/{id}
openapi: 3.1.0
info:
  title: Sophic Engine API
  version: 0.1.0
servers:
  - url: https://api.engine.usesophic.com
security: []
tags:
  - description: Retrieve accounts, statements, and account documents.
    name: accounts
    x-group: Accounts
  - description: Read the audit trail of platform activity.
    name: activity
    x-group: Activity
  - description: Obtain OAuth access tokens for the Engine API.
    name: auth
    x-group: Authentication
  - description: Inspect the authenticated user or service actor.
    name: identity
    x-group: Identity
  - description: Retrieve fee schedules and billing information.
    name: billing
    x-group: Billing
  - description: Browse instruments and tradable products.
    name: catalog
    x-group: Catalog
  - description: Track onboarding applications through completion.
    name: onboarding
    x-group: Onboarding
  - description: Manage customer records and related person data.
    name: customers
    x-group: Customers
  - description: List platform events and inspect individual occurrences.
    name: events
    x-group: Events
  - description: Read positions, transactions, and account holdings.
    name: holdings
    x-group: Holdings
  - description: Retrieve legal agreements and required disclosures.
    name: legal-documents
    x-group: Legal Documents
  - description: Access prices and market data for instruments.
    name: market-data
    x-group: Market Data
  - description: Manage deposits, withdrawals, and funding accounts.
    name: payments
    x-group: Payments
  - description: Retrieve returns, earnings, and performance metrics.
    name: performance
    x-group: Performance
  - description: Place and manage orders, quotes, and trades.
    name: trading
    x-group: Trading
  - description: Read position and account valuations over time.
    name: valuation
    x-group: Valuation
  - description: Configure webhook endpoints and inspect deliveries.
    name: webhooks
    x-group: Webhooks
  - description: Upload files and retrieve stored documents.
    name: files
    x-group: Files
paths:
  /customers/{id}:
    get:
      tags:
        - customers
      summary: Retrieve a customer
      description: Retrieve a customer by ID.
      operationId: get_customer_customers__id__get
      parameters:
        - description: The ID of the customer.
          in: path
          name: id
          required: true
          schema:
            description: The ID of the customer.
            title: Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                discriminator:
                  mapping:
                    business:
                      $ref: '#/components/schemas/BusinessCustomer'
                    individual:
                      $ref: '#/components/schemas/IndividualCustomer'
                    joint:
                      $ref: '#/components/schemas/JointCustomer'
                  propertyName: customer_type
                oneOf:
                  - $ref: '#/components/schemas/IndividualCustomer'
                  - $ref: '#/components/schemas/JointCustomer'
                  - $ref: '#/components/schemas/BusinessCustomer'
                title: Response Get Customer Customers  Id  Get
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
      security:
        - HTTPBearer: []
components:
  schemas:
    BusinessCustomer:
      properties:
        address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
          description: Customer's primary address.
        created_at:
          description: >-
            The timestamp (in
            [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)
            format) of when the resource was created.
          format: date-time
          title: Created At
          type: string
        customer_type:
          const: business
          description: Customer classification.
          title: Customer Type
        entity_name:
          description: Registered business name.
          title: Entity Name
          type: string
        entity_type:
          anyOf:
            - type: string
            - type: 'null'
          description: Legal form of the business.
          title: Entity Type
        full_name:
          description: Customer's full display name.
          title: Full Name
          type: string
        id:
          description: Unique resource identifier.
          title: Id
          type: string
        lei_code:
          anyOf:
            - type: string
            - type: 'null'
          description: Legal Entity Identifier.
          title: Lei Code
        lei_code_expiry_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Expiry date of the Legal Entity Identifier.
          examples:
            - '2027-06-30'
          title: Lei Code Expiry Date
        mifid_category:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's MiFID classification.
          title: Mifid Category
        modified_at:
          description: >-
            The timestamp (in
            [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)
            format) of when the resource was last modified.
          format: date-time
          title: Modified At
          type: string
        onboarding:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the customer's onboarding process.
          title: Onboarding
        operating_address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
          description: Primary operating address.
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's primary phone number.
          title: Phone Number
        reference:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer-visible reference.
          title: Reference
        referrer_code:
          anyOf:
            - type: string
            - type: 'null'
          description: Referral code associated with the customer.
          title: Referrer Code
        risk_profile:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's assigned risk profile.
          title: Risk Profile
        risk_score:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's risk score.
          examples:
            - '42.50'
          title: Risk Score
        status:
          allOf:
            - $ref: '#/components/schemas/CustomerStatus'
          description: Current customer status.
      required:
        - created_at
        - modified_at
        - id
        - reference
        - status
        - full_name
        - onboarding
        - mifid_category
        - address
        - phone_number
        - risk_profile
        - risk_score
        - referrer_code
        - customer_type
        - entity_name
        - entity_type
        - lei_code
        - lei_code_expiry_date
        - operating_address
      title: BusinessCustomer
      type: object
    IndividualCustomer:
      properties:
        address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
          description: Customer's primary address.
        created_at:
          description: >-
            The timestamp (in
            [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)
            format) of when the resource was created.
          format: date-time
          title: Created At
          type: string
        customer_type:
          const: individual
          description: Customer classification.
          title: Customer Type
        date_of_birth:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: Customer's date and time of birth.
          examples:
            - '1988-04-12T00:00:00Z'
          title: Date Of Birth
        first_name:
          description: Customer's first name.
          title: First Name
          type: string
        full_name:
          description: Customer's full display name.
          title: Full Name
          type: string
        id:
          description: Unique resource identifier.
          title: Id
          type: string
        id_number:
          anyOf:
            - type: string
            - type: 'null'
          description: Masked national identity number.
          title: Id Number
        last_name:
          description: Customer's last name.
          title: Last Name
          type: string
        mifid_category:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's MiFID classification.
          title: Mifid Category
        modified_at:
          description: >-
            The timestamp (in
            [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)
            format) of when the resource was last modified.
          format: date-time
          title: Modified At
          type: string
        nationalities:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: ISO 3166-1 alpha-2 nationality codes.
          title: Nationalities
        onboarding:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the customer's onboarding process.
          title: Onboarding
        passport_number:
          anyOf:
            - type: string
            - type: 'null'
          description: Masked passport number.
          title: Passport Number
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's primary phone number.
          title: Phone Number
        reference:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer-visible reference.
          title: Reference
        referrer_code:
          anyOf:
            - type: string
            - type: 'null'
          description: Referral code associated with the customer.
          title: Referrer Code
        risk_profile:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's assigned risk profile.
          title: Risk Profile
        risk_score:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's risk score.
          examples:
            - '42.50'
          title: Risk Score
        status:
          allOf:
            - $ref: '#/components/schemas/CustomerStatus'
          description: Current customer status.
        tax_number:
          anyOf:
            - type: string
            - type: 'null'
          description: Masked tax identification number.
          title: Tax Number
      required:
        - created_at
        - modified_at
        - id
        - reference
        - status
        - full_name
        - onboarding
        - mifid_category
        - address
        - phone_number
        - risk_profile
        - risk_score
        - referrer_code
        - customer_type
        - first_name
        - last_name
        - date_of_birth
        - nationalities
        - passport_number
        - id_number
        - tax_number
      title: IndividualCustomer
      type: object
    JointCustomer:
      properties:
        address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
          description: Customer's primary address.
        created_at:
          description: >-
            The timestamp (in
            [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)
            format) of when the resource was created.
          format: date-time
          title: Created At
          type: string
        customer_type:
          const: joint
          description: Customer classification.
          title: Customer Type
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Combined first names of the joint owners.
          title: First Name
        full_name:
          description: Customer's full display name.
          title: Full Name
          type: string
        id:
          description: Unique resource identifier.
          title: Id
          type: string
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Combined last names of the joint owners.
          title: Last Name
        mifid_category:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's MiFID classification.
          title: Mifid Category
        modified_at:
          description: >-
            The timestamp (in
            [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html)
            format) of when the resource was last modified.
          format: date-time
          title: Modified At
          type: string
        onboarding:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the customer's onboarding process.
          title: Onboarding
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's primary phone number.
          title: Phone Number
        reference:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer-visible reference.
          title: Reference
        referrer_code:
          anyOf:
            - type: string
            - type: 'null'
          description: Referral code associated with the customer.
          title: Referrer Code
        risk_profile:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's assigned risk profile.
          title: Risk Profile
        risk_score:
          anyOf:
            - type: string
            - type: 'null'
          description: Customer's risk score.
          examples:
            - '42.50'
          title: Risk Score
        status:
          allOf:
            - $ref: '#/components/schemas/CustomerStatus'
          description: Current customer status.
      required:
        - created_at
        - modified_at
        - id
        - reference
        - status
        - full_name
        - onboarding
        - mifid_category
        - address
        - phone_number
        - risk_profile
        - risk_score
        - referrer_code
        - customer_type
        - first_name
        - last_name
      title: JointCustomer
      type: object
    Error:
      properties:
        code:
          description: A machine-readable error code.
          title: Code
          type: string
        context:
          additionalProperties:
            anyOf:
              - type: string
              - type: integer
          description: An optional object for adding extra context to the error.
          title: Context
          type: object
          x-remove-null-from-type-union: true
        detail:
          description: A human-readable description of the error.
          title: Detail
          type: string
        docs:
          description: A URL to documentation about this error code.
          title: Docs
          type: string
          x-remove-null-from-type-union: true
        params:
          description: An optional list of params that failed validation.
          items:
            $ref: '#/components/schemas/InvalidParam'
          title: Params
          type: array
          x-remove-null-from-type-union: true
      required:
        - detail
        - code
      title: Error
      type: object
    Address:
      properties:
        city:
          description: City or locality.
          title: City
          type: string
        country_code:
          description: ISO 3166-1 alpha-2 country code.
          title: Country Code
          type: string
        district_county:
          anyOf:
            - type: string
            - type: 'null'
          description: District or county.
          title: District County
        line1:
          description: Primary street address line.
          title: Line1
          type: string
        line2:
          anyOf:
            - type: string
            - type: 'null'
          description: Additional street address line.
          title: Line2
        line3:
          anyOf:
            - type: string
            - type: 'null'
          description: Further street address line.
          title: Line3
        postal_code:
          description: Postal code.
          title: Postal Code
          type: string
      required:
        - line1
        - line2
        - line3
        - district_county
        - city
        - postal_code
        - country_code
      title: Address
      type: object
    CustomerStatus:
      enum:
        - active
        - suspended
        - closing
        - closed
      properties: {}
      title: CustomerStatus
      type: string
    InvalidParam:
      properties:
        code:
          description: A machine-readable error code.
          title: Code
          type: string
        detail:
          description: Human-readable detail for error.
          title: Detail
          type: string
        path:
          description: Path to the field name (or index if a list) that errored.
          items:
            anyOf:
              - type: integer
              - type: string
          title: Path
          type: array
      required:
        - path
        - detail
        - code
      title: InvalidParam
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````