Skip to main content
PATCH
/
documents
/
{id}
Supersede a document (archive).
curl --request PATCH \
  --url https://api.novatrade24.com/v1/documents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "status": "ACTIVE"
}
'
{
  "id": "<string>",
  "type": "COC_EXTRACT",
  "status": "ACTIVE",
  "originalFilename": "<string>",
  "uploadDate": "2023-11-07T05:31:56Z",
  "fileUrl": "<string>",
  "documentDate": "2023-12-25",
  "signedWet": true
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 client_credentials grant via Keycloak service account. Clients are provisioned per IntegrationOrganization in the nt24-idp realm.

Headers

​
Idempotency-Key
string
required

Client-generated unique key (UUID recommended) for this write operation. Identical key + identical body within 24h returns the cached response. Identical key + different body returns 422.

Required string length: 1 - 255

Path Parameters

​
id
string
required

Body

application/json
​
status
enum<string>
Available options:
ACTIVE,
ARCHIVED

Response

Updated

​
id
string
required

Document identifier (also used as storage key).

​
type
enum<string>
required

Document type enumeration reused from the NT24 platform taxonomy. Only values relevant to the allowed set of each endpoint are accepted; UNCATEGORIZED and *_ADDITIONAL_INFORMATION variants are rejected at the API boundary.

Available options:
COC_EXTRACT,
COC_COMPANY_ONLINE_PRESENCE,
COC_LETTER_OF_AUTHORIZATION,
BANK_ACCOUNT_DETAILS,
BANK_ACCOUNT_LETTERHEAD,
BANK_STATEMENT,
VAT_STATEMENT,
VAT_RETURN,
CONTACT_DOCUMENT,
CONTACT_FACE_PICTURE,
CONTACT_ID_CARD,
CONTACT_PASSPORT,
CONTACT_DRIVERS_LICENSE,
CONTACT_PICTURE_OF_MEETING,
CONTACT_PROFILE_PICTURE,
CONTACT_VERIFICATION_REPORT,
TP_TRADEPARTNER_PICTURE,
TP_PROFILE_PICTURE,
ADDRESS_SCREENSHOT,
ORDER_PURCHASING_CONTRACT,
SHIPMENT_INVOICE,
SHIPMENT_PRELIMINARY_INVOICE,
SHIPMENT_DEPOSIT_AGREEMENT,
PAYMENT_BANK_TRANSFER_SCREENSHOT,
PAYMENT_CONFIRMATION,
PAYMENT_SOURCE_OF_FUNDS_DECLARATION,
TRANSPORT_CMR,
TRANSPORT_CMR_DELIVERY,
TRANSPORT_PICTURE_OF_TRANSPORT,
TRANSPORT_CONFIRMATION_OF_ARRIVAL,
TRANSPORT_PICKUP_DECLARATION,
AML_DECLARATION,
EXPORT_FILE
​
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED
​
originalFilename
string
required
​
uploadDate
string<date-time>
required
​
fileUrl
string
required

Relative URL to document-download endpoint.

​
documentDate
string<date>
​
signedWet
boolean