Buscar Dados de investidores paginado

---

Introdução

Este recurso permite listar investidores aplicando filtros opcionais (documento, status e nome), com paginação.

Input / Output

Não há corpo de requisição. Os filtros são passados via query string, todos opcionais.

Como output será retornada a lista de investidores que atendem aos filtros informados.

Request

ENDPOINT

/investor_registry/investors

MÉTODO

GET

STATUS

200

Query Params

Todos os parâmetros são opcionais.

Param	Tipo	Default	Descrição
document_number	string	None	Filtro por documento completo
status	string	None	Filtro por status
name	string	None	Filtro por nome
limit	int	100	Itens por página (mín. 0, máx. 500)
page	int	0	Página; o offset é calculado como page * limit

Response

Response Body

{
    "data": [
        {
            "name": "investidor 1",
            "status": "approved",
            "person_type": "natural_person",
            "investor_key": "UUID v4",
            "email": "investidor1@exemplo.com",
            "phone": "11999990001",
            "distributor": {
                "distributor_key": "UUID v4",
                "name": "Distribuidora XYZ",
                "document_number": "00000000000191",
                "registry_configuration": {}
            }
        },
        {
            "name": "investidor 2",
            "status": "pending",
            "person_type": "natural_person",
            "investor_key": "UUID v4",
            "email": "investidor2@exemplo.com",
            "phone": "11999990002",
            "distributor": {
                "distributor_key": "UUID v4",
                "name": "Distribuidora XYZ",
                "document_number": "00000000000191",
                "registry_configuration": {}
            }
        }
    ],
    "limit": 50,
    "page": 0,
    "is_last_page": true
}

Response Params

Campo	Tipo	Descrição
data	array	Lista de objetos de Investor
limit	int	Quantidade de itens por página utilizada na consulta
page	int	Página retornada
is_last_page	boolean	Indica se esta é a última página de resultados

Investor

Campo	Tipo	Descrição
investor_key	string	Chave única de identificação do investidor
name	string	Nome (ou razão social) do investidor
status	string	Status atual do investidor
person_type	string	Tipo de pessoa (natural_person ou legal_person)
email	string	E-mail de contato do investidor
phone	string	Telefone de contato do investidor
distributor	object	Objeto de Distributor

Distributor

Campo	Tipo	Descrição
distributor_key	string	Chave única do distribuidor
name	string	Nome do distribuidor
document_number	string	CNPJ do distribuidor
registry_configuration	object	Configurações de cadastro do distribuidor