Get

[POST] …/v1/CustomerPersonalDocument/Get

Возвращает персональные документы покупателей.

Входные параметры

Название Тип данных Обязательность Описание
customer_id Int64 Oбязательный ID покупателя
personal_doc_type_id Int64 Oбязательный ID типа документа
include_data Boolean Необязательный Получать ли в ответе файл документа в формате base64: true - получать, false не получать

Пример запроса

{
    "customer_id": 1,
    "personal_doc_type_id": 1,
    "include_data": true,
}

Выходные параметры

Название Тип данных Описание
result Array of CustomerPersonalDocument Массив персональных документов покупателей

Пример ответа

{
    "ok": true,
    "result": [
        {
            "customer_id": 1,
            "personal_doc_type": {
                "id": 1,
                "name": "example",
                "mask": "example",
                "last_update": 1712345678,
            },
            "file": {
                "id": 1,
                "name": "example",
                "size": 123,
                "extension": "png",
                "data": "example data",
                "url": "example.com/image.png",
                "last_update": 1712345678,
            },
            "value": "example",
            "last_update": 1712345678,
        }
    ]
}