Skip to main content
PUT
/
api
/
customer
/
{customerId}
/
document
/
{documentId}
updateDocument
curl --request PUT \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --form front='@example-file' \
  --form 'document={
  "type": "NATIONAL_ID",
  "number": "S1234567A",
  "authenticity": "ORIGINAL",
  "issueDate": "2020-01-01T00:00:00.000Z",
  "expiryDate": "2030-01-01T00:00:00.000Z",
  "showExpiryNotification": true
}' \
  --form back='@example-file'
{
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

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

documentId
integer<int64>
required

documentId

Body

multipart/form-data
front
file
required

Front image file (required)

document
object
required

JSON metadata for the document

back
file

Back image file (optional)

Response

OK

assignees
UserInfo · object[]
authenticity
string
back
string
backName
string
createdAt
Timestamp · object
createdBy
UserInfo · object
customerId
integer<int64>
expiryDate
string<date>
front
string
frontName
string
id
integer<int64>
issueDate
string<date>
number
string
parentCustomerId
integer<int64>
parentParticular
JsonNode · object
particular
JsonNode · object
showExpiryNotification
boolean
type
string
updatedAt
Timestamp · object
updatedBy
UserInfo · object