Get

[POST] .../v1/customerpersonaldocument/get

Returns customer personal documents. Retrieve personal document records attached to a retail customer, such as passport or other identifier data used by customer profile workflows. The request requires customer_id, can filter by personal_doc_type_id and returns result with document type, document value, last_update and attached file metadata with CDN URL when a file exists; include_data is kept for support and current responses do not include binary file content. The method checks the current request user and requires customer personal document select permission; missing body, missing customer_id, denied permission, billing metadata lookup failures and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name	Type	Required	Description
filters	Array of Filter	Required	Filters by fields available for this API method. Required filter fields: customer_id.
include_data	Boolean	Optional	Reserved flag; current response contains file metadata and URL, but not binary file data.

Filterable Fields

Field	Type	Required	Description
customer_id	int	Required	Customer ID.
personal_doc_type_id	int	Optional	Document type ID.

Request Example

{
  "filters": [
    {
      "Field": "customer_id",
      "Operator": "Equal",
      "Value": "string"
    }
  ],
  "include_data": true
}

Response Parameters

Name	Type	Description
ok	Boolean	Indicates whether the request completed successfully.
result	Array of CustomerPersonalDocument	Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "customer_id": 1,
      "file": {
        "access_level": "system",
        "aspect_ratio": 1.0,
        "date": 1,
        "duration_ms": 1,
        "extension": "string",
        "folder": {
          "access_level": "system",
          "date": 1,
          "deleted": true,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1,
          "path": "string",
          "user_id": 1
        },
        "hash": "string",
        "height": 1,
        "id": 1,
        "last_update": 1,
        "media_type": "unknown",
        "mime_type": "string",
        "name": "string",
        "size": 1,
        "url": "string",
        "user_id": 1,
        "width": 1
      },
      "last_update": 1,
      "personal_doc_type": {
        "id": 1,
        "last_update": 1,
        "mask": "string",
        "name": "string"
      },
      "value": "string"
    }
  ]
}