v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar representantes legais

Retorna uma lista com os dados básicos dos representantes legais de determinado onboarding.

get/clients/{onboarding_id}/legal_representatives

Path parameters

onboarding_idstring required

Id da solicitação de cadastro.

Query parameters

p[per_page]string

Quantidade de itens para retornar por página

p[page]string

Página a ser carregada

q[documentNumberEq]string

CPF do representante legal igual a.

q[nameCont]string

Nome do representante legal contém ou é igual a.

q[createdAtGteq]string date

Data de criação do representante legal maior igual que.

q[createdAtLteq]string date

Data de criação do representante legal menor igual que.

q[updatedAtGteq]string date

Data de atualização do representante legal maior igual que.

q[updatedAtLteq]string date

Data de atualização do representante legal menor igual que.

Response

200

Example response

{
  "data": [
    {
      "id": "b7eba684-abc1-458b-8685-f4ef7a8850a0",
      "type": "legalRepresentative",
      "attributes": {
        "documentNumber": "12233445478",
        "name": "Michael Gary Scott",
        "kind": "attorney",
        "representationKind": "together",
        "subscriberKind": "required",
        "createdAt": "2024-04-05T14:31:31.855-03:00",
        "updatedAt": "2024-04-05T14:31:32.292-03:00"
      }
    }
  ],
  "meta": {
    "pagination": {
      "currentPage": 1,
      "perPage": 25,
      "totalPages": 1,
      "totalCount": 1
    }
  }
}