Listar investidores

---

Introdução

Este recurso lista os investidores vinculados à sua integração, com filtros opcionais e 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.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Leitura
Consultoria	consultant-api	Liberada pelo time de integração

URL base de cada host: Ambientes (Hosts).

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	—	Documento completo (busca exata)
status	string	—	Status do investidor (ver Investor Status)
status_in	string	—	Lista de status separados por vírgula
status_not_in	string	—	Lista de status a excluir, separados por vírgula
last_analysis_status_in	string	—	Status da análise cadastral mais recente, separados por vírgula
name	string	—	Parte do nome (sem diferenciar maiúsculas)
expires_before	date	—	Cadastros que vencem antes desta data (YYYY-MM-DD)
expires_after	date	—	Cadastros que vencem depois desta data (YYYY-MM-DD)
order_by	string	—	created_at ou updated_at. Sem este parâmetro, os mais recentes primeiro
order_direction	string	desc	asc ou desc
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": "registered",
            "person_type": "natural_person",
            "investor_key": "UUID v4",
            "document_number": "969.698.790-03",
            "email": "investidor1@exemplo.com",
            "phone": {
                "international_dial_code": "55",
                "area_code": "11",
                "number": "999990001"
            },
            "current_analysis": {
                "investor_analysis_key": "UUID v4",
                "status": "analysis_complete"
            },
            "distributor": {
                "distributor_key": "UUID v4",
                "name": "Distribuidora XYZ",
                "document_number": "33444555000181",
                "registry_configuration": {}
            }
        },
        {
            "name": "investidor 2",
            "status": "pending_analysis",
            "person_type": "natural_person",
            "investor_key": "UUID v4",
            "email": "investidor2@exemplo.com",
            "phone": {
                "international_dial_code": "55",
                "area_code": "11",
                "number": "999990002"
            },
            "distributor": {
                "distributor_key": "UUID v4",
                "name": "Distribuidora XYZ",
                "document_number": "33444555000181",
                "registry_configuration": {}
            }
        }
    ],
    "limit": 100,
    "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	object	Telefone de contato do investidor, no formato de Phone
document_number	string	CPF ou CNPJ do investidor
current_analysis	object	Resumo da análise cadastral atual: investor_analysis_key, status e, quando houver, investor_category, suitability e investor_sub_type
registry_expiration_date	string	Data de vencimento do cadastro, quando houver
distributor	object	Objeto de Distributor

Consultoria

Para a consultoria, cada item de data traz o objeto completo do investidor, no mesmo formato de Busca informações do investidor. Os campos acima descrevem a resposta para a gestora.

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

Investor Status

Enumerador	Descrição
created	Criado
pending_analysis	Com análise cadastral em andamento
pending_documents	Aguardando documentos
pending_signer_group	Aguardando grupo de assinantes
incomplete	Cadastro incompleto
registered	Cadastro aprovado e concluído
registry_expired	Cadastro vencido
non_operational	Não operacional
pre_operational	Pré-operacional
inactive	Inativo

Erros

Status	Código	Quando acontece
400	—	limit acima de 500 ou page negativo

Erros de autenticação, permissão e host: veja Erros da API.