Skip to main content
GET
/
api
/
customer
/
{customerId}
/
document
getAllDocumentsForCustomer
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/document \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "content": [
    {
      "assignees": [
        {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        }
      ],
      "authenticity": "<string>",
      "back": "<string>",
      "backName": "<string>",
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "customerId": 123,
      "expiryDate": "2023-12-25",
      "front": "<string>",
      "frontName": "<string>",
      "id": 123,
      "issueDate": "2023-12-25",
      "number": "<string>",
      "parentCustomerId": 123,
      "parentParticular": {},
      "particular": {},
      "showExpiryNotification": true,
      "type": "<string>",
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}
This endpoint retrieves all documents that have been uploaded and associated with a primary customer or CRP. Use this endpoint when you need to fetch the list of documents (such as IDs, passports, or other supporting files) that were previously appended via Step 4a — Append Document to Customer.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID
integer<int64>
required

X-Domain-ID

Path Parameters

customerId
integer<int64>
required

customerId

Query Parameters

offset
integer<int64>
paged
boolean
pageNumber
integer<int32>
pageSize
integer<int32>
sort.sorted
boolean
sort.unsorted
boolean
unpaged
boolean

Response

OK

content
DocumentResponseDto · object[]
empty
boolean
first
boolean
last
boolean
number
integer<int32>
numberOfElements
integer<int32>
pageable
Pageable · object
size
integer<int32>
sort
Sort · object
totalElements
integer<int64>
totalPages
integer<int32>