Get a business document

PUT /api/v1/BusinessesDocuments/update

Description

This endpoint allows the updating of an existing business document.

Request

Path

/api/v{version}/BusinessesDocuments/update

Headers

• Accept-Language: Change default response message language from English(en). Available languages fr,en

Path Parameters

• version: API version.

Request Body

jsonCopy code{
  "schema": {
    "$ref": "#/components/schemas/UpdateBusinessDocumentRequest"
  }
}

Response

Success (200)

jsonCopy code{
  "schema": {
    "$ref": "#/components/schemas/BusinessDocumentResponse"
  }
}

/api/v`{{version}}`/BusinessesDocuments/update

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "documentId": `<uuid>`,
  "businessId": `<uuid>`,
  "type": 13,
  "base64":`<string>`,
  "fileName": `<string>`
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "businessId": `<uuid>`,
    "type": 2,
    "path": `<string>`,
    "fileName": `<string>`,
    "documentNumber": `<string>`,
    "approved": `<boolean>`
  }
}