Docs

Submit documentation to onboard a Customer

Submit documentation to onboard a Customer

POSThttp://localhost:3001/api/v1/customers/{customerId}/docs

Path parameters

customerId*string (uuid)

The customer ID of the customer

Body

multipart/form-data

documentType*DocumentType (enum)

PASSPORTNATIONAL_ID_FRONTNATIONAL_ID_BACK

file*string (binary)

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

Response

2002024004014034134224XX5XX

OK

Body

application/json

customerIdstring (uuid)

submissionDateDatetime

Date-time in ISO 8601 format

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

documentTypeDocumentType (enum)

PASSPORTNATIONAL_ID_FRONTNATIONAL_ID_BACK

documentStatusDocumentStatus (enum)

Example: "PENDING_RECEIPT"

PENDING_RECEIPTPROCESSINGVERIFIEDEXPIREDUNREADABLEINVALID

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/customers/{customerId}/docs', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "documentType": "PASSPORT",
      "file": "binary"
    }),
});
const data = await response.json();

Response

200

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "submissionDate": "2024-08-01T18:44:05Z",
  "documentType": "PASSPORT",
  "documentStatus": "PENDING_RECEIPT"
}

Resubmit documentation to onboard a Customer

Resubmit documentation to onboard a Customer

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

Path parameters

customerId*string (uuid)

The customer ID of the customer

Body

multipart/form-data

documentType*DocumentType (enum)

PASSPORTNATIONAL_ID_FRONTNATIONAL_ID_BACK

file*string (binary)

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

Response

2004004014034134224XX5XX

OK

Body

application/json

customerIdstring (uuid)

submissionDateDatetime

Date-time in ISO 8601 format

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

documentTypeDocumentType (enum)

PASSPORTNATIONAL_ID_FRONTNATIONAL_ID_BACK

documentStatusDocumentStatus (enum)

Example: "PENDING_RECEIPT"

PENDING_RECEIPTPROCESSINGVERIFIEDEXPIREDUNREADABLEINVALID

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/customers/{customerId}/docs', {
    method: 'PATCH',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "documentType": "PASSPORT",
      "file": "binary"
    }),
});
const data = await response.json();

Response

200

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "submissionDate": "2024-08-01T18:44:05Z",
  "documentType": "PASSPORT",
  "documentStatus": "PENDING_RECEIPT"
}