updateDocument

PUT /api/customer/{customerId}/document/{documentId}

updateDocument

cURL

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'

import requests

url = "https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}"

files = {
    "front": ("example-file", open("example-file", "rb")),
    "back": ("example-file", open("example-file", "rb"))
}
payload = { "document": "{
  \"type\": \"NATIONAL_ID\",
  \"number\": \"S1234567A\",
  \"authenticity\": \"ORIGINAL\",
  \"issueDate\": \"2020-01-01T00:00:00.000Z\",
  \"expiryDate\": \"2030-01-01T00:00:00.000Z\",
  \"showExpiryNotification\": true
}" }
headers = {
    "X-Domain-ID": "<x-domain-id>",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('front', '<string>');
form.append('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.append('back', '<string>');

const options = {
  method: 'PUT',
  headers: {'X-Domain-ID': '<x-domain-id>', Authorization: 'Bearer <token>'}
};

options.body = form;

fetch('https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"front\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"\r\n\r\n{\r\n  \"type\": \"NATIONAL_ID\",\r\n  \"number\": \"S1234567A\",\r\n  \"authenticity\": \"ORIGINAL\",\r\n  \"issueDate\": \"2020-01-01T00:00:00.000Z\",\r\n  \"expiryDate\": \"2030-01-01T00:00:00.000Z\",\r\n  \"showExpiryNotification\": true\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "X-Domain-ID: <x-domain-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"front\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"\r\n\r\n{\r\n  \"type\": \"NATIONAL_ID\",\r\n  \"number\": \"S1234567A\",\r\n  \"authenticity\": \"ORIGINAL\",\r\n  \"issueDate\": \"2020-01-01T00:00:00.000Z\",\r\n  \"expiryDate\": \"2030-01-01T00:00:00.000Z\",\r\n  \"showExpiryNotification\": true\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Domain-ID", "<x-domain-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}")
  .header("X-Domain-ID", "<x-domain-id>")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"front\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"\r\n\r\n{\r\n  \"type\": \"NATIONAL_ID\",\r\n  \"number\": \"S1234567A\",\r\n  \"authenticity\": \"ORIGINAL\",\r\n  \"issueDate\": \"2020-01-01T00:00:00.000Z\",\r\n  \"expiryDate\": \"2030-01-01T00:00:00.000Z\",\r\n  \"showExpiryNotification\": true\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/customer/{customerId}/document/{documentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"front\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"\r\n\r\n{\r\n  \"type\": \"NATIONAL_ID\",\r\n  \"number\": \"S1234567A\",\r\n  \"authenticity\": \"ORIGINAL\",\r\n  \"issueDate\": \"2020-01-01T00:00:00.000Z\",\r\n  \"expiryDate\": \"2030-01-01T00:00:00.000Z\",\r\n  \"showExpiryNotification\": true\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"back\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

200

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

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

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

Show child attributes

back · file

Back image file (optional)

Response

200

*/*

OK

assignees · UserInfo · object[]

Show child attributes

authenticity · string

back · string

backName · string

createdAt · Timestamp · object

Show child attributes

createdBy · UserInfo · object

Show child attributes

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

Show child attributes

updatedBy · UserInfo · object

Show child attributes