Customers

Get Customers

get

/v1/customers

Retrieve a list of customers with optional filtering and pagination.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

afterstring · nullableOptional

The token of the last item in the response

totalCountstring · integerOptional

The total number of items in the entire filtered data set

Example: 1

401

Unauthorized

404

Not Found

get/v1/customers

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": "2026-01-01T00:00:00.000Z",
      "customerPreTradeRiskGroup": "LOW",
      "accounts": [
        {
          "accountNumber": "9019283R",
          "accountName": "text",
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "accountStatus": "ACTIVE",
          "accountType": "CREDIT"
        }
      ]
    }
  ]
}

Get Customer

get

/v1/customers/{customerId}

Retrieve a Customer with optional filtering and pagination.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstring · uuidRequired

The customer ID of the customer

Example: dac4d330-fe5b-44d0-b64a-058f7f861952

Responses

200

OK

application/json

customerIdstring · uuidOptional

referenceIdstringOptional

customerStatusstring · enumOptionalPossible values:

onboardingStatusstring · enumOptionalPossible values:

customerTypestring · enumOptionalPossible values:

createDatestring · date-timeOptional

Date-time in ISO 8601 format

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

customerPreTradeRiskGroupstring · enumOptionalExample: LOWPossible values:

electronicFacialRecognitionStatusstring · enum · nullableOptional

Electronic facial recognition status when available; null otherwise.

Possible values:

documentExpiryDatestring · date-time · nullableOptional

Document expiry date in UTC (ISO 8601); null when not available.

emiratesIdstring · nullableOptional

Emirates ID when available; null otherwise.

Example: 784-1987-1234567-1

400

Validation Error

401

Unauthorized

5XX

Server error

4XX

Client error

get/v1/customers/{customerId}

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

{
  "customerId": "f523da38-aae5-41c8-a7e0-57a3c3b347e9",
  "referenceId": "ref-123",
  "customerStatus": "ACTIVE",
  "onboardingStatus": "ONBOARDED",
  "customerType": "RETAIL",
  "createDate": "2024-08-01T18:44:05Z",
  "customerPreTradeRiskGroup": null,
  "accounts": [],
  "documents": [],
  "kycDetails": null,
  "electronicFacialRecognitionStatus": "SUCCESS",
  "documentExpiryDate": "2046-12-31T23:59:59.999Z",
  "emiratesId": "784-1987-1234567-1"
}

Add a new customer

post

/v1/customers

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

employerNamestringOptional

Required only when employmentStatus is 'Employed'.

Example: Aquanow

employerAddressone ofOptional

Required only when employmentStatus is 'Employed'.

stringOptional

A full address string

Example: 1095 W Pender St Vancouver BC 123456 Canada

or

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 · enumOptional

For UAE address: required unless electronicFacialRecognitionStatus is SUCCESS with documentExpiryDate and emiratesId. Not required for non-UAE.

Possible values:

livenessCheckCompletedAtstring · date-timeOptional

This field is required if livenessCheckCompleted is YES

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

isPEPstring · enumRequired

This field indicates if the customer is a politically exposed person

Possible values:

isSanctionedstring · enumRequired

This field indicates if the customer is sanctioned

Possible values:

employmentStatusstring · enumRequired

This field indicates the employment status of the customer.

Possible values:

electronicFacialRecognitionStatusstring · enumOptional

This field indicates the result of the Electronic Facial Recognition check

Default: NAPossible values:

documentExpiryDatestring · date-timeOptional

This field is required if electronicFacialRecognition is SUCCESS. Must be a future date.

Example: 2046-12-31T23:59:59.999Z

emiratesIdstringOptional

This field is required if electronicFacialRecognition is SUCCESS.

Example: 784-1987-1234567-1

customerSegmentstring · enumOptional

This field indicates the customer segment.

Possible values:

netWorthstringOptional

This field indicates the customer's net worth.

Example: 1000000

incomestringOptional

This field indicates the customer's income.

Example: 85000

incomeCurrencystringOptional

This field indicates the currency of the customer's income.

Example: USD

Responses

200

OK

application/json

customerIdstring · uuidOptional

referenceIdstringOptional

customerStatusstring · enumOptionalPossible values:

customerTypestring · enumOptionalPossible values:

onboardingStatusstring · enumOptionalPossible values:

createdAtstring · date-timeOptional

customerPreTradeRiskGroupstring · enumOptionalExample: LOWPossible values:

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

post/v1/customers

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

{
  "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": "2026-01-01",
  "employerName": "Aquanow",
  "employerAddress": "1095 W Pender St Vancouver BC 123456 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",
  "electronicFacialRecognitionStatus": "NA",
  "documentExpiryDate": "2046-12-31T23:59:59.999Z",
  "emiratesId": "784-1987-1234567-1",
  "customerSegment": "RETAIL",
  "netWorth": "1000000",
  "income": "85000",
  "incomeCurrency": "USD"
}

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "text",
  "customerStatus": "ONBOARDING",
  "customerType": "RETAIL",
  "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "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

/v1/customers/{customerId}

