Este endpoint permite criar o cadastro de uma Pessoa Física associada a um Originador, registrando informações pessoais, profissionais, de contato, endereço, dados bancários e chaves PIX.
Uma Pessoa Física pode assumir os seguintes papéis no ecossistema:
-
Tomador
-
Anuente
-
Avalista
Além disso, Pessoas podem ser vinculadas a empresas como Representantes Legais, exercendo os seguintes papéis:
-
Representante Legal da Empresa Tomadora
-
Representante Legal do Credor / Financiador
-
Representante Legal do Originador
Após a criação, o endpoint retorna o objeto completo da Pessoa, contendo:
-
Dados pessoais e de identificação
-
Informações profissionais
-
Endereço
-
Telefone
-
Dados bancários externos (quando informados)
-
Chave PIX (quando informada)
-
Dados de cônjuge (quando aplicável)
-
Informações do Originador vinculado
-
Metadados de controle e auditoria
Método HTTP
POST
URL
https://sandbox.platform.flowfinance.com.br/banking/originator/persons
Request Body
Campos de Identificação
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
external_id | string | Não | Identificador externo do cliente no sistema integrador |
taxpayer_id | string | Sim | CPF (somente números) |
nationality | string | Sim | Nacionalidade |
pep | boolean | Sim | Indica se é Pessoa Politicamente Exposta |
full_name | string | Sim | Nome completo |
birth_date | string (YYYY-MM-DD) | Sim | Data de nascimento |
birthplace | string | Não | Cidade de nascimento |
sex | string | Não | Sexo biológico |
marital_status | string | Não | Estado civil |
marital_property_system | string | Não | Regime de bens (obrigatório se casado) |
mothers_name | string | Sim | Nome completo da mãe |
occupation | string | Sim | Profissão |
monthly_income | number | Não | Renda mensal |
income_range | string | Não | Faixa de renda |
education_level | string | Não | Grau de escolaridade |
has_scr_evidence | boolean | Não | Indica se há evidência no SCR |
Contato
Telefone (phone)
phone)| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
country_code | string | Sim | Código do país |
area_code | string | Sim | DDD |
number | string | Sim | Número do telefone |
E-mail
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
email_address | string | Sim | Endereço de e-mail |
Documento de Identificação (id_document)
id_document)| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
number | string | Não | Número do documento |
issuer | string | Não | Órgão emissor |
issue_date | string (YYYY-MM-DD) | Não | Data de emissão |
type | string | Não | Tipo do documento |
Endereço (address)
address)| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
street_name | string | Sim | Logradouro |
street_number | number | Sim | Número |
postal_code | string | Sim | CEP |
district | string | Sim | Bairro |
city | string | Sim | Cidade |
state_code | string | Sim | UF |
country_code | string | Sim | Código do país |
extra_info | string | Não | Complemento |
PIX (pix)
pix)| Campo | Tipo | Obrigatório (se não houver Conta) | Descrição |
|---|---|---|---|
key | string | Sim | Chave PIX |
key_type | string | Sim | Tipo da chave PIX |
Conta Bancária Externa (external_bank_account)
external_bank_account)| Campo | Tipo | Obrigatório (se não houver PIX) | Descrição |
|---|---|---|---|
bank_code | string | Sim | Código do banco (COMPE) |
bank_branch | string | Sim | Agência |
bank_account | string | Sim | Número da conta |
bank_account_digit | string | Sim | Dígito da conta |
bank_account_type | string | Sim | Tipo da conta |
ispb_code | string | Sim | Código ISPB da instituição |
Cônjuge
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
spouse_full_name | string | Não | Nome completo do cônjuge |
spouse_taxpayer_id | string | Não | CPF do cônjuge |
spouse_date_of_birth | string (YYYY-MM-DD) | Não | Data de nascimento do cônjuge |
Empregador (employer)
employer)| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string (UUID) | Não | Identificador do empregador |
Variáveis Customizadas
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
custom_variables | object | Não | Par chave-valor para dados adicionais |
Exemplo de Request
{
"external_id": null,
"taxpayer_id": "47343076019",
"nationality": "Brasileiro",
"pep": false,
"full_name": "Carlos Pereira",
"phone": {
"country_code": "55",
"area_code": "11",
"number": "987654321"
},
"occupation": "Analista de Sistemas",
"birth_date": "1990-08-15",
"marital_status": "MARRIED",
"email_address": "[email protected]",
"mothers_name": "Ana Lúcia Pereira",
"marital_property_system": "PARTIAL_COMMUNION",
"id_document": {
"number": "45.678.912-3",
"issuer": "SSP/SP",
"issue_date": "2015-03-20",
"type": "RG"
},
"sex": "MALE",
"address": {
"street_name": "Avenida Presidente Vargas",
"street_number": 300,
"postal_code": "01010000",
"district": "Centro",
"city": "São Paulo",
"state_code": "SP",
"country_code": "BRA",
"extra_info": "Apartamento 42 – Bloco B"
},
"pix": {
"key": "47343076019",
"key_type": "TAXPAYER_ID"
},
"external_bank_account": {
"bank_code": "001",
"bank_account": "56789",
"bank_account_digit": "0",
"bank_branch": "1234",
"bank_account_type": "CACC",
"ispb_code": "00000000"
},
"custom_variables": {},
"spouse_full_name": "Mariana Alves Pereira",
"spouse_taxpayer_id": "98765432100",
"spouse_date_of_birth": "1992-11-22",
"birthplace": "São Paulo",
"monthly_income": 5500,
"income_range": null,
"has_scr_evidence": false,
"education_level": "HIGHER_COMPLETE",
"employer": {
"id": "008e1751-4d6c-438f-a928-c03ad48c30aa"
}
}
Códigos de Retorno
| Código HTTP | Descrição |
|---|---|
| 201 | Pessoa criada com sucesso |
| 400 | Erro de validação nos campos |
| 401 | Token inválido ou ausente |
| 403 | Acesso não permitido |
| 409 | Pessoa já cadastrada |
| 422 | Dados inconsistentes |