# Lista os documentos do cliente

Lista documentos do cliente.

Endpoint: GET /api/v3/customers/{customerId}/documents
Version: 3.0.0
Security: OAuth2

## Path parameters:

  - `customerId` (integer, required)
    ID do cliente.

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `type` (string)
    Indica o tipo do documento. 
  
- cpf: CPF Pessoa física.
- rg: RG Pessoa física.
- cnpj: CNPJ Pessoa jurídica.
- ie: Inscrição Estadual Pessoa jurídica.
- im: Inscrição Municipal Pessoa jurídica.
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `identify` (string)
    Número de identificação do documento. Somente números. Ex: 22.423.374/0001-52 => 22423374000152.
    Example: "22423374000152"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

## Response 200 fields (application/json):

  - `data` (object)

  - `data.documents` (array)
    Representa a lista de documentos

  - `data.documents.type` (string, required)
    Indica o tipo do documento.

- cpf: CPF Pessoa física
- rg: RG Pessoa física
- cnpj: CNPJ Pessoa jurídica
- ie: Inscrição Estadual Pessoa jurídica
- im: Inscrição Municipal Pessoa jurídica
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `data.documents.identify` (string, required)
    Identificação do documento.
    Example: "11144477735"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields