Docs

Submit documentation to onboard a Customer

Submit documentation to onboard a Customer

POSThttps://cams.aquanow.com/api/v1/customers/{customerId}/docs

Authorization

Bearer

Path parameters

customerId*string (uuid)

The customer ID of the customer

Body

multipart/form-data

documentType*enum

PASSPORTNATIONAL_ID_FRONTNATIONAL_ID_BACK

documentFormat*enum

PDFJPGPNGJSONJFIF

file*string (binary)

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

Response

2002024004014034134224XX5XX

OK

Body

application/json

customerIdstring (uuid)

customerStatusenum

ONBOARDINGACTIVEINACTIVE

onboardingStatusenum

PENDING_DOCUMENTATION_RECEIPTPROCESSINGONBOARDINGFAILEDONBOARDED

documentsDocuments

Customer documents

Example: [{"documentType":"PASSPORT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_FRONT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_BACK","documentStatus":"PENDING_RECEIPT"}]

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://cams.aquanow.com/api/v1/customers/{customerId}/docs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "documentType": "PASSPORT",
      "documentFormat": "PDF",
      "file": "text"
    }),
});
const data = await response.json();

Response

200422

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

Resubmit documentation to onboard a Customer

PUThttps://cams.aquanow.com/api/v1/customers/{customerId}/docs

Authorization

Bearer

Path parameters

customerId*string (uuid)

The customer ID of the customer

Body

multipart/form-data

documentType*enum

PASSPORTNATIONAL_ID_FRONTNATIONAL_ID_BACK

documentFormat*enum

PDFJPGPNGJSONJFIF

file*string (binary)

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

Response

2004004014034134224XX5XX

OK

Body

application/json

customerIdstring (uuid)

customerStatusenum

ONBOARDINGACTIVEINACTIVE

onboardingStatusenum

PENDING_DOCUMENTATION_RECEIPTPROCESSINGONBOARDINGFAILEDONBOARDED

documentsDocuments

Customer documents

Example: [{"documentType":"PASSPORT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_FRONT","documentStatus":"PENDING_RECEIPT"},{"documentType":"NATIONAL_ID_BACK","documentStatus":"PENDING_RECEIPT"}]

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://cams.aquanow.com/api/v1/customers/{customerId}/docs', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "documentType": "PASSPORT",
      "documentFormat": "PDF",
      "file": "text"
    }),
});
const data = await response.json();

Response

200422

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