Criar uma pessoa

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

CampoTipoObrigatórioDescrição
external_idstringNãoIdentificador externo do cliente no sistema integrador
taxpayer_idstringSimCPF (somente números)
nationalitystringSimNacionalidade
pepbooleanSimIndica se é Pessoa Politicamente Exposta
full_namestringSimNome completo
birth_datestring (YYYY-MM-DD)SimData de nascimento
birthplacestringNãoCidade de nascimento
sexstringNãoSexo biológico
marital_statusstringNãoEstado civil
marital_property_systemstringNãoRegime de bens (obrigatório se casado)
mothers_namestringSimNome completo da mãe
occupationstringSimProfissão
monthly_incomenumberNãoRenda mensal
income_rangestringNãoFaixa de renda
education_levelstringNãoGrau de escolaridade
has_scr_evidencebooleanNãoIndica se há evidência no SCR

Contato

Telefone (phone)

CampoTipoObrigatórioDescrição
country_codestringSimCódigo do país
area_codestringSimDDD
numberstringSimNúmero do telefone

E-mail

CampoTipoObrigatórioDescrição
email_addressstringSimEndereço de e-mail

Documento de Identificação (id_document)

CampoTipoObrigatórioDescrição
numberstringNãoNúmero do documento
issuerstringNãoÓrgão emissor
issue_datestring (YYYY-MM-DD)NãoData de emissão
typestringNãoTipo do documento

Endereço (address)

CampoTipoObrigatórioDescrição
street_namestringSimLogradouro
street_numbernumberSimNúmero
postal_codestringSimCEP
districtstringSimBairro
citystringSimCidade
state_codestringSimUF
country_codestringSimCódigo do país
extra_infostringNãoComplemento

PIX (pix)

CampoTipoObrigatório (se não houver Conta)Descrição
keystringSimChave PIX
key_typestringSimTipo da chave PIX

Conta Bancária Externa (external_bank_account)

CampoTipoObrigatório (se não houver PIX)Descrição
bank_codestringSimCódigo do banco (COMPE)
bank_branchstringSimAgência
bank_accountstringSimNúmero da conta
bank_account_digitstringSimDígito da conta
bank_account_typestringSimTipo da conta
ispb_codestringSimCódigo ISPB da instituição

Cônjuge

CampoTipoObrigatórioDescrição
spouse_full_namestringNãoNome completo do cônjuge
spouse_taxpayer_idstringNãoCPF do cônjuge
spouse_date_of_birthstring (YYYY-MM-DD)NãoData de nascimento do cônjuge

Empregador (employer)

CampoTipoObrigatórioDescrição
idstring (UUID)NãoIdentificador do empregador

Variáveis Customizadas

CampoTipoObrigatórioDescrição
custom_variablesobjectNãoPar 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 HTTPDescrição
201Pessoa criada com sucesso
400Erro de validação nos campos
401Token inválido ou ausente
403Acesso não permitido
409Pessoa já cadastrada
422Dados inconsistentes
Language
URL
Click Try It! to start a request and see the response here!