onboarding

Submit an onboarding application

Changed on

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.

post/onboarding-applications

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Request body

customer_type'individual' | 'joint' | 'business' required

Response

Created

applicationobject required

Submitted application data.

created_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was created.

customer_type'individual' | 'joint' | 'business' required
idstring required

Unique resource identifier.

modified_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was last modified.

outcome'approved' | 'rejected' | 'expired'
status'pending' | 'processing' | 'completed' required

Changes

    • breaking

      request property /// was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      removed from the request property allOf list

    • warning

      added the new business enum value to the response property for the response status

    • warning

      added the new completed enum value to the response property for the response status

    • warning

      added the new individual enum value to the response property for the response status

    • warning

      added the new joint enum value to the response property for the response status

    • warning

      added the new pending enum value to the response property for the response status

    • warning

      added the new processing enum value to the response property for the response status

    • info

      the request property const value data_accuracy was removed

    • info

      added the new business enum value to the request property

    • info

      added the new data_accuracy enum value to the request property ///

    • info

      added the new individual enum value to the request property

    • info

      added the new joint enum value to the request property

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400