Onboarding

Begin new customer onboarding application

Permissions required: Onboarding Initiate onboarding application for a new customer of Anchorage Digital

post/onboarding/customers

Request

Base URL
https://api.anchorage-staging.com/v2
Auth
API key in header Api-Access-Key
TypeScript
https://skmtc.dev/anchorage/apis/anchorage-digital-api-reference/docs/onboarding/customers/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

applicationType'RIA_PC_INSTITUTION' | 'RIA_PC_INDIVIDUAL'

Anchorage Digital provided type of application, RIA_PC_INDIVIDUAL to Onboard RIA Program Customer who is an Individual and RIA_PC_INSTITUTION to Onboard RIA Program Customer that is an Institution.

applicationVersioninteger

Anchorage Digital version of the application. By default, this value is 0.

externalIdstring

External identifier for the customer onboarding application. This value has to be unique for each customer application.

submitboolean

Optional parameter to try to submit the application if there are no validation errors. This action is irreversible you cannot update the application values after. You can use this to avoid making another api call to POST /v2/onboarding/customers/submit

Example request

{
  "applicationType": "RIA_PC_INSTITUTION"
}

Response

Customer ID and information of the successfully created customer onboarding application

Changes

No recorded changes to this operation across all 1 revision of this API.