Voltar
Fortbix
Documentação da API

Pré-cadastro de clientes

Permite cadastrar uma pessoa antes de ela ter conta na plataforma e já enviar os documentos que você tem em mãos, inclusive o documento de identidade. Quando ela acessa a plataforma, encontra o cadastro pronto e precisa apenas da captura de prova de vida, feita pelo próprio titular — é essa captura que valida a identidade contra a selfie.

Serve tanto para crédito quanto para Conta Global — o campo origin define o produto.

Cria (ou reaproveita) o cadastro da pessoa pelo documento e devolve o caso de onboarding. Não cria credencial nem envia e-mail: a conta nasce quando a pessoa acessa a plataforma.

REQUEST BODYapplication/json
{
  "fullName": "Maria Souza",
  "document": "96300603296",
  "email": "maria@exemplo.com",
  "phone": "5511999999999",
  "origin": "loan"
}
201
{
  "customerId": "02628348-5772-4a12-b474-9f040ecfa1c7",
  "onboardingId": "55e15946-7fb4-4c0a-bc95-f026a16bcb9d",
  "personType": "PF",
  "document": "96300603296",
  "registrationStatus": "pre_registered",
  "onboardingStatus": "draft",
  "originType": "lender_pre_register",
  "activationToken": null
}

Campos

O tipo de pessoa vem do próprio documento: 11 dígitos é pessoa física, 14 é pessoa jurídica. personType e documentType são opcionais e existem apenas para compatibilidade — se enviados, precisam corresponder ao documento, caso contrário a requisição é recusada com 422.

CampoTipoObrigatórioDescrição
documentCPF (11) | CNPJ (14)simAceita máscara; normalizado para dígitos. Define se o cadastro é PF ou PJ
fullNamestringsim para CPFNome completo
companyNamestringsim para CNPJRazão social
emailstringsimE-mail do titular
phonestringnãoTelefone com DDI
originloan | global_accountnãoProduto de destino. Padrão loan. Define os módulos liberados quando a conta é criada e não muda depois

fillableByLender indica o que você pode enviar. A prova de vida (selfie, representative_selfie) é feita pelo próprio titular e não aceita upload por esta API — tentar enviá-la devolve 422 requirement_not_fillable_by_lender.

O documento de identidade pode ser adiantado por você. Quando o titular fizer a captura com o provedor, o resultado validado substitui o que foi enviado.

Envio de documentos

O envio tem duas etapas: você pede uma URL assinada e envia o arquivo direto para ela.

Envie o arquivo com PUT na uploadUrl, apenas com o corpo. A URL já carrega a assinatura: acrescentar cabeçalhos como x-amz-checksum-crc32, x-amz-meta-* ou x-amz-sdk-checksum-algorithm faz o armazenamento recusar com 403 AccessDenied e a mensagem There were headers present in the request which were not signed.

curl -X PUT --upload-file comprovante.pdf "<uploadUrl>"

Erros

CódigoHTTPQuando acontece
requirement_not_fillable_by_lender422Prova de vida — só o titular envia
pre_registration_not_found404O documento não tem pré-cadastro criado por você
onboarding_already_approved409O cadastro já foi aprovado e não aceita novos documentos
customer_document_already_registered409Documento já cadastrado com outros dados
invalid_document422CPF ou CNPJ fora do formato