Customers | Aquanow CAMS v1.0 (Updated)

Aquanow CAMS v1.0 (Updated)

Get Customer

Retrieve a Customer with optional filtering and pagination.

GEThttps://cams.aquanow.com/api/v1/customers/{customerId}

Authorization

Path parameters

customerId*string (uuid)

The ID of the customer

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

Response

Body

customerIdstring (uuid)

referenceIdstring

customerStatusenum

ONBOARDINGACTIVEINACTIVE

onboardingStatusenum

PENDING_DOCUMENTATION_RECEIPTPROCESSINGONBOARDINGFAILEDONBOARDED

customerTypeenum

RETAILENTERPRISEWEALTH

createDateDatetime

Date-time in ISO 8601 format

Example: "2024-08-01T18:44:05Z"

customerPreTradeRiskGroupenum

Example: "LOW"

LOWHIGHnull

accountsAccounts

Account information about a customer

documentsDocuments

Customer documents

Example:

[{"documentType":"PASSPORT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_FRONT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_BACK","documentStatus":"PENDING_RECEIPT"}]

Request

const response = await fetch('https://cams.aquanow.com/api/v1/customers/{customerId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "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

Retrieve a list of customers with optional filtering and pagination.

GEThttps://cams.aquanow.com/api/v1/customers

Authorization

Query parameters

Response

Body

afternullable string

The token of the last item in the response

totalCountstring (integer)

The total number of items in the entire filtered data set

Example: "1"

itemsarray of object

Request

const response = await fetch('https://cams.aquanow.com/api/v1/customers', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

Update Customer

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.

PATCHhttps://cams.aquanow.com/api/v1/customers/{customerId}

Authorization

Path parameters

customerId*string (uuid)

The customer ID of the customer

Body

customerPreTradeRiskGroup*enum

Example: "LOW"

LOWHIGHnull

Response

Body

customerIdstring (uuid)

customerPreTradeRiskGroupenum

Example: "LOW"

LOWHIGHnull

Request

const response = await fetch('https://cams.aquanow.com/api/v1/customers/{customerId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerPreTradeRiskGroup": "LOW"
    }),
});
const data = await response.json();

Response

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

Add a new customer

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

POSThttps://cams.aquanow.com/api/v1/customers

Authorization

Body

referenceId*string

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

fullName*string

Example: "John Doe"

nationality*string

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"

address*object

placeOfBirth*string

Example: "Toronto, Canada"

dateOfBirth*string (date)

employerNamestring

Example: "Aquanow"

employerAddressEmployerAddress

sanctionsScreeningCompleted*enum

YESNO

sanctionsScreeningCompletedAtstring (date-time)

This field is required if sanctionsScreeningCompleted is YES

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

pepScreeningCompleted*enum

YESNO

pepScreeningCompletedAtstring (date-time)

This field is required if pepScreeningCompleted is YES

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

livenessCheckCompleted*enum

YESNO

livenessCheckCompletedAtstring (date-time)

This field is required if livenessCheckCompleted is YES

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

isPEPenum

This field indicates if the customer is a politically exposed person

YESNO

isSanctionedenum

This field indicates if the customer is sanctioned

YESNO

employmentStatusEmploymentStatus

This field indicates the employment status of the customer

EmployedUnemployedRetiredStudentSelf-Employed

Response

Body

customerIdstring (uuid)

referenceIdstring

customerStatusenum

ONBOARDINGACTIVEINACTIVE

customerTypeenum

RETAILENTERPRISEWEALTH

onboardingStatusenum

PENDING_DOCUMENTATION_RECEIPTPROCESSINGONBOARDINGFAILEDONBOARDED

createdAtstring (date-time)

customerPreTradeRiskGroupenum

Example: "LOW"

LOWHIGHnull

documentsDocuments

Customer documents

Example:

[{"documentType":"PASSPORT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_FRONT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_BACK","documentStatus":"PENDING_RECEIPT"}]

Request

const response = await fetch('https://cams.aquanow.com/api/v1/customers', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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-02-05",
      "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"
    }),
});
const data = await response.json();

Response

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