Skip to main content
POST
/
onboarding-applications
Submit an onboarding application
curl --request POST \
  --url https://api.engine.usesophic.com/onboarding-applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_type": "individual",
  "authorities": [
    {
      "person": "<string>",
      "authority_type": "owner"
    }
  ],
  "consents": [
    {
      "person": "<string>",
      "consent_type": "terms_of_service",
      "consented_at": "2023-11-07T05:31:56Z",
      "legal_document_version": "<string>"
    }
  ],
  "evidence": [
    {
      "person": "<string>",
      "evidence_type": "identity_document",
      "file": "<string>",
      "document_type": "passport"
    }
  ]
}
'
{
  "id": "<string>",
  "customer_type": "individual",
  "status": "pending",
  "application": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "outcome": "approved"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Submit a new onboarding application referencing existing persons.

customer_type
enum<string>
required

The intended customer type: individual, joint, or business.

Available options:
individual,
joint,
business
authorities
OnboardingAuthoritySpec · object[]
required

Person references with authority type.

Minimum array length: 1
consents
OnboardingConsentSpec · object[]

Consent declarations for this application.

evidence
OnboardingEvidenceSpec · object[]

Evidence file references.

Response

Created

Response for a persisted onboarding application record.

id
string
required

Unique resource identifier.

customer_type
enum<string>
required

The customer type for this onboarding.

Available options:
individual,
joint,
business
status
enum<string>
required

Lifecycle status of the application.

Available options:
pending,
processing,
completed
application
Application · object
required

The full application payload as submitted.

created_at
string<date-time>
required

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

modified_at
string<date-time>
required

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

outcome
enum<string> | null

Final outcome (populated after processing completes).

Available options:
approved,
rejected,
expired