Customers

Get Customer

Retrieve a Customer with optional filtering and pagination.

get

/v1/customers/{customerId}

Authorizations

Path parameters

customerIdstring · uuidrequired

The ID of the customer

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cams.aquanow.com/api/v1/customers/{customerId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

5XX

4XX

200

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

OK

Get Customers

Retrieve a list of customers with optional filtering and pagination.

get

/v1/customers

Authorizations

Query parameters

customerStatusstring · enum

Filter customers by status

Options: ONBOARDING, ACTIVE, INACTIVE

createDateStartstring · date-time

Filter customers by creation date lower bound, exclusive

createDateEndstring · date-time

Filter customers by creation date upper bound, inclusive

referenceIdstring

Filter customers by reference ID

afterstring

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

limitstring · integer

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

sortFieldstring · enum

Will sort the returned data using the specified field.

Options: customerStatus, createdDate, referenceId

sortDirectionstring · enum

Specifies the sort direction for the sortField.

Options: ASC, DESC

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cams.aquanow.com/api/v1/customers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

404

200

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

OK

Add a new customer

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

post

/v1/customers

Authorizations

Body

referenceIdstringrequired

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

fullNamestringrequired

Example: 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

addressobjectrequired

placeOfBirthstringrequired

Example: Toronto, Canada

dateOfBirthstring · daterequired

employerNamestring

Example: Aquanow

employerAddressobject

sanctionsScreeningCompletedstring · enumrequired

Options: YES, NO

sanctionsScreeningCompletedAtstring · date-time

This field is required if sanctionsScreeningCompleted is YES

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

pepScreeningCompletedstring · enumrequired

Options: YES, NO

pepScreeningCompletedAtstring · date-time

This field is required if pepScreeningCompleted is YES

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

livenessCheckCompletedstring · enumrequired

Options: YES, NO

livenessCheckCompletedAtstring · date-time

This field is required if livenessCheckCompleted is YES

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

isPEPstring · enum

This field indicates if the customer is a politically exposed person

Options: YES, NO

isSanctionedstring · enum

This field indicates if the customer is sanctioned

Options: YES, NO

employmentStatusundefined · enum

This field indicates the employment status of the customer

Options: Employed, Unemployed, Retired, Student, Self-Employed

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cams.aquanow.com/api/v1/customers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-03-09",
    "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"
  }'

200

400

401

403

4XX

5XX

200

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

OK

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.

patch

/v1/customers/{customerId}

Authorizations

Path parameters

customerIdstring · uuidrequired

The customer ID of the customer

Body

customerPreTradeRiskGroupstring · enumrequired

Example: LOW

Options: LOW, HIGH, null

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cams.aquanow.com/api/v1/customers/{customerId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerPreTradeRiskGroup": "LOW"
  }'

200

400

401

403

4XX

5XX

200

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

OK