Edit

[POST] .../v1/customerpersonaldocument/edit

Edits personal document customer. Use this method to update an existing customer's personal document value or replace its attached file. The request requires customer_id and personal_doc_type_id and must include value, file or both; file replacement accepts JSON base64 payloads or multipart form-data and deletes the previous stored file after the update succeeds. The method checks the current request user and requires customer personal document edit permission; it validates the existing customer document record, the personal document type mask for supplied value, required file fields and changed data and returns malformed body, missing field, no changed data, invalid mask, permission, file storage, not-found and storage failures as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
customer_id Int64 Required Customer ID.
file CommonFileAdd Optional Attached personal document file.
personal_doc_type_id Int64 Required Personal document type ID.
value String Optional Personal document value, such as a document number or identifier.

Request Example

{
  "customer_id": 1,
  "file": {
    "access_level": "system",
    "data": "string",
    "duration_ms": 1,
    "extension": "string",
    "folder_id": 1,
    "height": 1,
    "name": "string",
    "user_id": 1,
    "width": 1
  },
  "personal_doc_type_id": 1,
  "value": "string"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "ids": [
      null
    ],
    "row_affected": 1
  }
}