跳到主要内容

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.

Investidor fund_class

Para fundos de investimento, o endereço é herdado automaticamente do administrador vinculado ao fundo durante o envio para análise. O envio desta etapa é opcional nesse cenário.

Input / Output

Como input envie os dados de endereço.

Como output será retornada a representação atualizada da análise cadastral.

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

CampoTipoDescriçãoCaracteresObrigatório
streetstringLogradouro1 - 255Sim
numberstringNúmero (somente dígitos)1 - 10Sim
neighborhoodstringBairro1 - 255Sim
citystringCidade1 - 255Sim
postal_codestringCódigo postal. No Brasil, CEP no formato XXXXX-XXX. No exterior, o formato local do país1 - 20Sim
ufstringUnidade Federativa — ex.: SP, CE, MG. No exterior, use EX1 - 20Sim
countrystringCódigo ISO do país, 3 letras — ex.: BRA, PRT3Sim
complementstringComplemento1 - 255Não

Endereço no exterior

postal_code e uf não possuem validação de formato — aceitam o padrão de qualquer país (até 20 caracteres cada). Um CEP português 1000-001 ou um ZIP norte-americano 10001 são aceitos como estão.

A única coerência exigida é entre a residência da análise e o country:

resident da análisecountry exigidoErro se divergir
true (default)obrigatoriamente BRAIVR000227
falsequalquer um, exceto BRAIVR000226
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

A análise cadastral atualizada é retornada no corpo da resposta. Para o formato completo, consulte Busca informações de uma análise cadastral do investidor.