No Credere, o cliente representa a parte interessada na aquisição de um veículo por meio de uma proposta de financiamento. Ele é composto por várias informações pessoais, tais como: informações de identificação, informações de contatos, informações profissionais, informações bancárias, endereços, dentre outros.
O cadastro do cliente é uma etapa fundamental no processo de criação e envio de propostas aos bancos.
Se o cliente existir, ele pode ser atualizado conforme descrito nesse manual.
Dados obrigatórios do clienteDevido ao fato de cada banco possuir seus próprios critérios de análise, a obrigatoriedade dos dados do cliente varia de banco para banco.
Sendo assim, recomenda-se a leitura do documento campos obrigatórios por banco no cadastro do cliente, para identificar as informações exigidas por cada banco no processo de análise de propostas.
Obrigatoriedade do campo ID nos objetos informados no JSON enviadoTodos os objetos descritos no JSON que será enviado no corpo dessa requisição, devem possui o seu respectivo campo ID.
Exemplo:
{ "customer": { "phones": [ { "id": 1, // Não esquecer de informar o campo "ID". "code": 84, "number": 999999999, "phone_type_id": 1, "phone_confirmation_id": null }, { "id": 2, // Não esquecer de informar o campo "ID". "code": 84, "number": 999999999, "phone_type_id": 2, "phone_confirmation_id": null } ], "emails": [ { "id": 1, // Não esquecer de informar o campo "ID". "address": "[email protected]" } ], // (...) demais informações do cliente (customer) } }Essa informação é necessária para que a API consiga identificar o objeto a ser atualizado. De outro modo, será criado um novo objeto ao invés de atualizar o objeto existente.
O campo ID sempre é informando nos objetos contidos na resposta das requisições.
Domínio dos campos utilizados no JSONOs campos:
- address_type_id (domínio: address_type)
- another_income_type_id (domínio: another_income_type)
- cnh_type_id (domínio: cnh_type)
- company_activity_id (domínio: company_activity)
- document_type (domínio: document_type)
- education_id (domínio: education)
- genre_id (domínio: genre)
- marital_status_id (domínio: marital_status)
- phone_type_id (domínio: phone_type)
- profession_id (domínio: profession)
- professional_ocupation_id (domínio: professional_ocupation)
- property (domínio: property)
- relationship (domínio: relationship)
- rg_state_id (domínio: states)
- state_id (domínio: states)
- state_of_birth_id (domínio: states)
Devem ser preenchidos com um ID existente no respectivo domínio. Todos os domínios do cliente (customer) podem ser obtidos na listagem de domínios do cliente.
Identificador (ID) de banco utilizados no JSONOs campos:
- previous_funding_bank_id
- bank_id
Devem ser preenchidos com o ID de um banco cadastrado. Todos os bancos cadastrados podem ser obtidos na listagem de bancos.
Validação das informações obrigatórias para determinados bancos
Devido ao fato de cada banco exigir um conjunto específico de informações do cliente, é possível validar o preenchimento de todas as informações obrigatórias para um conjunto de bancos específicos. Quando a isso, segue os recursos disponíveis:
1. Validando para banco(s) específico(s)
Para validar as informações do cliente para um conjunto de bancos específicos, adicione o campo bank_validations.bank_codes com o(s) código(s) do(s) banco(s) desejado(s) no JSON enviado no corpo da requisição.
Exemplo:
{
"bank_validations": {
"bank_codes": [
"341",
"655",
"M22"
]
}
"customer": {
// (...) Informações do cliente (customer)
}
}Para verificar os códigos aceitos no campo bank_validations.bank_codes, consulte o guia campos obrigatórios por banco no cadastro do cliente. O código de cada banco pode ser obtido no endpoint de listagem de bancos.
2. Validando para todos os bancos integrados a determina loja
Para validar as informações do cliente para todos os bancos integrados a determinada loja, adicione o campo bank_validations.store_id com o identificador (ID) da loja no JSON enviado no corpo da requisição.
Exemplo:
{
"bank_validations": {
"store_id": 1
}
"customer": {
// (...) Informações do cliente (customer)
}
}3. Validando para todos os bancos integrados ao Credere
Para validar as informações do cliente para todos os bancos integrados ao Credere, não adicione o campo bank_validations no JSON enviado no corpo da requisição.
Exemplo:
{
"customer": {
// (...) Informações do cliente (customer)
}
}
Prioridade na escolha dos critérios bancários para validação das informações do clienteDevido a existência de várias maneiras de especificar os bancos que serão considerados na validação dos dados do cliente, a definição dos bancos segue a seguinte prioridade:
- Validar para banco(s) específico(s);
- Validar para todos os bancos integrados a determina loja;
- Validar para todos os bancos integrados ao Credere;
Sendo assim, a escolha dos bancos utilizados como critério de validação segue o primeiro método que tenha seus requisitos cumpridos.
Erros de validaçãoDurante a utilização desse endpoint, o Credere valida os dados enviados.
Se existir(em) inconsistência(s) nas informações enviadas, a API responde com um erro de validação, destacando o(s) problema(s) identificado(s).
Caso tenha recebido um erro e encontre dificuldade de compreendê-lo, recomenda-se a leitura do guia de erros. O guia pode ajudá-lo a compreender a(s) inconsistência(s) identificada(s) na validação de dados.
Exemplo de corpo da requisição
{
"bank_validations": {
"bank_codes": [
"033",
"341",
"342",
"394",
"422",
"623",
"655",
"fontecred",
"M22",
"moneyplus"
],
"store_id": 1
},
"customer": {
"cpf": "000.000.000-00",
"name": "Nome do cliente",
"nickname": "Apelido do cliente",
"born_at": "01/01/2000",
"have_bank_account": true,
"accountant": {
"id": 2,
"name": "Nome do contador",
"city": "Cidade do contador",
"phone": {
"id": 6,
"code": 84,
"number": 999999999,
"phone_type_id": 1,
"phone_confirmation_id": null
}
},
"address": {
"id": 1,
"address_type_id": 1,
"city": "Natal",
"number": "3700, Sala 409 Bloco A",
"street": "Avenida Amintas Barros",
"zip_code": "59075-810",
"complement": "Edifício Corporate Tower Center-Trade",
"state_id": 20,
"neighborhood": "Lagoa Nova",
"set_time_year": 1,
"set_time_month": 0,
"build_type_id": 3,
"rent_value_cents": 100000
},
"has_made_funding": true,
"previous_funding_bank_id": 1,
"accept_boleto": true,
"note": "Observação",
"emails": [
{
"id": 1,
"address": "[email protected]"
}
],
"phones": [
{
"id": 1,
"code": 84,
"number": 999999999,
"phone_type_id": 1,
"phone_confirmation_id": null
},
{
"id": 2,
"code": 84,
"number": 999999999,
"phone_type_id": 2,
"phone_confirmation_id": null
}
],
"bank_references": [
{
"id": 1,
"bank_id": 1,
"overdraft": true,
"agency": "0000-0",
"open_at": "01/01/2000",
"account_number": "00000",
"digit": "0"
}
],
"addresses": [
{
"id": 2,
"address_type_id": 2,
"city": "Natal",
"number": "3700, Sala 409 Bloco A",
"street": "Avenida Amintas Barros",
"zip_code": "59075-810",
"complement": "Edifício Corporate Tower Center-Trade",
"state_id": 20,
"neighborhood": "Lagoa Nova",
"set_time_year": 1,
"set_time_month": 0,
"build_type_id": 3,
"rent_value_cents": 100000
},
{
"id": 3,
"address_type_id": 3,
"city": "Natal",
"number": "3700, Sala 409 Bloco A",
"street": "Avenida Amintas Barros",
"zip_code": "59075-810",
"complement": "Edifício Corporate Tower Center-Trade",
"state_id": 20,
"neighborhood": "Lagoa Nova"
}
],
"attachments": [],
"mother": "Nome da mãe",
"father": "Nome do pai",
"document_type": "RG",
"rg": "000000000",
"rg_date": "01/01/2000",
"rg_state_id": 20,
"rg_issuing": "SSP",
"has_cnh": true,
"cnh": "00000000000",
"cnh_type_id": 1,
"marital_status_id": 1,
"spouse_name": "Nome do cônjuge",
"spouse_born_at": "01/01/2000",
"spouse_cpf": "000.000.000-00",
"nationality": "Brasileira",
"place_of_birth": "Natal",
"state_of_birth_id": 20,
"genre_id": 1,
"education_id": 5,
"property": 4,
"public_person": true,
"job_reference": {
"id": 1,
"address": {
"id": 4,
"address_type_id": 4,
"city": "Natal",
"number": "3700, Sala 409 Bloco A",
"street": "Avenida Amintas Barros",
"zip_code": "59075-810",
"complement": "Edifício Corporate Tower Center-Trade",
"state_id": 20,
"neighborhood": "Lagoa Nova"
},
"joined_at": "01/01/2010",
"income_cents": 1000000,
"another_income_cents": 100000,
"another_income_type_id": 2,
"detail": "",
"first_job": false,
"professional_ocupation_id": 6,
"profession_id": 2,
"department": "Nome do departamento",
"name": "Nome da empresa",
"cnpj": "00.000.000/0000-00",
"company_activity_id": 2,
"phone": {
"id": 3,
"code": 84,
"number": 999999999,
"phone_type_id": 3,
"phone_confirmation_id": null
},
"previous_work": "Nome da empresa",
"previous_work_start_at": "01/01/2000",
"previous_work_end_at": "01/01/2000",
"previous_job_phone": {
"id": 4,
"code": 84,
"number": 999999999,
"phone_type_id": 5,
"phone_confirmation_id": null
}
},
"have_credit_card": true,
"credit_cards": "Mastercard",
"personal_references": [
{
"id": 1,
"name": "Nome do contato de referência",
"city": "Natal",
"phone": {
"id": 5,
"code": 84,
"number": 999999999,
"phone_type_id": 2,
"phone_confirmation_id": null
},
"relationship": "Pai"
}
]
}
}