get http://{{auth_server_host}}/banking/originator/products//custom-variables
Esse endpoint permite a consulta das variáveis/campos personalizados para os cadastros de um Produto.
Veja mais detalhes sobre as variáveis personalizadas em: https://developers.celcoin.com.br/docs/variáveis-personalizadas
Parâmetros da URL
product_id(string/uuid v4): ID do produto.
Resposta
Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:
application(object): Objeto contendo as variáveis personalizadas a serem informadas na Solicitação (application). Cada variável deve ter um nome (name) e obrigatoriedade (required). O nome deve ser compatível com o nome da variável previamente cadastrada, e prefixado com "custom_variables". Ex: Se a variável foi cadastrada como "xyz" no endpoint de variáveis, aqui ela será representada como "custom_variables.xyz", seja para escrita ou leitura.
borrower(object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro de Pessoas (persons) ou Empresas (business). Para produtos de crédito PJ, preencher a lista business, para PF, a lista person. Cada variável deve ter um nome (name) e obrigatoriedade (required). O nome deve ser compatível com o nome da variável previamente cadastrada, e prefixado com "custom_variables". Ex: Se a variável foi cadastrada como "xyz" no endpoint de variáveis, aqui ela será representada como "custom_variables.xyz", seja para escrita ou leitura.
guarantors(object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro dos Avalistas. Análoga a Configuração das Variáveis de Tomadores, para Avalistas.
co-signers(object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro dos Anuentes. Análoga a Configuração das Variáveis de Tomadores, para Anuentes.
employer(object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro dos Empregadores. Análoga a Configuração das Variáveis de Tomadores, para Empregadores. Válida apenas para pessoas jurídicas. É utilizada principalmente em operações de consignado privado.
business_document, person_document(objeto): Lista de Documentos obrigatórios ou opcionais no cadastro de pessoas físicas ou jurídicas como Tomadores.
employer_document(object): Análogo a Documentos Tomador, para Empregadores. Apenas pessoas jurídicas.
Exemplo de resposta
{
"application": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "NUMBER",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "DATE",
"display_name": "<string>",
"description": "<string>"
}
],
"borrower": {
"person": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "BOOLEAN",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "TEXT",
"display_name": "<string>",
"description": "<string>"
}
],
"business": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "DATE",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "DATE",
"display_name": "<string>",
"description": "<string>"
}
],
"person_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
],
"business_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
]
},
"guarantors": {
"person": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "NUMBER",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "TEXT",
"display_name": "<string>",
"description": "<string>"
}
],
"business": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "DATE",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "NUMBER",
"display_name": "<string>",
"description": "<string>"
}
],
"person_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
],
"business_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
]
},
"co_signers": {
"person": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "BOOLEAN",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "BOOLEAN",
"display_name": "<string>",
"description": "<string>"
}
],
"business": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "NUMBER",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "DATE",
"display_name": "<string>",
"description": "<string>"
}
],
"person_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
],
"business_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
]
},
"employer": [
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "NUMBER",
"display_name": "<string>",
"description": "<string>"
},
{
"id": "<uuid>",
"name": "<string>",
"required": "<boolean>",
"type": "NUMBER",
"display_name": "<string>",
"description": "<string>"
}
],
"employer_document": [
{
"type": "<string>",
"required": "<boolean>"
},
{
"type": "<string>",
"required": "<boolean>"
}
]
}