Customers

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
OK
application/json
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
OK
application/json
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-07-11T22:19:21.613Z",
      "customerPreTradeRiskGroup": "LOW",
      "accounts": [
        {
          "accountNumber": "9019283R",
          "accountName": "text",
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "accountStatus": "ACTIVE",
          "accountType": "CREDIT"
        }
      ]
    }
  ]
}

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
OK
application/json
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-07-11",
  "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-07-11T22:19:21.613Z",
  "customerPreTradeRiskGroup": "LOW",
  "documents": [
    {
      "documentType": "PASSPORT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_FRONT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_BACK",
      "documentStatus": "PENDING_RECEIPT"
    }
  ]
}

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
OK
application/json
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"
}

List Customer Bank Information

get
Authorizations
Path parameters
customerIdstringRequired

ID of the customer

Responses
200
OK
application/json
get
GET /api/v1/customers/{customerId}/bankinfo HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "bankAccountId": "e3f3cf67-9553-406c-97f9-fbd5629aa23b",
    "customerId": "84742be4-54fa-4a37-b7c1-9905ea9a7990",
    "bankName": "Acme Inc.",
    "currency": "AED, USD",
    "accountNumber": "74720233",
    "bankAddress": {
      "streetNumber": "1001",
      "streetName": "Catharine Centers",
      "unit": "text",
      "poBox": "101",
      "postalCode": "V1K4J7",
      "city": "Port Jeramie",
      "state": "Delaware",
      "country": "Canada"
    },
    "swiftBicCode": "text",
    "beneficiaryName": "John Doe",
    "reference": "c0d0e81f-3da3-4398-9a9c-621054638ff9",
    "routingAbaNumber": "000417952",
    "IBAN": "NL52NACH4001092908"
  }
]

Add Customer Bank Information

post
Authorizations
Path parameters
customerIdstringRequired

ID of the customer

Body
accountNumberstringRequired

The unique account number associated with the bank account

Example: 74720233
swiftBicCodestringRequired

The BIC/SWIFT code that uniquely identifies the financial institution.

Example: DEUTDEFFXXX
bankNamestringRequired

The name of the bank where the account is held

Example: Acme Inc.
currencystringRequired

The three-letter ISO currency code for the account. Only USD and AED are supported.

Example: USD
beneficiaryNamestringRequired

The full legal name of the account holder

Example: John Doe
referencestringRequired

A unique identifier for tracking or reference purposes. This can be used as a memo field.

Example: c0d0e81f-3da3-4398-9a9c-621054638ff9
routingAbaNumberstringRequired

ABA/Routing number for the bank.

Example: 000417952
IBANstringRequired

International bank account identifier number.

Example: DO60VGNB06660047237079916603
Responses
200
OK
application/json
post
POST /api/v1/customers/{customerId}/bankinfo HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 427

{
  "accountNumber": "74720233",
  "swiftBicCode": "DEUTDEFFXXX",
  "bankName": "Acme Inc.",
  "currency": "USD",
  "beneficiaryName": "John Doe",
  "reference": "c0d0e81f-3da3-4398-9a9c-621054638ff9",
  "routingAbaNumber": "000417952",
  "bankAddress": {
    "streetNumber": "1001",
    "streetName": "Catharine Centers",
    "unit": "text",
    "poBox": "101",
    "postalCode": "V1K4J7",
    "city": "Port Jeramie",
    "state": "Delaware",
    "country": "Canada"
  },
  "IBAN": "DO60VGNB06660047237079916603"
}
{
  "bankAccountId": "61dd47cc-2adb-4bdc-b9db-e3cc93167757",
  "bankName": "Acme Inc.",
  "customerId": "f62a2414-4a1e-4daf-a6ac-ed21cbc2560b",
  "status": "PENDING",
  "coolingOffEndTime": "2025-07-11T22:19:21.613Z"
}

Remove Customer Bank Information

delete
Authorizations
Path parameters
customerIdstringRequired
bankAccountIdstringRequired
Responses
200
OK
application/json
delete
DELETE /api/v1/customers/{customerId}/bankinfo/{bankAccountId} HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "bankAccountId": "f2ef3fdb-71dd-4612-b9e7-448b17ef9b74",
  "status": "REMOVED"
}
PreviousAPI referenceNextDocs

Last updated