Docs

Get Customer Document

get

Authorizations

Path parameters

customerIdstring · uuidRequired

The customer ID of the customer

Example: 2efbaa6d-5c4a-4b01-8651-92006d53ce5d

documentIdstring · uuidRequired

The ID for the document

Example: e99a059b-8d9e-484c-8501-e421e7072ad9

Responses

200

OK

application/json

Responseobject

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

404

Not Found

application/json

4XX

Client error

5XX

Server error

get

HTTPcURLJavaScriptPython

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

{}

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

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

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