Update customer information including pre-trade risk group and PII data. 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. Additionally, modify customer PII attributes such as name, nationality, address, employment details, etc. When updating employment status to EMPLOYED, employer address becomes required. When providing address or employer address, all respective required fields must be included. All PII attributes are optional at the top level and only specified fields will be updated.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstring · uuidRequired

The customer ID of the customer

Example: dac4d330-fe5b-44d0-b64a-058f7f861952

Body

customerPreTradeRiskGroupstring · enumOptionalExample: LOWPossible values:

fullNamestringOptionalExample: John Doe

nationalitystringOptionalExample: Canada

placeOfBirthstringOptionalExample: Toronto, Canada

dateOfBirthstring · dateOptionalExample: 1990-01-15

employerNamestringOptionalExample: Aquanow

employmentStatusundefined · enumOptional

This field indicates the employment status of the customer

Possible values:

Responses

200

OK

application/json

customerIdstring · uuidRequired

customerPreTradeRiskGroupstring · enum · nullableOptionalExample: LOWPossible values:

fullNamestring · nullableOptionalExample: John Doe

nationalitystring · nullableOptionalExample: Canada

placeOfBirthstring · nullableOptionalExample: Toronto, Canada

dateOfBirthstring · date · nullableOptionalExample: 1990-01-15

employerNamestring · nullableOptionalExample: Aquanow

employmentStatusundefined · enum · nullableOptional

This field indicates the employment status of the customer

Possible values:

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

patch/v1/customers/{customerId}

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

{
  "customerPreTradeRiskGroup": "LOW",
  "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": "1990-01-15",
  "employerName": "Aquanow",
  "employerAddress": {
    "streetNumber": "1234",
    "streetName": "Main St",
    "unit": "Apt 101",
    "poBox": "PO Box 1234",
    "postalCode": "M5V 1A1",
    "city": "Toronto",
    "state": "ON",
    "country": "Canada"
  },
  "employmentStatus": "Employed"
}

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerPreTradeRiskGroup": "LOW",
  "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": "1990-01-15",
  "employerName": "Aquanow",
  "employerAddress": {
    "streetNumber": "1234",
    "streetName": "Main St",
    "unit": "Apt 101",
    "poBox": "PO Box 1234",
    "postalCode": "M5V 1A1",
    "city": "Toronto",
    "state": "ON",
    "country": "Canada"
  },
  "employmentStatus": "Employed"
}

List Customer Bank Information

get

/v1/customers/{customerId}/bankinfo

Retrieve the customer's bank account details for a specific customer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstringRequired

ID of the customer

Responses

200

OK

application/json

bankAccountIdstring · uuidRequired

statusstring · enumRequiredPossible values:

createdAtstring · date-timeOptional

statusReasonstring · nullableOptional

400

Validation Error

401

Unauthorized

403

Forbidden

404

Not Found

application/json

4XX

Client error

5XX

Server error

get/v1/customers/{customerId}/bankinfo

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

[
  {
    "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "bankAccountInformation": {
      "beneficiaryType": "INDIVIDUAL",
      "currency": "USD",
      "beneficiaryAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "postalCode": "text",
        "country": "text"
      },
      "beneficiaryBankName": "text",
      "beneficiaryBankAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "postalCode": "text",
        "country": "text"
      },
      "beneficiaryBankBic": "text",
      "routingCode": "text",
      "beneficiaryAccountNumber": "text",
      "beneficiaryBankMemo": "text",
      "intermediaryBankName": "text",
      "intermediaryBankAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "postalCode": "text",
        "country": "text"
      },
      "intermediaryBankBic": "text",
      "intermediaryAccountNumber": "text",
      "beneficiaryGivenNames": "text",
      "beneficiarySurnames": "text",
      "beneficiaryLegalName": "text"
    },
    "status": "PENDING",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "statusReason": "text"
  }
]

Get Bank Account Information

get

/v1/customers/{customerId}/bankinfo/{bankAccountId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstringRequired

bankAccountIdstringRequired

Responses

200

OK

application/json

bankAccountIdstring · uuidRequired

statusstring · enumRequiredPossible values:

createdAtstring · date-timeOptional

statusReasonstring · nullableOptional

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

404

Not Found

application/json

4XX

Client error

5XX

Server error

get/v1/customers/{customerId}/bankinfo/{bankAccountId}

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

[
  {
    "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "bankAccountInformation": {
      "beneficiaryType": "INDIVIDUAL",
      "currency": "USD",
      "beneficiaryAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "postalCode": "text",
        "country": "text"
      },
      "beneficiaryBankName": "text",
      "beneficiaryBankAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "postalCode": "text",
        "country": "text"
      },
      "beneficiaryBankBic": "text",
      "routingCode": "text",
      "beneficiaryAccountNumber": "text",
      "beneficiaryBankMemo": "text",
      "intermediaryBankName": "text",
      "intermediaryBankAddress": {
        "addressLine1": "text",
        "addressLine2": "text",
        "city": "text",
        "region": "text",
        "postalCode": "text",
        "country": "text"
      },
      "intermediaryBankBic": "text",
      "intermediaryAccountNumber": "text",
      "beneficiaryGivenNames": "text",
      "beneficiarySurnames": "text",
      "beneficiaryLegalName": "text"
    },
    "status": "PENDING",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "statusReason": "text"
  }
]

