Aparência
Abertura de Conta — Pessoa Jurídica (PJ)
Prefixo base: https://developer-api.fastgivr.com.br/access
Sequência completa para abrir uma conta Pessoa Jurídica. As etapas 5–9 não têm ordem obrigatória entre si e são idempotentes (podem ser repetidas), mas a ordem abaixo é a recomendada. Para o contrato completo de cada endpoint (payload/campos/resposta), ver a Referência de Endpoints.
Visão geral da sequência
1. Criar usuário → POST /access/register/user
2. Iniciar solicitação → POST /access/register
3. Confirmar e-mail → POST /access/register/email/verify
4. Dados da empresa → PATCH /access/register/company-data
5. Sócios (um por chamada) → POST /access/register/partners
6. Endereço → PATCH /access/register/address
7. Telefone → PATCH /access/register/phone
8. Documentos → POST /access/register/documents (uma vez por tipo)
9. Validação de identidade (uma por sócio) → POST /access/register/identity-validation
→ status muda para "pronto para análise" automaticamente quando tudo estiver completo,
inclusive a validação de identidade de todos os sóciosEtapa 1 — Criar usuário
Objetivo: Criar as credenciais de login antes de iniciar a solicitação.
Endpoint: POST /access/register/user
Dados coletados: nome (razão social), e-mail, CNPJ, telefone, senha.
| Campo | Obrigatório | Observação |
|---|---|---|
name | Sim | Razão social da empresa |
email | Sim | Único no sistema |
document | Sim | CNPJ (14 dígitos) — define que o fluxo é PJ |
phone | Sim | |
password | Sim | mín. 5 caracteres |
Dependências: Nenhuma — é o primeiro passo.
Dados retornados a reutilizar: document (usado em todas as chamadas seguintes para identificar a solicitação).
Etapa 2 — Iniciar a solicitação
Objetivo: Criar a solicitação de abertura de conta (KYC) vinculada ao usuário da etapa 1.
Endpoint: POST /access/register
Dados coletados: só o document — nome e e-mail já vêm do usuário criado na etapa 1.
| Campo | Obrigatório | Observação |
|---|---|---|
document | Sim | O mesmo CNPJ da etapa 1 |
Dependências: Requer o usuário já criado (etapa 1).
Dados retornados a reutilizar: id — vira o register_id usado em todas as chamadas seguintes.
Nesse momento a API envia automaticamente um código de verificação por e-mail.
Etapa 3 — Confirmar o e-mail
Objetivo: Validar o e-mail antes de liberar o preenchimento dos dados da empresa.
Endpoint: POST /access/register/email/verify(se o código não chegar ou expirar, reenviar com POST /access/register/email antes de tentar de novo)
Dados coletados: o código de 4 números recebido por e-mail.
| Campo | Obrigatório | Observação |
|---|---|---|
register_id | Sim | Da etapa 2 |
document | Sim | |
validation_code | Sim | Válido por 10 minutos |
Dependências: Requer a solicitação já iniciada (etapa 2).
Dados retornados a reutilizar: Nenhum novo — a solicitação passa a aceitar as próximas etapas.
Etapa 4 — Dados da empresa
Objetivo: Preencher os dados de KYC da empresa.
Endpoint: PATCH /access/register/company-data
Dados coletados: natureza jurídica, atividade econômica, data de fundação, faturamento, se tem fins lucrativos, nome fantasia.
| Campo | Obrigatório | Observação |
|---|---|---|
register_id / document | Sim | |
legal_nature | Sim | Natureza jurídica (MEI, LTDA, S.A. etc.) |
cnae | Sim | Atividade econômica |
founding_date | Sim | YYYY-MM-DD |
invoicing | Sim | Faixa de faturamento, texto livre |
profitable | Sim | "Y" ou "N" |
trade_name | Não | Nome fantasia |
Dependências: Requer e-mail confirmado (etapa 3). Recusa a chamada se a solicitação não for Pessoa Jurídica.
Dados retornados a reutilizar: Nenhum novo.
Etapa 5 — Sócios
Objetivo: Registrar cada sócio da empresa — obrigatório ter pelo menos um para a solicitação ficar completa.
Endpoint: POST /access/register/partners (repetir uma vez para cada sócio)
Dados coletados: nome, CPF, e-mail, telefone, percentual de participação, se é o responsável legal.
| Campo | Obrigatório | Observação |
|---|---|---|
register_id / document | Sim | Da empresa |
partner_name | Sim | |
partner_document | Sim | CPF do sócio |
partner_email | Não | |
partner_phone | Não | |
ownership_percentage | Não | 0–100 |
legal_representative | Não | true para o sócio que assina pela empresa |
Dependências: Recomendado depois da etapa 4, mas não é obrigatório nessa ordem. Reenviar o mesmo partner_document atualiza o sócio em vez de duplicar. Um sócio pode ser removido com DELETE /access/register/partners/{partnerId}.
Dados retornados a reutilizar: Nenhum novo. Sem nenhum sócio, a solicitação nunca fica pronta para análise — ver Status da Solicitação.
Etapa 6 — Endereço
Objetivo: Preencher o endereço da empresa.
Endpoint: PATCH /access/register/address
| Campo | Obrigatório | Observação |
|---|---|---|
register_id / document | Sim | |
street, address_number, neighborhood, city, state, zip_code | Sim | state com 2 letras |
complement | Não |
Dependências: Nenhuma ordem obrigatória, mas normalmente vem depois dos dados da empresa e dos sócios.
Dados retornados a reutilizar: Nenhum novo.
Etapa 7 — Telefone
Objetivo: Registrar o telefone de contato da empresa.
Endpoint: PATCH /access/register/phone
| Campo | Obrigatório |
|---|---|
register_id / document | Sim |
phone_number | Sim |
Dependências: Nenhuma.
Dados retornados a reutilizar: Nenhum novo.
Etapa 8 — Documentos
Objetivo: Enviar os documentos obrigatórios da empresa — os documentos pessoais do responsável legal não entram mais aqui.
Endpoint: POST /access/register/documents (uma chamada por tipo de documento)
Documentos enviados nesta etapa (pelo computador):
| Tipo | De quem |
|---|---|
cnpj_card | Empresa (Cartão CNPJ) |
social_contract | Empresa (Contrato Social / Estatuto) |
proof_of_address | Empresa (comprovante de endereço) |
Dependências: Nenhuma ordem obrigatória. Reenviar o mesmo tipo substitui o arquivo anterior.
Dados retornados a reutilizar: Nenhum — a lista de documentos enviados pode ser conferida via POST /access/register/resume.
identity_front / identity_back / selfie do responsável legal
Esses 3 documentos não são mais enviados nesta etapa — eles são capturados na Etapa 9 (Validação de Identidade), pelo celular do responsável legal, junto com a prova de vida.
Etapa 9 — Validação de Identidade
Objetivo: Cada sócio precisa concluir sua própria validação de identidade (prova de vida + fotos do documento, frente e verso) pelo próprio celular — individualmente, não é uma validação única da empresa. As fotos enviadas pelo sócio marcado como responsável legal (legal_representative) são os RegisterDocument identity_front/identity_back/selfie da solicitação; as dos demais sócios ficam só como evidência da validação de cada um. Ver Validação de Identidade para o conceito completo.
Endpoint: POST /access/register/identity-validation (uma chamada por sócio, com partner_document)
Dependências: O sócio já precisa existir (etapa 5). Nenhuma ordem obrigatória com as demais etapas — mas a solicitação só fica "pronta para análise" depois que todos os sócios concluírem.
Dados retornados a reutilizar: token/link — enviar ao sócio para ele concluir a validação. Quem conclui a etapa é o provedor, via callback (POST /access/register/identity-validation/callback), não uma chamada do cliente.
Depois de completa
Assim que dados, sócios, endereço, telefone, todos os documentos obrigatórios e a validação de identidade de todos os sócios estiverem completos, o status da solicitação muda automaticamente para "pronto para análise" — não é preciso chamar nenhum endpoint adicional. A partir daí, a equipe de análise assume o processo (ver Revisão e Aprovação).