Register an end user Identity within the CFX platform. Identities must be registered with appropriate Identity Verification (IDV) checks before platform functionality can be provided for a user.
The request structure has a hasExistingIdv flag which nominates whether the user being registered has previously completed a successful IDV check. When true the endpoint expects IDV metadata to be provided in the ExistingIDV structure. This IDV metadata is required before an end user can be activated on the platform.
If a user has not successfully completed an IDV check (hasExistingIdv=false) an IDV process will be initiated for the end user. An idvShareableUrl will be provided in the response that can be shared directly with the user so they may complete the relevant IDV process.
Note that for additional customer assurance, any fields populated within the NewIDV request structure will be 'hard coded' in the IDV check and will not be open to change by the end user.