Add Customer Bank Information

post

/v1/customers/{customerId}/bankinfo

Associates a new external bank account with an existing customer. Each customer can have up to 20 external bank accounts.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstringRequired

ID of the customer

Body

beneficiaryTypestring · enumRequiredPossible values:

currencystringRequired

ISO 3-letter currency code

Example: USD

beneficiaryBankNamestring · max: 255Required

The name of the financial institution holding the beneficiary account.

beneficiaryBankBicstring · min: 8 · max: 11 · nullableOptional

The unique identifier code for the beneficiary institution, such as a BIC (Bank Identifier Code) or SWIFT code. Typically 8-11 characters.

routingCodestring · max: 20 · nullableOptional

The clearing code or routing number for the beneficiary institution. Used for domestic transfers.

beneficiaryAccountNumberstring · max: 34Required

The account number or IBAN of the beneficiary. Supports various formats (e.g., IBAN up to 34 characters).

beneficiaryBankMemostring · max: 140 · nullableOptional

Payment reference sent with the transfer. If provided, ensures the funds are processed without unnecessary delays and helps the beneficiary identify the payment purpose.

intermediaryBankNamestring · nullableOptional

The name of the intermediary financial institution facilitating the payment (e.g., for cross-border transfers). Required only if an intermediary is involved.

intermediaryBankBicstring · min: 8 · max: 11 · nullableOptional

BIC/SWIFT code of the intermediary bank. If required for the payment route, ensures proper routing and prevents delays or rejections.

intermediaryAccountNumberstring · max: 34 · nullableOptional

Account number held at the intermediary bank for correspondent banking. If required, ensures funds are properly credited and forwarded without delays.

beneficiaryGivenNamesstring · max: 200Optional

Required for INDIVIDUAL beneficiary type

beneficiarySurnamesstring · max: 200Optional

Required for INDIVIDUAL beneficiary type

beneficiaryLegalNamestring · max: 255 · nullableOptional

Required for BUSINESS beneficiary type

Responses

200

OK

application/json

bankAccountIdstring · uuidRequired

customerIdstring · uuidRequired

coolingOffEndTimestring · date-timeRequired

By default, a 24-hour cooling-off period is applied when a new account is added before it can be used for transactions.

statusstring · enumRequiredPossible values:

createdAtstring · date-timeRequired

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

post/v1/customers/{customerId}/bankinfo

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

{
  "beneficiaryType": "INDIVIDUAL",
  "currency": "USD",
  "beneficiaryAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "region": "text",
    "postalCode": "text",
    "country": "text"
  },
  "beneficiaryBankName": "text",
  "beneficiaryBankAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "region": "text",
    "postalCode": "text",
    "country": "text"
  },
  "beneficiaryBankBic": "text",
  "routingCode": "text",
  "beneficiaryAccountNumber": "text",
  "beneficiaryBankMemo": "text",
  "intermediaryBankName": "text",
  "intermediaryBankAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "region": "text",
    "postalCode": "text",
    "country": "text"
  },
  "intermediaryBankBic": "text",
  "intermediaryAccountNumber": "text",
  "beneficiaryGivenNames": "text",
  "beneficiarySurnames": "text",
  "beneficiaryLegalName": "text"
}

{
  "bankAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "coolingOffEndTime": "2026-01-01T00:00:00.000Z",
  "status": "PENDING",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "bankAccount": {
    "beneficiaryType": "INDIVIDUAL",
    "currency": "USD",
    "beneficiaryAddress": {
      "addressLine1": "text",
      "addressLine2": "text",
      "city": "text",
      "region": "text",
      "postalCode": "text",
      "country": "text"
    },
    "beneficiaryBankName": "text",
    "beneficiaryBankAddress": {
      "addressLine1": "text",
      "addressLine2": "text",
      "city": "text",
      "region": "text",
      "postalCode": "text",
      "country": "text"
    },
    "beneficiaryBankBic": "text",
    "routingCode": "text",
    "beneficiaryAccountNumber": "text",
    "beneficiaryBankMemo": "text",
    "intermediaryBankName": "text",
    "intermediaryBankAddress": {
      "addressLine1": "text",
      "addressLine2": "text",
      "city": "text",
      "region": "text",
      "postalCode": "text",
      "country": "text"
    },
    "intermediaryBankBic": "text",
    "intermediaryAccountNumber": "text",
    "beneficiaryGivenNames": "text",
    "beneficiarySurnames": "text",
    "beneficiaryLegalName": "text"
  }
}

Remove Customer Bank Information

delete

/v1/customers/{customerId}/bankinfo/{bankAccountId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstringRequired

bankAccountIdstringRequired

Responses

200

OK

application/json

bankAccountIdstringRequiredExample: f2ef3fdb-71dd-4612-b9e7-448b17ef9b74

statusstringRequiredExample: REMOVED

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

404

Not Found

application/json

4XX

Client error

5XX

Server error

delete/v1/customers/{customerId}/bankinfo/{bankAccountId}

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