Aquanow CAMS v1.0 (Updated)
  • Welcome
  • Security
    • OAuth2.0
    • API Limits
  • Pagination
  • Webhooks
    • Onboarding
    • Settlements
    • Reports
    • Order
    • Execution
    • Document
  • Market Data
    • Websocket
    • Rest API
      • OHLC
  • API reference
    • Customers
      • Docs
      • Configuration
    • Trades
      • RFQ
    • Orders
    • Executions
    • Settlements
    • Transactions
    • Accounts
      • Credit
      • Balances
      • Configuration
      • Performance
    • Instruments
      • Pairs
      • Assets
    • Custody
      • Balances
      • Allocation
    • Files
    • Webhook
  • Change Log
  • Specification
  • User Guide
    • View Customers
      • Customer Onboarding
      • Upload Onboarding Docs
      • View Customer Account Balances
      • Customer Risk Groups
    • View Customer Trade Activity
    • Manage Team Members
Powered by GitBook
On this page
  1. API reference
  2. Customers

Docs

PreviousCustomersNextConfiguration

Last updated 8 months ago

  • POSTSubmit documentation to onboard a Customer
  • PUTResubmit documentation to onboard a Customer

Submit documentation to onboard a Customer

post

Submit documentation to onboard a Customer

Authorizations
Path parameters
customerIdstring · uuidRequired

The customer ID of the customer

Body
documentTypestring · enumRequiredPossible values:
documentFormatstring · enumRequiredPossible values:
filestring · binaryRequired

The document file to be uploaded, maximum size of 10MB

Responses
200
OK
application/json
202
Accepted
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
413
Payload too large
422
Unprocessable Entity
application/json
4XX
Client error
5XX
Server error
post
POST /api/v1/customers/{customerId}/docs HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66

{
  "documentType": "PASSPORT",
  "documentFormat": "PDF",
  "file": "binary"
}
{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerStatus": "ONBOARDING",
  "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
  "documents": [
    {
      "documentType": "PASSPORT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_FRONT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_BACK",
      "documentStatus": "PENDING_RECEIPT"
    }
  ]
}

Resubmit documentation to onboard a Customer

put

Resubmit documentation to onboard a Customer

Authorizations
Path parameters
customerIdstring · uuidRequired

The customer ID of the customer

Body
documentTypestring · enumRequiredPossible values:
documentFormatstring · enumRequiredPossible values:
filestring · binaryRequired

The document file to be uploaded, maximum size of 2MB

Responses
200
OK
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
413
Payload too large
422
Unprocessable Entity
application/json
4XX
Client error
5XX
Server error
put
PUT /api/v1/customers/{customerId}/docs HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66

{
  "documentType": "PASSPORT",
  "documentFormat": "PDF",
  "file": "binary"
}
{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerStatus": "ONBOARDING",
  "onboardingStatus": "PENDING_DOCUMENTATION_RECEIPT",
  "documents": [
    {
      "documentType": "PASSPORT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_FRONT",
      "documentStatus": "PENDING_RECEIPT"
    },
    {
      "documentType": "NATIONAL_ID_BACK",
      "documentStatus": "PENDING_RECEIPT"
    }
  ]
}