Onboarding e envio de documentos via link

Após criar uma subconta BaaS, consulte os documentos necessários e direcione o titular ao onboardingUrl retornado pelo Asaas quando esse método de envio estiver disponível.

O link permite o envio da documentação e, quando aplicável, a realização da selfie para reconhecimento facial. Nesse fluxo, a experiência deve seguir as regras de identificação do Asaas aplicáveis ao modelo BaaS.

Como funciona

O atributo onboardingUrl define como cada documento deve ser enviado.

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
    A["Criar a subconta"] --> B["Aguardar no mínimo<br/>15 segundos"]
    B --> C["Consultar documentos<br/>pendentes"]
    C --> D{"Possui onboardingUrl?"}

    D --> DSim(("Sim"))
    D --> DNao(("Não"))

    DSim --> E["Redirecionar o titular<br/>para o link"]
    DNao --> F["Enviar documento<br/>pela API"]

    E --> G["Acompanhar análise<br/>por Webhooks"]
    F --> G
    G --> H["Conta aprovada"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
    classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,stroke-width:3px,font-size:17px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px,font-size:17px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px,font-size:17px

    classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px,font-size:16px
    classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px,font-size:16px

    class A inicio
    class B,C,E,F,G validacao
    class D decisao
    class H sucesso

    class DSim respostaSim
    class DNao respostaNao

    linkStyle default stroke:#94A3B8,stroke-width:2px
    linkStyle 3 stroke:#22C55E,stroke-width:4px
    linkStyle 4 stroke:#EF4444,stroke-width:4px

1. Consulte os documentos pendentes

Depois de criar a subconta, consulte quais documentos são necessários para a aprovação.

GET /v3/myAccount/documents
Confira a referência completa deste endpoint

A resposta informa os documentos ou grupos de documentos relacionados à análise cadastral. Os principais campos para definir a próxima ação são:

2. Envie cada documento pelo método indicado

Documento com onboardingUrl

Quando o documento possuir onboardingUrl, direcione o titular para esse endereço.

O envio desse documento deve ocorrer pelo link externo. Não substitua esse fluxo por POST /v3/myAccount/documents/{id}.

Para PF e pessoas jurídicas, podem ser solicitados documentos de identificação e selfie do titular ou responsável. Associações também podem exigir documentos adicionais enviados pela API.

Documento sem onboardingUrl

Quando o documento não possuir onboardingUrl e permitir envio pela API, utilize o id do grupo:

POST /v3/myAccount/documents/{id}
Confira a referência completa deste endpoint

Um grupo pode receber mais de um arquivo quando necessário.

O id retornado para o arquivo também é utilizado nas operações de gerenciamento do documento:

3. Acompanhe a análise por Webhooks

Após o envio, a conta entra em análise, que pode levar até 48 horas.

Utilize os Webhooks de situação da conta para acompanhar mudanças na documentação e na aprovação geral da subconta. Isso evita consultas recorrentes à API apenas para verificar mudanças de status.

Consulte os eventos para verificar situação da conta.

Quando a documentação for rejeitada ou novas informações forem necessárias, atualize sua jornada de onboarding conforme o status recebido.

4. Consulte a situação cadastral quando necessário

Para recuperar o estado atual da subconta de forma pontual, utilize:

GET /v3/myAccount/status
Confira a referência completa deste endpoint

{
  "id": "afb621a5-9030-4b4d-88e8-5b80306d13350",
  "commercialInfo": "AWAITING_APPROVAL",
  "bankAccountInfo": "APPROVED",
  "documentation": "APPROVED",
  "general": "APPROVED"
}

A API retorna separadamente a situação dos dados comerciais, dados bancários, documentação e aprovação geral.

Para acompanhar alterações automaticamente, continue utilizando Webhooks em vez de consultar esse endpoint de forma recorrente.

Os valores possíveis e a interpretação completa de cada atributo estão disponíveis na referência de situação cadastral.

Se precisar corrigir os dados comerciais

Se a análise indicar inconsistência nos dados comerciais, utilize:

POST /v3/myAccount/commercialInfo
Confira a referência completa deste endpoint

Envie novamente todos os dados exigidos pelo endpoint. O campo incomeValue é obrigatório, e determinadas alterações podem iniciar uma nova análise da conta.

Prova de vida

No onboarding via link, a prova de vida ocorre pelo envio e aprovação da selfie.

Inicialmente, a conta fica habilitada para criar cobranças e realizar transferências. Em aproximadamente 90% dos casos, a aprovação da prova de vida ocorre em até 5 minutos.

Próximos passos

• Entenda o fluxo de aprovação das subcontas
• Configure os eventos de situação da conta
• Gerencie as chaves de API das subcontas
• Entenda a confirmação anual dos dados comerciais
• Consulte a FAQ do Período de Avaliação