Customers

Get Customer

Retrieve a Customer with optional filtering and pagination.

GEThttp://localhost:3001/api/v1/customers/{customerId}

Path parameters

customerId*string (uuid)

The ID of the customer

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

Response

2004004015XX4XX

OK

Body

application/json

customerIdstring (uuid)

referenceIdstring

customerStatusCustomerStatus (enum)

ONBOARDINGACTIVEINACTIVE

customerTypeenum

RETAILENTERPRISEWEALTH

onboardingStatusOnboardingStatus (enum)

PENDING_DOCUMENTATION_RECEIPTPROCESSINGONBOARDINGFAILED

createDateDatetime

Date-time in ISO 8601 format

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

customerPreTradeRiskGroupCustomerPreTradeRiskGroup (enum)

Example: "Low"

LowHighnull

accountsAccounts

Account information about a customer

documentsDocuments

Customer documents

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/customers/{customerId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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.

PATCHhttp://localhost:3001/api/v1/customers/{customerId}

Path parameters

customerId*string (uuid)

The ID of the customer

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

customerId*string (uuid)

The customer ID of the customer

Body

application/json

customerPreTradeRiskGroup*CustomerPreTradeRiskGroup (enum)

Example: "Low"

LowHighnull

Response

2004004014034XX5XX

OK

Body

application/json

customerIdstring (uuid)

customerPreTradeRiskGroupCustomerPreTradeRiskGroup (enum)

Example: "Low"

LowHighnull

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/customers/{customerId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerPreTradeRiskGroup": "Low"
    }),
});
const data = await response.json();

Response

200

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

Get Customers

Retrieve a list of customers with optional filtering and pagination.

GEThttp://localhost:3001/api/v1/customers

Query parameters

Response

200401404

OK

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/customers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "referenceId": "text",
      "customerStatus": "ONBOARDING",
      "customerType": "RETAIL",
      "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
      "createDate": "2024-09-12T01:48:36.708Z",
      "customerPreTradeRiskGroup": "Low",
      "accounts": [
        {
          "accountNumber": "9019283R",
          "accountName": "text",
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "accountStatus": "CREATING",
          "accountType": "CREDIT"
        }
      ],
      "documents": [
        {
          "documentType": "PASSPORT",
          "documentStatus": "PENDING_RECEIPT"
        }
      ]
    }
  ]
}

Add a new customer

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

POSThttp://localhost:3001/api/v1/customers

Body

application/json

referenceId*string

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

fullName*string

Example: "John Doe"

nationality*string

Example: "Canadian"

address*Address (object)

placeOfBirth*string

Example: "Toronto, Canada"

dateOfBirth*string (date)

employerNamestring

Example: "Aquanow"

employerAddressstring

Example: "1234 Main St, Toronto, ON, Canada"

sanctionsScreeningCompleted*enum

YESNO

sanctionsScreeningCompletedAtstring (date-time)

pepScreeningCompleted*enum

YESNO

pepScreeningCompletedAtstring (date-time)

livenessCheckCompleted*enum

YESNO

livenessCheckCompletedAtstring (date-time)

Response

2004004014034XX5XX

OK

Body

application/json

customerIdstring (uuid)

referenceIdstring

customerStatusCustomerStatus (enum)

ONBOARDINGACTIVEINACTIVE

customerTypeenum

RETAILENTERPRISEWEALTH

onboardingStatusOnboardingStatus (enum)

PENDING_DOCUMENTATION_RECEIPTPROCESSINGONBOARDINGFAILED

createdAtstring (date-time)

customerPreTradeRiskGroupCustomerPreTradeRiskGroup (enum)

Example: "Low"

LowHighnull

documentsDocuments

Customer documents

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/customers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fullName": "John Doe",
      "referenceId": "text",
      "nationality": "Canadian",
      "address": {
        "streetNumber": "1234",
        "streetName": "Main St",
        "city": "Toronto",
        "state": "ON",
        "country": "Canada",
        "addressType": "RESIDENTIAL"
      },
      "placeOfBirth": "Toronto, Canada",
      "dateOfBirth": "2024-09-12",
      "livenessCheckCompleted": "YES",
      "pepScreeningCompleted": "YES",
      "sanctionsScreeningCompleted": "YES"
    }),
});
const data = await response.json();

Response

200

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceId": "text",
  "customerStatus": "ONBOARDING",
  "customerType": "RETAIL",
  "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
  "createdAt": "2024-09-12T01:48:36.708Z",
  "customerPreTradeRiskGroup": "Low",
  "documents": [
    {
      "documentType": "PASSPORT",
      "documentStatus": "PENDING_RECEIPT"
    }
  ]
}