> ## 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 https://api.engine.usesophic.com/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: []
paths:
  /onboarding-applications:
    post:
      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':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingApplicationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - HTTPBearer: []
components:
  schemas:
    SubmitOnboardingApplicationRequest:
      properties:
        customer_type:
          allOf:
            - $ref: '#/components/schemas/CustomerType'
          description: 'The intended customer type: individual, joint, or business.'
        authorities:
          items:
            $ref: '#/components/schemas/OnboardingAuthoritySpec'
          type: array
          minItems: 1
          title: Authorities
          description: Person references with authority type.
        consents:
          items:
            $ref: '#/components/schemas/OnboardingConsentSpec'
          type: array
          title: Consents
          description: Consent declarations for this application.
        evidence:
          items:
            $ref: '#/components/schemas/OnboardingEvidenceSpec'
          type: array
          title: Evidence
          description: Evidence file references.
      type: object
      required:
        - customer_type
        - authorities
      title: SubmitOnboardingApplicationRequest
      description: Submit a new onboarding application referencing existing persons.
    OnboardingApplicationResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique resource identifier.
        customer_type:
          allOf:
            - $ref: '#/components/schemas/CustomerType'
          description: The customer type for this onboarding.
        status:
          allOf:
            - $ref: '#/components/schemas/OnboardingApplicationStatus'
          description: Lifecycle status of the application.
        outcome:
          anyOf:
            - $ref: '#/components/schemas/OnboardingApplicationOutcome'
            - type: 'null'
          description: Final outcome (populated after processing completes).
        application:
          type: object
          title: Application
          description: The full application payload as submitted.
        created_at:
          type: string
          format: date-time
          title: 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.
        modified_at:
          type: string
          format: date-time
          title: 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.
      type: object
      required:
        - created_at
        - modified_at
        - id
        - customer_type
        - status
        - application
      title: OnboardingApplicationResponse
      description: Response for a persisted onboarding application record.
    Error:
      properties:
        detail:
          type: string
          title: Detail
          description: A human-readable description of the error.
        code:
          type: string
          title: Code
          description: A machine-readable error code.
        docs:
          title: Docs
          description: A URL to documentation about this error code.
          x-remove-null-from-type-union: true
          type: string
        context:
          title: Context
          description: An optional object for adding extra context to the error.
          x-remove-null-from-type-union: true
          additionalProperties:
            anyOf:
              - type: string
              - type: integer
          type: object
        params:
          title: Params
          description: An optional list of params that failed validation.
          x-remove-null-from-type-union: true
          items:
            $ref: '#/components/schemas/InvalidParam'
          type: array
      type: object
      required:
        - detail
        - code
      title: Error
    CustomerType:
      type: string
      enum:
        - individual
        - joint
        - business
      title: CustomerType
      properties: {}
    OnboardingAuthoritySpec:
      properties:
        person:
          type: string
          title: Person
        authority_type:
          $ref: '#/components/schemas/AuthorityType'
      additionalProperties: false
      type: object
      required:
        - person
        - authority_type
      title: OnboardingAuthoritySpec
      description: A person reference with authority type.
    OnboardingConsentSpec:
      properties:
        person:
          type: string
          title: Person
        consent_type:
          anyOf:
            - $ref: '#/components/schemas/LegalDocumentType'
            - $ref: '#/components/schemas/AttestationType'
          title: Consent Type
        legal_document_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Legal Document Version
        consented_at:
          type: string
          format: date-time
          title: Consented At
      additionalProperties: false
      type: object
      required:
        - person
        - consent_type
        - consented_at
      title: OnboardingConsentSpec
      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).
    OnboardingEvidenceSpec:
      properties:
        person:
          type: string
          title: Person
        evidence_type:
          $ref: '#/components/schemas/EvidenceType'
        document_type:
          anyOf:
            - $ref: >-
                #/components/schemas/sophic__domain__onboarding__enums__DocumentType
            - type: 'null'
        file:
          type: string
          title: File
      additionalProperties: false
      type: object
      required:
        - person
        - evidence_type
        - file
      title: OnboardingEvidenceSpec
      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.
    OnboardingApplicationStatus:
      type: string
      enum:
        - pending
        - processing
        - completed
      title: OnboardingApplicationStatus
      properties: {}
    OnboardingApplicationOutcome:
      type: string
      enum:
        - approved
        - rejected
        - expired
      title: OnboardingApplicationOutcome
      properties: {}
    InvalidParam:
      properties:
        path:
          items:
            anyOf:
              - type: integer
              - type: string
          type: array
          title: Path
          description: Path to the field name (or index if a list) that errored.
        detail:
          type: string
          title: Detail
          description: Human-readable detail for error.
        code:
          type: string
          title: Code
          description: A machine-readable error code.
      type: object
      required:
        - path
        - detail
        - code
      title: InvalidParam
    AuthorityType:
      type: string
      enum:
        - owner
        - joint_owner
        - signatory
        - power_of_attorney
        - trading
      title: AuthorityType
      properties: {}
    LegalDocumentType:
      type: string
      enum:
        - terms_of_service
        - investment_service_agreement
        - risk_disclosures
        - conflicts_of_interest_policy
        - complaints_handling_policy
        - client_assets_safeguarding_policy
        - investor_compensation_fund_policy
        - order_execution_policy
      title: LegalDocumentType
      properties: {}
    AttestationType:
      type: string
      const: data_accuracy
      title: AttestationType
      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: {}
    EvidenceType:
      type: string
      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
      title: EvidenceType
      properties: {}
    sophic__domain__onboarding__enums__DocumentType:
      type: string
      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
      title: DocumentType
      properties: {}
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````