Customers | Aquanow CAMS v1.0 (Updated)

Aquanow CAMS v1.0 (Updated)

Get Customer

get

Retrieve a Customer with optional filtering and pagination.

Authorizations

Path parameters

customerIdstring · uuidRequired

The ID of the customer

Example: 5937e644-0066-44a6-a335-d37a95198bb4

Responses

200

application/json

400

Validation Error

401

Unauthorized

5XX

Server error

4XX

Client error

get

GET /api/v1/customers/{customerId} HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "text",
  "customerStatus": "ONBOARDING",
  "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
  "customerType": "RETAIL",
  "createDate": "2024-08-01T18:44:05Z",
  "customerPreTradeRiskGroup": "LOW",
  "accounts": [
    {
      "accountNumber": "9019283R",
      "accountName": "text",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "accountStatus": "ACTIVE",
      "accountType": "CREDIT"
    }
  ],
  "documents": [
    {
      "documentType": "PASSPORT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_FRONT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_BACK",
      "documentStatus": "PENDING_RECEIPT"
    }
  ]
}

Get Customers

get

Retrieve a list of customers with optional filtering and pagination.

Authorizations

Query parameters

customerStatusstring · enumOptional

Filter customers by status

Possible values:

createDateStartstring · date-timeOptional

Filter customers by creation date lower bound, exclusive

createDateEndstring · date-timeOptional

Filter customers by creation date upper bound, inclusive

referenceIdstringOptional

Filter customers by reference ID

afterstringOptional

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integerOptional

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortFieldstring · enumOptional

Will sort the returned data using the specified field.

Possible values:

sortDirectionstring · enumOptional

Specifies the sort direction for the sortField.

Possible values:

Responses

200

application/json

401

Unauthorized

404

Not Found

get

GET /api/v1/customers HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "referenceId": "text",
      "customerStatus": "ONBOARDING",
      "customerType": "RETAIL",
      "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
      "createDate": "2025-05-17T12:28:43.282Z",
      "customerPreTradeRiskGroup": "LOW",
      "accounts": [
        {
          "accountNumber": "9019283R",
          "accountName": "text",
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "accountStatus": "ACTIVE",
          "accountType": "CREDIT"
        }
      ]
    }
  ]
}

Update Customer

patch

Submit a request to update the “Customer Pre-Trade Risk Group“ based on the outcomes of appropriateness/suitability tests during onboarding and periodic reviews, to set limits on order sizes and monthly trade volumes for risk mitigation; may require broker approval.

Authorizations

Path parameters

customerIdstring · uuidRequired

The customer ID of the customer

Body

customerPreTradeRiskGroupstring · enumRequiredExample: LOWPossible values:

Responses

200

application/json

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

patch

PATCH /api/v1/customers/{customerId} HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "customerPreTradeRiskGroup": "LOW"
}

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerPreTradeRiskGroup": "LOW"
}

Add a new customer

post

Will add a customer and create a permanent reference to that customer

Authorizations

Body

referenceIdstringRequired

Use this field to correlate a customer in CAMS to the customer in another system

fullNamestringRequiredExample: John Doe

nationalitystringRequired

Country string that matches either ISO 3166 name, ISO 3166-1 A-2 or ISO 3166-1 A-3. Please see: https://www.iso.org/iso-3166-country-codes.html

Example: Canada

placeOfBirthstringRequiredExample: Toronto, Canada

dateOfBirthstring · dateRequired

employerNamestringOptionalExample: Aquanow

sanctionsScreeningCompletedstring · enumRequiredPossible values:

sanctionsScreeningCompletedAtstring · date-timeOptional

This field is required if sanctionsScreeningCompleted is YES

Example: 2024-09-10T22:26:49.739Z

pepScreeningCompletedstring · enumRequiredPossible values:

pepScreeningCompletedAtstring · date-timeOptional

This field is required if pepScreeningCompleted is YES

Example: 2024-09-10T22:26:49.739Z

livenessCheckCompletedstring · enumRequiredPossible values:

livenessCheckCompletedAtstring · date-timeOptional

This field is required if livenessCheckCompleted is YES

Example: 2024-09-10T22:26:49.739Z

isPEPstring · enumOptional

This field indicates if the customer is a politically exposed person

Possible values:

isSanctionedstring · enumOptional

This field indicates if the customer is sanctioned

Possible values:

employmentStatusundefined · enumOptional

This field indicates the employment status of the customer

Possible values:

Responses

200

application/json

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

post

POST /api/v1/customers HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 852

{
  "referenceId": "text",
  "fullName": "John Doe",
  "nationality": "Canada",
  "address": {
    "streetNumber": "1234",
    "streetName": "Main St",
    "unit": "Apt 101",
    "poBox": "PO Box 1234",
    "postalCode": "M5V 1A1",
    "city": "Toronto",
    "state": "ON",
    "country": "Canada",
    "addressType": "RESIDENTIAL"
  },
  "placeOfBirth": "Toronto, Canada",
  "dateOfBirth": "2025-05-17",
  "employerName": "Aquanow",
  "employerAddress": {
    "streetNumber": "1234",
    "streetName": "Main St",
    "unit": "Apt 101",
    "poBox": "PO Box 1234",
    "postalCode": "M5V 1A1",
    "city": "Toronto",
    "state": "ON",
    "country": "Canada"
  },
  "sanctionsScreeningCompleted": "YES",
  "sanctionsScreeningCompletedAt": "2024-09-10T22:26:49.739Z",
  "pepScreeningCompleted": "YES",
  "pepScreeningCompletedAt": "2024-09-10T22:26:49.739Z",
  "livenessCheckCompleted": "YES",
  "livenessCheckCompletedAt": "2024-09-10T22:26:49.739Z",
  "isPEP": "YES",
  "isSanctioned": "YES",
  "employmentStatus": "Employed"
}

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "text",
  "customerStatus": "ONBOARDING",
  "customerType": "RETAIL",
  "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
  "createdAt": "2025-05-17T12:28:43.282Z",
  "customerPreTradeRiskGroup": "LOW",
  "documents": [
    {
      "documentType": "PASSPORT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_FRONT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_BACK",
      "documentStatus": "PENDING_RECEIPT"
    }
  ]
}