For the complete documentation index, see llms.txt. This page is also available as Markdown.

Customer Onboarding

Customers must be onboarded by Aquanow to the CAMS platform before any transaction activity can be initiated on their account. The customer onboarding journey is guided by a status of their documents, a status of the onboarding workflow, and ultimately the customer status. Once a customer is ACTIVE their account is ready for use.

This section describes the end-to-end onboarding sequence: submitting customer details, uploading identity documentation, monitoring onboarding status, and creating the account.

Retail Customer Onboarding (with reliance)

  1. Submit the customer's profile information via POST /v1/customers. This includes identity details (full name, nationality, address, date of birth, place of birth), compliance attestations (sanctions and PEP screening results), and employment information.

  2. CAMS creates the customer record and returns a customerId, an initial customerStatus, and an onboardingStatus along with a list of required documents (e.g. PASSPORT, NATIONAL_ID_FRONT, NATIONAL_ID_BACK), each initially in PENDING_RECEIPT status.

  3. Submit the required identity documents via POST /v1/customers/{customerId}/docs, one document at a time, using multipart/form-data. Each document includes a documentType, a documentFormat, and the file itself (maximum 10MB).

  4. CAMS processes and verifies each submitted document. The onboardingStatus transitions through PROCESSING and UNDER_REVIEW as documents are verified.

  5. If a submitted document is rejected (status UNREADABLE, INVALID, or MISMATCH), resubmit the corrected document via PUT /v1/customers/{customerId}/docs (maximum 2MB).

  6. Once all required documents are verified and compliance checks pass, the customer's onboardingStatus moves to ONBOARDED and customerStatus moves to ACTIVE. CAMS dispatches a CUSTOMER_ACCOUNT_READY webhook (see Onboarding Status Webhook below).

  7. Upon Customer verification, use the GET /v1/customers/{customerId} endpoint, which will supply the customerId, currency, accountType and an accountLabel. The returned accountId becomes the customerAccountId used in funding requests and the accountId used in payouts and transfers.

  8. Persist the accountId and accountNumber returned in the account creation response (or the CUSTOMER_ACCOUNT_READY webhook). The customer is now ready to fund their account or receive a payout.

CAMS Customer Onboarding Process Flow

Three possible Status scenarios arise during customer onboarding, and they may be related to any of the following:

Customer Status: This state may include anything that relates to the customer.

Status
Description

ACTIVE

This status represents the successful outcome of the entire onboarding process. The customer has completed all required steps, passed compliance checks, and their account is fully provisioned and operational, requiring no further action from the onboarding team.

ONBOARDING

This status is an in-progress state indicating that the customer has started the journey and the automated or manual processes are moving forward as expected. Thus, onboarding is a neutral status where the system is working through the necessary validations and provisioning steps.

ONBOARDING FAILED

This status is a critical, terminal status. It signifies that the customer cannot be onboarded due to a significant block or error. Thus, onboarding failed status may require escalation. The next step is to review the "onboarding status" and "document status" to identify the root cause of the failure.

PENDING

This status indicates that the process has been temporarily paused. The system is waiting for a specific piece of information or action, either from the customer or an internal team. To determine exactly what is needed, operational staff must investigate the secondary "onboarding status.”

INACTIVE

This status refers to accounts that are not currently in use, either because they were never activated, or were previously active and have since been deactivated.

Onboarding Status: This state may include anything that relates to documents that have been shared by the customer.

Status
Description

PENDING_DOCUMENT_RECEIPT

This state specifically highlights that while the customer application exists, the mandatory documentation required to proceed with verification has not yet been received by the system. The next step involves checking individual document statuses to prompt the customer effectively.

PROCESSING

This is a standard operational status signifying that the data provided by the customer is currently being run through verification checks.

UNDER REVIEW

This status indicates that document processing by the system is complete, but the results or the nature of the application require a manual review by our internal compliance/onboarding team.

ONBOARDED

It is the final successful status for this workflow, confirming that all compliance and data requirements have been met, and the customer is cleared to be moved to the top-level active status.

FAILED

If an application reaches a failed onboarding status, it means the customer did not meet the mandatory compliance requirements during the review phase. This is a definitive end to the current onboarding attempt.

Document Status: This state is very detailed, pinpointing the exact reason a single document was accepted, is pending, or was rejected. These are essential for providing specific feedback to the customer as to why the application was successful or not.

Status
Description

PENDING RECEIPT

This status indicates the document has not yet been submitted by the customer.

PROCESSING

This status confirms that the document has been uploaded and is being scanned and analyzed by the system.

VERIFIED

This status is the positive outcome, signifying that the document passed all checks and is valid for identification purposes.

EXPIRED

This status means that the document's date of validity is in the past.

UNREADABLE

This status is assigned when the image quality is too poor to extract information.

INVALID

This status means the type of document submitted is not an acceptable form of ID.

MISMATCH

It occurs when the name on the document does not align with the name provided by the customer.

PENDING RESUBMISSION

This status is used to indicate that a failure has been communicated to the user and the system is awaiting a corrected upload.

Business Customer Onboarding

>>coming soon<<

For more information of Onboarding endpoints and methods, see the Endpoints and Methods section in Customer Onboarding.

Last updated