Skip to content

Instantly share code, notes, and snippets.

@anndrelucass

anndrelucass/Criação de Subcontas White Label - Selfie.md Secret

Last active May 23, 2023 19:49
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save anndrelucass/5884b33a96e954277c633d75ee9b3d8f to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save anndrelucass/5884b33a96e954277c633d75ee9b3d8f to your computer and use it in GitHub Desktop.
Download ZIP
Criação de Subcontas White Label com Onboarding Externo
Raw
Criação de Subcontas White Label - Selfie.md

image

Essa documentação adicional tem como finalidade explicar e detalhar o fluxograma de criação de contas Asaas no formato White Label.

O processo se resume nos seguintes passos:

  • Criação da Conta Asaas com Webhooks sendo configurados
  • Envio da Documentação da Conta
  • Consultar situação cadastral da Conta

Atenção:

O formato White Label precisa estar previamente alinhado e implantado pelo seu gerente de contas. A criação de contas Asaas usando os métodos listados abaixo sem uma definição prévia do funcionamento no formato White Label resultará na criação de subcontas fora dessa estrutura.

Criação da Conta Asaas com Webhooks sendo configurados

Configurando webhook junto com a criação da conta filha (https://www.asaas.com/api/v3/accounts) - POST

O detalhe sobre os atributos a serem enviados para criação da Conta Asaas, e detalhes da resposta estão em https://asaasv3.docs.apiary.io/#reference/contas-asaas/criar-conta/criar-conta

Mais informações sobre os Webhooks Asaas em https://asaasv3.docs.apiary.io/#introduction/webhooks

É de suma importância que os Webhooks sejam configurados de início para garantir que nenhum evento de criação ou atualização da conta sejam perdidos, evitando também a necessidade de requisições secundárias para configuração desses métodos.

Os webhooks configuráveis junto com a criação da conta são:

  • accountStatusWebhook - Alteração da situação da conta
  • transferWebhook - Transferências
  • paymentWebhook - Cobranças
  • invoiceWebhook - Notas fiscais

Request

{
    "name": "Conta criada via API",
    "email": "marcelo.almeida@asaas.com.br",
    "cpfCnpj": "66625514000140",
    "companyType": "MEI",            //somente PJ
    "birthDate": "1994-05-16",       //somente PF
    "phone": "11 32300606",
    "mobilePhone": "11 988451155",
    "address": "Av. Rolf Wiest",
    "addressNumber": "277",
    "complement": "Sala 502",
    "province": "Bom Retiro",
    "postalCode": "89223005",
    "accountStatusWebhook": {
        "url": "http://localhost:3000/webhook/accountStatus",
        "email": "marcelo.almeida@gmail.com",
        "interrupted": false,
        "enabled": true,
        "apiVersion": 3,
        "authToken": "5tLxsL6uoN"
    },
    "transferWebhook": {
        "url": "http://localhost:3000/webhook/transfers",
        "email": "marcelo.almeida@gmail.com",
        "interrupted": false,
        "enabled": true,
        "apiVersion": 3,
        "authToken": "5tLxsL6uoN"
    },
    "paymentWebhook": {
        "url": "http://localhost:3000/webhook/payments",
        "email": "marcelo.almeida@gmail.com",
        "interrupted": false,
        "enabled": true,
        "apiVersion": 3,
        "authToken": "5tLxsL6uoN"
    },
    "invoiceWebhook": {
        "url": "http://localhost:3000/webhook/invoices",
        "email": "marcelo.almeida@gmail.com",
        "interrupted": false,
        "enabled": true,
        "apiVersion": 3,
        "authToken": "5tLxsL6uoN"
    }
}

Os detalhes sobre o Webhook de Cobranças, Transferências e Notas Fiscais podem ser encontrados na documentação pública, disponível em https://asaasv3.docs.apiary.io/#reference/configuracao-de-webhooks

Os detalhes sobre o Webhook de Alterações da situação da conta Asaas estão listados abaixo:

Possíveis eventos:

ACCOUNT_STATUS_BANK_ACCOUNT_INFO_APPROVED - Conta bancária aprovada
ACCOUNT_STATUS_BANK_ACCOUNT_INFO_AWAITING_APPROVAL - Conta bancária está em análise
ACCOUNT_STATUS_BANK_ACCOUNT_INFO_PENDING - Conta bancária voltou para pendente
ACCOUNT_STATUS_BANK_ACCOUNT_INFO_REJECTED - Conta bancária reprovada
ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED - Informações comerciais aprovada
ACCOUNT_STATUS_COMMERCIAL_INFO_AWAITING_APPROVAL - Informações comerciais em análise
ACCOUNT_STATUS_COMMERCIAL_INFO_PENDING - Informações comerciais voltou para pendente
ACCOUNT_STATUS_COMMERCIAL_INFO_REJECTED - Informações comerciais reprovada
ACCOUNT_STATUS_DOCUMENT_APPROVED - Documentos aprovados
ACCOUNT_STATUS_DOCUMENT_AWAITING_APPROVAL - Documentos em análise
ACCOUNT_STATUS_DOCUMENT_PENDING - Documentos voltaram para pendente
ACCOUNT_STATUS_DOCUMENT_REJECTED - Documentos reprovados
ACCOUNT_STATUS_GENERAL_APPROVAL_APPROVED - Conta aprovada
ACCOUNT_STATUS_GENERAL_APPROVAL_AWAITING_APPROVAL - Conta em análise
ACCOUNT_STATUS_GENERAL_APPROVAL_PENDING - Conta voltou para pendente
ACCOUNT_STATUS_GENERAL_APPROVAL_REJECTED - Conta reprovada

Exemplo de JSON a ser recebido após alteração da situação da conta [POST]

A notificação consiste em um POST contendo um JSON, conforme este exemplo:

{
    "event": "ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
    "accountStatus": {
        "id": "175027c1-029c-41e5-8b9a-e289b9788c33",
        "commercialInfo": "APPROVED",
        "bankAccountInfo": "APPROVED",
        "documentation": "APPROVED",
        "general": "APPROVED"
    }
}

O atributo id devolverá o ID da conta Asaas que sofreu a alteração de status. Esse ID sempre será retornado como resposta após a criação da conta Asaas.

As chamadas seguintes para envio de documentos deverão ser realizadas utilizando a chave de API da subconta criada. A chave será devolvida como resposta da requisição de criação da conta e deverá ser armazenada nesse momento, não podendo ser recuperada posteriormente.

Veja mais informações sobre o método de autenticação das chamadas APIs em https://asaasv3.docs.apiary.io/#introduction/autenticacao

Atenção:

  • Transferências bancárias só podem ser realizadas após a aprovação geral da conta Asaas.

Envio da Documentação da Conta

Para análise da conta, será necessário realizar o envio da documentação. Com o upload dos documentos, a conta entrará em análise a ser realizada dentro de até 48 horas.

Para contas PF, MEI, LTDA ou Individual, é preciso enviar documento de identificação (RG, CPF ou CNPJ),e selfie do titular/sócio administrador. O onboarding será realizado através de um link externo, cuja URL será devolvido no atributo onboardingUrl dentro do ID respectivo.

Para contas de Associação, será necessário além do onboarding externo, o envio via API de documentos adicionais, que poderão ser consultados no endpoint.

Atenção:

  • Se um dos documentos enviados no link externo for reprovado, um novo link será gerado.

  • Dependendo das condições da análise, é possível que novos documentos adicionais sejam solicitados pelo Asaas. Nesse caso, serão abertos grupos de documentos com o type CUSTOM e sua descrição no atributo description.

A situação da análise dos documentos e da aprovação geral do cadastro poderá ser acompanhada através dos Webhooks de Situação da Conta.

Verificar documentos pendentes (https://www.asaas.com/api/v3/myAccount/documents) - (GET)

NOT_SENT: Documentos ainda não enviados
PENDING:  Documentos em análise
APPROVED: Documentos aprovados, lista de documentos fica oculta
REJECTED: Necessário reenvio de algum documento

Resposta:

{
    "rejectReasons": null,
    "data": [
        {
            "id": "172ed152-4fa4-43ad-9b69-39c323e9526c",
            "status": "NOT SENT",
            "type": "MINUTES_OF_ELECTION",
            "title": "Ata de eleição da última diretoria",
            "description": "Não possui descrição",
            "responsible": {
                "name": null,
                "type": "ASSOCIATION"
            },
            "documents": []
        },
        {
            "id": "da90162b-61ea-48a1-bf73-4638e079043a",
            "status": "NOT_SENT",
            "type": "IDENTIFICATION",
            "title": "Documentos de identificação",
            "description": "Serão aceitos RG ou CNH.",
            "responsible": {
                "name": "presidente",
                "type": "DIRECTOR"
            },
            "onboardingUrl": "https://cadastro.io/8ad196d6cbfcc5d05bfabcbb5c730f6a",
            "documents": []
        },
        {
            "id": "da90162b-61ea-48a1-bf73-4638e079043a",
            "status": "NOT_SENT",
            "type": "IDENTIFICATION_SELFIE",
            "title": "Selfie de identificação",
            "description": "Selfie do Diretor",
            "responsible": {
                "name": "presidente",
                "type": "DIRECTOR"
            },
            "onboardingUrl": "https://cadastro.io/8ad196d6cbfcc5d05bfabcbb5c730f6a",
            "documents": []
        }
    ]
}

Essa consulta lhe retornará a relação de documentos necessários para aprovação da sua conta Asaas. Cada grupo de documento possui um id específico, que deverá ser utilizado na API de "Enviar documento" para subir o documento respectivo caso não seja via onboading externo.

Enviar documento (https://www.asaas.com/api/v3/myAccount/documents/{ID}) - (POST - Multipart)

Quando houver o atributo onboardingUrl no objeto do documento, ele deverá ser enviado via link externo. Não será aceito o envio via POST nesses casos.

Headers:
- Content-Type: multipart/form-data
Params:
- documentFile - Arquivo
- type - Tipo do documento (retornado no get acima)

Resposta:

{
    "id": "8d257732-2220-11ec-b695-b6af4a64184d",
    "status": "PENDING"
}

Após enviar todos os documentos, a resposta deverá retornar da seguinte forma:

{
    "rejectReasons": null,
    "data": [
        {
            "id": "172ed152-4fa4-43ad-9b69-39c323e9526c",
            "status": "PENDING",
            "type": "MINUTES_OF_ELECTION",
            "title": "Ata de eleição da última diretoria",
            "description": "Não possui descrição",
            "responsible": {
                "name": null,
                "type": "ASSOCIATION"
            },
            "documents": [
                {
                    "id": "d6a55791-7b8b-4014-8457-a453c6e5afd5",
                    "status": "PENDING"
                }
            ]
        },
        {
            "id": "da90162b-61ea-48a1-bf73-4638e079043a",
            "status": "PENDING",
            "type": "IDENTIFICATION",
            "title": "Documentos de identificação",
            "description": "Serão aceitos RG ou CNH.",
            "responsible": {
                "name": "presidente",
                "type": "DIRECTOR"
            },
            "documents": [
                {
                    "id": "eb879e06-5fae-44e9-a88d-c5a428945dec",
                    "status": "PENDING"
                },
                {
                    "id": "88eaed70-bea6-45ff-ad99-dbea9469f725",
                    "status": "PENDING"
                }
            ]
        },
        {
            "id": "da90162b-61ea-48a1-bf73-4638e079043a",
            "status": "PENDING",
            "type": "IDENTIFICATION_SELFIE",
            "title": "Selfie de identificação",
            "description": "Selfie do Diretor",
            "responsible": {
                "name": "presidente",
                "type": "DIRECTOR"
            },
            "documents": [
                {
                    "id": "0f059fe4-7c7b-4dac-b936-41e9430b380a",
                    "status": "PENDING"
                }
            ]
        }
    ]
}

Visualizar documento enviado (https://www.asaas.com/api/v3/myAccount/documents/files/{id}) (GET)

Resposta:

{
    "id": "8d257732-2220-11ec-b695-b6af4a64184d",
    "status": "PENDING"
}

Atualizar documento enviado (https://www.asaas.com/api/v3/myAccount/documents/files/{id}) - (POST - Multipart)

Params:
- documentFile - Arquivo

Resposta:

{
    "id": "8d257732-2220-11ec-b695-b6af4a64184d",
    "status": "PENDING"
}

Remover documento enviado (https://www.asaas.com/api/v3/myAccount/documents/files/{id}) - (DELETE)

Resposta:

{
    "deleted": true,
    "id": "8d257732-2220-11ec-b695-b6af4a64184d"
}

Consultar situação cadastral da Conta

Consultando a situação cadastral (https://www.asaas.com/api/v3/myAccount/status) - GET

Caso os webhooks de atualização de situação cadastral não tenham sido implementados e/ou você queira realizar a consulta individualmente, ela poderá ser feita requisitando o endpoint citado acima.

O retorno será no seguinte formato:

{
    "id": "a910f50b-8745-4bc6-89fe-f1931c6a2e05",
    "commercialInfo": "APPROVED",
    "documentation": "APPROVED",
    "general": "APPROVED"
}

Os valores possíveis são: NOT_SENT, PENDING, AWAITING_APPROVAL, APPROVED e REJECTED.

A conta estará 100% aprovada quando o retorno do atributo general for APPROVED.

API Oficial Asaas

Todos os outros recursos de nossa API poderão ser encontrados na nossa documentação oficial, disponível em https://asaasv3.docs.apiary.io/#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment