> ## 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.

# Submit an onboarding application

> Submits an onboarding application for compliance review. All referenced persons must already exist. The application is validated against the onboarding requirements for the given customer type.



## OpenAPI

````yaml /openapi.json post /onboarding-applications
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:
  /onboarding-applications:
    post:
      tags:
        - onboarding
      summary: Submit an onboarding application
      description: >-
        Submits an onboarding application for compliance review. All referenced
        persons must already exist. The application is validated against the
        onboarding requirements for the given customer type.
      operationId: submit_onboarding_application_onboarding_applications_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitOnboardingApplicationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingApplicationResponse'
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
      security:
        - HTTPBearer: []
components:
  schemas:
    SubmitOnboardingApplicationRequest:
      properties:
        authorities:
          description: People authorized to act and their authority types.
          items:
            $ref: '#/components/schemas/OnboardingAuthoritySpec'
          minItems: 1
          title: Authorities
          type: array
        consents:
          description: Consent declarations attached to the application.
          items:
            $ref: '#/components/schemas/OnboardingConsentSpec'
          title: Consents
          type: array
        customer_type:
          allOf:
            - $ref: '#/components/schemas/CustomerType'
          description: Customer structure for the application.
        evidence:
          description: Evidence files attached to the application.
          items:
            $ref: '#/components/schemas/OnboardingEvidenceSpec'
          title: Evidence
          type: array
      required:
        - customer_type
        - authorities
      title: SubmitOnboardingApplicationRequest
      type: object
    OnboardingApplicationResponse:
      properties:
        application:
          description: Submitted application data.
          title: Application
          type: object
        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:
          allOf:
            - $ref: '#/components/schemas/CustomerType'
          description: Customer type for the application.
        id:
          description: Unique resource identifier.
          title: Id
          type: string
        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
        outcome:
          anyOf:
            - $ref: '#/components/schemas/OnboardingApplicationOutcome'
            - type: 'null'
          description: Final application outcome.
        status:
          allOf:
            - $ref: '#/components/schemas/OnboardingApplicationStatus'
          description: Lifecycle status of the application.
      required:
        - created_at
        - modified_at
        - id
        - customer_type
        - status
        - application
      title: OnboardingApplicationResponse
      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
    OnboardingAuthoritySpec:
      additionalProperties: false
      description: A person reference with authority type.
      properties:
        authority_type:
          $ref: '#/components/schemas/AuthorityType'
        person:
          title: Person
          type: string
      required:
        - person
        - authority_type
      title: OnboardingAuthoritySpec
      type: object
    OnboardingConsentSpec:
      additionalProperties: false
      description: |-
        A consent declaration captured during onboarding.

        The `person_id` attributes the consent to a specific person -- an
        authority on the application, or a related person referenced by
        the legal entity's relationships claim. Validation of required
        consents happens per-person.

        `consent_type` is either a `LegalDocumentType` (the person accepted
        a specific legal document -- `legal_document_version` is required)
        or an `AttestationType` (the person made a self-attestation --
        `legal_document_version` must be omitted).
      properties:
        consent_type:
          anyOf:
            - $ref: '#/components/schemas/LegalDocumentType'
            - $ref: '#/components/schemas/AttestationType'
          title: Consent Type
        consented_at:
          format: date-time
          title: Consented At
          type: string
        legal_document_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Legal Document Version
        person:
          title: Person
          type: string
      required:
        - person
        - consent_type
        - consented_at
      title: OnboardingConsentSpec
      type: object
    CustomerType:
      enum:
        - individual
        - joint
        - business
      properties: {}
      title: CustomerType
      type: string
    OnboardingEvidenceSpec:
      additionalProperties: false
      description: |-
        An evidence file reference captured during onboarding.

        The `person_id` attributes the evidence to a specific person, so
        per-authority and per-relationship requirements can be validated
        against the subset of items belonging to that person.
      properties:
        document_type:
          anyOf:
            - $ref: >-
                #/components/schemas/sophic__domain__onboarding__enums__DocumentType
            - type: 'null'
        evidence_type:
          $ref: '#/components/schemas/EvidenceType'
        file:
          title: File
          type: string
        person:
          title: Person
          type: string
      required:
        - person
        - evidence_type
        - file
      title: OnboardingEvidenceSpec
      type: object
    OnboardingApplicationOutcome:
      enum:
        - approved
        - rejected
        - expired
      properties: {}
      title: OnboardingApplicationOutcome
      type: string
    OnboardingApplicationStatus:
      enum:
        - pending
        - processing
        - completed
      properties: {}
      title: OnboardingApplicationStatus
      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
    AuthorityType:
      enum:
        - owner
        - joint_owner
        - signatory
        - power_of_attorney
        - trading
      properties: {}
      title: AuthorityType
      type: string
    LegalDocumentType:
      enum:
        - investment_services_agreement
        - risk_disclosures
        - conflicts_of_interest_policy
        - complaints_handling_policy
        - client_assets_safeguarding_policy
        - investor_compensation_fund_policy
        - order_execution_policy
        - costs_and_charges
        - pccpc_prospectus
        - pccpc_special_regulations
        - pccpc_acceptance_declaration
      properties: {}
      title: LegalDocumentType
      type: string
    AttestationType:
      const: data_accuracy
      description: >-
        Self-declarations a person can make about a specific action or
        submission.


        An attestation is always recorded against a target resource (see

        `ConsentTargetType`) — for example, asserting data accuracy for an

        onboarding application the person is submitting. It does not

        reference a `LegalDocumentVersion`; the wording is implicit in the

        surrounding flow.
      properties: {}
      title: AttestationType
      type: string
    sophic__domain__onboarding__enums__DocumentType:
      enum:
        - passport
        - national_id_front
        - national_id_back
        - driving_license
        - driving_license_front
        - driving_license_back
        - utility_bill
        - bank_statement
        - tax_document
        - shareholder_register
        - share_certificate
        - director_register
        - board_minutes
        - certificate_of_good_standing
        - incumbency_certificate
        - audited_accounts
        - management_accounts
        - ubo_declaration
        - org_chart
        - trust_deed
        - nominee_agreement
        - board_resolution
      properties: {}
      title: DocumentType
      type: string
    EvidenceType:
      enum:
        - identity_document
        - proof_of_address
        - selfie
        - certificate_of_shareholders
        - certificate_of_directors
        - certificate_of_good_standing
        - financial_statements
        - ownership_structure
        - proof_of_registered_address
        - proof_of_operating_address
        - nominee_agreement
        - board_resolution
      properties: {}
      title: EvidenceType
      type: string
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````