Docs | Aquanow CAMS v1.0 (Updated)

Aquanow CAMS v1.0 (Updated)

Submit documentation to onboard a Customer

post

/v1/customers/{customerId}/docs

Authorizations

Path parameters

customerIdstring · uuidrequired

The customer ID of the customer

Body

documentTypestring · enumrequired

Options: PASSPORT, NATIONAL_ID_FRONT, NATIONAL_ID_BACK

documentFormatstring · enumrequired

Options: PDF, JPG, PNG, JSON, JFIF

filestring · binaryrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://cams.aquanow.com/api/v1/customers/{customerId}/docs' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: multipart/form-data' \
  --form 'documentType=PASSPORT' \
  --form 'documentFormat=PDF' \
  --form 'file=text'

200

202

400

401

403

413

422

4XX

5XX

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