Enviar Endereço do Investidor

---

Introdução

Este recurso tem como objetivo enviar o endereço que compõe a análise cadastral de um investidor.

Classe de fundo (fund_class) — etapa pulada

Classes de fundo não enviam endereço. O endereço é herdado automaticamente do administrador vinculado à classe durante o envio para análise, e o submit não exige o bloco address para esse subtipo. Pule esta etapa.

Input / Output

Como input envie os dados de endereço.

Como output é retornado o objeto data da análise, com os blocos cadastrais já gravados.

Request

ENDPOINT

/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/address

MÉTODO

PUT

STATUS

202

Exemplo

Request Body

{
    "street": "Avenida Paulista",
    "number": "1000",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "postal_code": "01310-100",
    "uf": "SP",
    "country": "BRA",
    "complement": "Sala 1010"
}

Body params

Campo	Tipo	Descrição	Caracteres	Obrigatório
street	string	Logradouro	1 - 255	Sim
number	string	Número (somente dígitos)	1 - 10	Sim
neighborhood	string	Bairro	1 - 255	Sim
city	string	Cidade	1 - 255	Sim
postal_code	string	Código postal. No Brasil, CEP no formato NNNNN-NNN. No exterior, o formato local do país	1 - 20	Sim
uf	string	Unidade Federativa — ex.: SP, CE, MG. No exterior, use EX	1 - 20	Sim
country	string	Código ISO do país, 3 letras — ex.: BRA, PRT	3	Sim
complement	string	Complemento	1 - 255	Não

Endereço no exterior

A validação de country, uf e postal_code depende da residência da análise:

resident da análise	country	uf	postal_code
true (default)	obrigatoriamente BRA (IVR000227)	sigla de UF brasileira — ex.: SP, RJ (IVR000273)	CEP no formato NNNNN-NNN, 8 dígitos com hífen (IVR000281)
false	qualquer um, exceto BRA (IVR000226)	sem validação de formato	sem validação de formato

Num endereço no exterior, postal_code e uf aceitam o padrão de qualquer país (até 20 caracteres cada): um código postal português 1000-001 ou um ZIP norte-americano 10001 são aceitos como estão.

Residência é definida na criação do investidor

resident não é um campo desta etapa e não pode ser alterado depois. Se você receber IVR000227 ao enviar um endereço no exterior, a análise nasceu residente — é preciso criar o investidor com resident: false e non_resident_type, conforme a seção Investidor não residente da página Criar Investidor.

Response

O corpo traz o objeto data da análise com os blocos já gravados. Para status e demais campos, consulte Busca informações de uma análise cadastral do investidor.

---

Erros

Status	Código	Quando acontece
400	IVR000018	A análise não está mais em pending_registry_data (já foi enviada ou encerrada)
400	IVR000227	Investidor residente com country diferente de BRA
400	IVR000226	Investidor não residente com country: BRA
400	IVR000273	Investidor residente com uf que não é uma sigla de UF brasileira
400	IVR000281	Investidor residente com CEP fora do formato NNNNN-NNN
400	QIT000011	Pela gestora (manager-api): o investidor não é uma classe de fundo vinculada a ela

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