Parâmetros aceitos na requisição

types

Define os domínios que se deseja obter com a requisição. O parâmetro types deve possuir os valores separados por vírgula.

Exemplos:

/api/v1/domains?types=genre,marital_status,fuel

📘
Obtendo todos os domínios
Para obter todos os domínios, basta remover o parâmetro types. Esse parâmetro deve ser utilizado quando se deseja obter domínios específicos.

Tabela de tipos aceitos no parâmetro types

Domínio (Domain)	Tag do domínio (Domain tag)	Aceita filtro por nome?	Tag do filtro
Tipo de endereço	address_type	Não
Tipo de renda extra	another_income_type	Não
Tipo de anexo	attachment_type	Não
Condição de moradia	build_type	Não
Categoria da CNH	cnh_type	Não
Segmento empresarial	company_activity	Não
Tipo de documento	document_type	Não
Nível educacional	education	Não
Combustível	fuel	Não
Tipo de financiamento	funding_type	Não
Gênero	genre	Não
Fonte da entrada	input_origin	Não
Estado civil	marital_status	Não
Nacionalidade	nationality	Não
Função do sócio	partner_role	Não
Tipo de pagamento	payment_type	Não
Tipo de anexo pessoal	person_attachment_type	Não
Tipo de telefone	phone_type	Não
Profissão	profession	Não
Ocupação profissional	professional_ocupation	Não
Patrimônio	property	Não
Relacionamento	relationship	Não
Função	role	Não
Estados (UF)	states	Não
Marca do veículo	vehicle_brand	Sim	vehicle_brand_name
Cor do veículo	vehicle_color	Não
Tipo do veículo	vehicle_type	Não

vehicle_brand_name

Filtra as marcas de veículos pelo nome.

Exemplo:

/api/v1/domains?vehicle_brand_name=chev