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.
{
"fullName": "Maria Souza",
"document": "96300603296",
"email": "maria@exemplo.com",
"phone": "5511999999999",
"origin": "loan"
}{
"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.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
document | CPF (11) | CNPJ (14) | sim | Aceita máscara; normalizado para dígitos. Define se o cadastro é PF ou PJ |
fullName | string | sim para CPF | Nome completo |
companyName | string | sim para CNPJ | Razão social |
email | string | sim | E-mail do titular |
phone | string | não | Telefone com DDI |
origin | loan | global_account | não | Produto 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ódigo | HTTP | Quando acontece |
|---|---|---|
requirement_not_fillable_by_lender | 422 | Prova de vida — só o titular envia |
pre_registration_not_found | 404 | O documento não tem pré-cadastro criado por você |
onboarding_already_approved | 409 | O cadastro já foi aprovado e não aceita novos documentos |
customer_document_already_registered | 409 | Documento já cadastrado com outros dados |
invalid_document | 422 | CPF ou CNPJ fora do formato |