Cadastro de Filiais

Para a habilitação de filiais, existem dois fluxos operacionais que podem ser seguidos:

1. Fluxo Completo (Do zero): É o cadastro integral da filial, abrangendo desde dados de endereço e faturamento até informações de representantes legais e avalistas. Neste fluxo, a habilitação segue o processo padrão apresentado anteriormente na documentação, passando por aprovação de documentos e validação de poderes. Este fluxo exige um novo contrato de cessão para a efetiva habilitação do cedente no fundo.
2. Fluxo Simplificado (Cadastro Vinculado): Apresentado nesta página, este fluxo trata o cadastro da filial como um vínculo a uma matriz previamente cadastrada. Nele, apenas dados básicos são enviados e uma nova assignor_registry_key é criada, porém dados como representantes e avalistas são obrigatoriamente reaproveitados da análise da matriz.

info

Caso a filial já esteja cadastrada como cedente, também é possível vinculá-la à matriz. Nesse caso, a documentação, representação e avalistas anteriores são descartados, e a mesma passa a herdar os dados da matriz.

Vantagens do Fluxo Facilitado

Existem duas principais vantagens no fluxo de ativação facilitada de filiais:

• Opções de Pagamento: Ao realizar uma operação de cessão com a filial, as contas da matriz também se tornam opções de pagamento.
• Replicação de Configurações: Todas as Configurações de Cessão da matriz são automaticamente replicadas para a filial assim que aprovada, evitando a necessidade da etapa de assinatura de contrato. Para recuperar as novas chaves, recomendamos a utilização do GET de configuração de cessão paginado, tópico 5.3.1.2., com parâmetros como assignment_contract_key, asset_type e assignor_document_number, utilizando o contrato formalizado pela matriz como referência.

Atenção

O fluxo facilitado de filiais exige a presença da seguinte cláusula no contrato mãe formalizado com a matriz para ser utilizado:

CONSIDERANDO que o CEDENTE declara e garante que, caso aplicável, é a matriz e detém plenos poderes para representar juridicamente todas as suas filiais perante a CESSIONÁRIA, inclusive para a prática de todos os atos necessários à formalização e à execução de cessões. O CEDENTE reconhece e assume responsabilidade solidária e ilimitada por todas as obrigações assumidas por suas filiais em decorrência de cessões realizadas junto à CESSIONÁRIA, renunciando, para todos os fins, a qualquer alegação de ausência de poderes ou de autonomia.

---

Criando uma nova Filial

Por mais que o PLD da matriz já tenha sido realizado, a primeira análise (a de vínculo) de uma filial sempre passa pela etapa de consulta e validação de dados externa, sendo necessário aguardar o hook de aprovação ou reprovação da análise gerada, que é enviada automaticamente.

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/branch

MÉTODO

POST

info

A assignor_registry_key enviada na requisição deve pertencer à MATRIZ do cedente, e a mesma já deve estar habilitada.

Request Body

{
    "document_number": "32.402.502/0002-16",
    "email": "qitechfilial@qitech.com.br",
    "phone": {
        "international_dial_code": "+55",
        "area_code": "11",
        "number": "936360269"
    },
    "address": {
        "street": "Rua Maria Carolina dois",
        "number": "624",
        "neighborhood": "Jardim Paulistano",
        "city": "Campinas",
        "postal_code": "01445-000",
        "uf": "SP",
        "country": "BRA"
    },
    "annual_revenues": 20000,
    "accounts": [
        {
            "account_branch": "0001",
            "account_number": "0423223",
            "account_digit": "6",
            "financial_institution_code": "329",
            "account_type": "checking_account",
            "default_account": true
        }
    ]
}

Campo	Tipo	Descrição	Caracteres
document_number *	string	Número de documento do cedente (CNPJ).	14 a 18
annual_revenues *	number	Declaração de faturamento anual do cedente, em inteiros.	Mínimo de 1
email *	string	Endereço de e-mail do cedente.	1 a 255
phone	object	Objeto referenciando as informações do telefone do cedente.	Ver Definição de Telefone.
address *	object	Objeto referenciando as informações do endereço do cedente.	Ver Definição de Endereço.
accounts *	array	Lista de contas de desembolso do cedente.	Ver Definição de Conta.

*Campos obrigatórios.

Response

STATUS

201

Response Body

{
  "assignor_registry_key": "9c130814-1aa5-4dcb-b6af-c4abdfca2947",
  "status": "pending_registry",
  "name": "QI Tech",
  "document_number": "32.402.502/0002-16",
  "last_analysis": {
    "analysis_key": "49bcaaca-6029-4f6f-97a0-d71f7cefb7ae",
    "analysis_number": 1,
	  "status": "sent_to_analysis",
    "analysis_related_parties": [
      {
        "analysis_related_party_key": "65a74b18-0da8-4460-844b-524c9941e615",
        "document_number": "802.834.257-41",
        "name": "Roberto Carlos",
        "documents": []
      },
      {
        "analysis_related_party_key": "f2bc3473-1686-4d15-9a06-b51d25e20cb4",
        "document_number": "883.512.866-80",
        "name": "Natália Nascimento",
        "documents": []
      },
      {
        "analysis_related_party_key": "272cc251-a56d-4b89-82a1-d815a319b9fb",
        "passport_number": "C01X00T47",
        "name": "Maria Vitoria",
        "documents": []
      }
    ],
    "documents": [
      {
        "document_key": "5530af20-f52e-4a2e-b0f3-732e8121f4b3",
        "document_type": "social_contract",
        "status": "valid",
      }
    ],
    "analysis_data": {}
  }
}

Campo	Tipo	Descrição	Caracteres
assignor_registry_key	string	Identificador do cadastro.	36
status	string	Status do cadastro.	Ver Enumeradores de status do cadastro.
name	string	Nome do Cedente.	1 a 255
document_number	string	Documento do Cedente.	14 a 18
last_analysis	object	Objeto de análise.	Ver Definição de Análise.

info

Toda informação de representação, avalistas e documentos serão automaticamente replicadas do cadastro da matriz. Entretanto, a conta enviada deve ser de titularidade da filial, caso contrário, futuras transferências falharão.

info

É importante armazenar a assignor_registry_key, pois ela será utilizada em diversos outros processos, assim como a analysis_key e as analysis_related_party_key.

---

Vinculando uma filial já existente à matriz

Caso tanto a filial quanto a matriz já existam em cadastros diferentes, é possível forçar o vínculo entre as duas. Nesse fluxo, todas as informações da filial que não compunham o payload da requisição de criação serão substituídas pelas informações da matriz.

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/branch

MÉTODO

PUT

info

A assignor_registry_key enviada na requisição deve pertencer à MATRIZ do cedente, e a mesma já deve estar habilitada.

Request Body

{
    "branch_assignor_registry_key": "9c130814-1aa5-4dcb-b6af-c4abdfca2947",
}

Campo	Tipo	Descrição	Caracteres
branch_assignor_registry_key *	string	Identificador do cadastro.	36

*Campos obrigatórios.

Response

STATUS

200

Response Body

{
  "assignor_registry_key": "9c130814-1aa5-4dcb-b6af-c4abdfca2947",
  "status": "pending_registry",
  "name": "QI Tech",
  "document_number": "32.402.502/0002-16",
  "last_analysis": {
    "analysis_key": "49bcaaca-6029-4f6f-97a0-d71f7cefb7ae",
    "analysis_number": 1,
	  "status": "sent_to_analysis",
    "analysis_related_parties": [
      {
        "analysis_related_party_key": "65a74b18-0da8-4460-844b-524c9941e615",
        "document_number": "802.834.257-41",
        "name": "Roberto Carlos",
        "documents": []
      },
      {
        "analysis_related_party_key": "f2bc3473-1686-4d15-9a06-b51d25e20cb4",
        "document_number": "883.512.866-80",
        "name": "Natália Nascimento",
        "documents": []
      },
      {
        "analysis_related_party_key": "272cc251-a56d-4b89-82a1-d815a319b9fb",
        "passport_number": "C01X00T47",
        "name": "Maria Vitoria",
        "documents": []
      }
    ],
    "documents": [
      {
        "document_key": "5530af20-f52e-4a2e-b0f3-732e8121f4b3",
        "document_type": "social_contract",
        "status": "valid",
      }
    ],
    "analysis_data": {}
  }
}

Campo	Tipo	Descrição	Caracteres
assignor_registry_key	string	Identificador do cadastro.	36
status	string	Status do cadastro.	Ver Enumeradores de status do cadastro.
name	string	Nome do Cedente.	1 a 255
document_number	string	Documento do Cedente.	14 a 18
last_analysis	object	Objeto de análise.	Ver Definição de Análise.

---

Atualizando dados de uma Filial

Por mais que seja um cadastro vinculado, as informações da filial ainda podem ser atualizadas, porém com algumas restrições:

Informações como email, phone, address e annual_revenues podem ser atualizadas utilizando o mesmo endpoint utilizado para alterar dados da matriz (apresentado abaixo). Entretanto, dados como name, related_parties, guarantors e a documentação em si devem ser atualizados sempre na Matriz. Quando a alteração da matriz é aprovada, todas as filiais vinculadas replicam os dados automaticamente.

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY

MÉTODO

PUT

Request Body

{
  "email": "qidtvm@qitech.com.br",
  "annual_revenues": 1000000,
  "address": {
    "street": "Rua Maria Carolina",
    "number": "624",
    "neighborhood": "Jardim Paulistano",
    "city": "São Paulo",
    "postal_code": "01445-000",
    "uf": "SP",
    "country": "BRA"
  },
  "phone": {
    "international_dial_code": "+55",
    "area_code": "11",
    "number": "936360268"
  }
}

Campo	Tipo	Descrição	Caracteres
annual_revenues	number	Declaração de faturamento anual do cedente.	-
email	string	Endereço de e-mail do cedente.	1 a 255
phone	object	Objeto referenciando as informações do telefone do cedente.	Ver Definição de Telefone.
address	object	Objeto referenciando as informações do endereço do cedente.	Ver Definição de Endereço.

Caso não deseje alterar um campo, basta não enviá-lo na request.

Response

STATUS

200

Response Body

{
  "assignor_registry_key": "9c130814-1aa5-4dcb-b6af-c4abdfca2947",
  "status": "registred",
  "name": "QI Tech",
  "document_number": "32.402.502/0002-16",
  "last_analysis": {
    "analysis_key": "f51a49e1-842c-471f-a0e1-32ee9f12625d",
    "analysis_number": 2,
    "status": "approved",
    "analysis_related_parties": [
      {
        "analysis_related_party_key": "f361763a-91f5-4688-8e28-cc3f3fbccf9a",
        "document_number": "802.834.257-41",
        "name": "Roberto Carlos",
        "documents": []
      },
      {
        "analysis_related_party_key": "7ea3193b-8e53-40b7-94cf-2d3cc62942e0",
        "document_number": "883.512.866-80",
        "name": "Natália Nascimento",
        "documents": []
      },
      {
        "analysis_related_party_key": "f321f063-5f9a-4964-a24a-52deba128160",
        "passport_number": "C01X00T47",
        "name": "Maria Vitoria",
        "documents": []
      }
    ],
    "documents": [
      {
        "document_key": "994621ac-7d3f-4f6b-90c5-74a4d8c5d017",
        "document_type": "social_contract",
        "status": "valid",
      }
    ],
    "analysis_data": {}
  }
}

Campo	Tipo	Descrição	Caracteres
assignor_registry_key	string	Identificador do cadastro.	36
status	string	Status do cadastro.	Ver Enumeradores de status do cadastro.
name	string	Nome do Cedente.	1 a 255
document_number	string	Documento do Cedente.	14 a 18
last_analysis	object	Objeto de análise.	Ver Definição de Análise.

info

Diferente do cadastro de uma matriz, como as alterações não envolvem dados de representação e PLD, a alteração da filial é sempre aprovada AUTOMATICAMENTE.

info

A manutenção de contas segue exatamente a mesma lógica da manutenção de contas da matriz, segundo a aba 5.2.2.5.

---

Definições

Definição de Endereço

Campo	Tipo	Descrição	Caracteres
street *	string	Nome da rua.	1 a 255
number *	string	Número do endereço.	1 a 4
neighborhood *	string	Bairro.	1 a 255
city *	string	Cidade.	1 a 255
uf *	string	Sigla do estado.	2
complement	string	Complemento do endereço.	1 a 255
postal_code *	string	Código postal.	9 (formato: XXXXX-XXX)
country *	string	País (sigla).	3, de acordo com a ISO 3166-1 alpha-3

*Campos obrigatórios.

---

Definição de Telefone

Campo	Tipo	Descrição	Caracteres
international_dial_code *	string	Código internacional de discagem.	1 a 3
area_code *	string	Código de área.	2
number *	string	Número de telefone.	8 a 9

*Campos obrigatórios.

---

Definição de Parte Relacionada

Campo	Tipo	Descrição	Caracteres
name *	string	Nome da parte relacionada.	1 a 255
document_number **	string	Número de documento do beneficiário (CPF).	14 a 18
passport_number **	string	Número de documento do beneficiário estrangeiro.	8 a 9
related_party_type *	string	Tipo de vínculo da parte relacionada.	Ver Enumeradores de tipo de parte relacionada
nationality *	string	País de origem do beneficiário.	3, de acordo com a ISO 3166-1 alpha-3
direct_beneficiary *	boolean	Beneficiário diretamente ou indiretamente ligado ao cedente.	1 a 255
is_representative *	boolean	Indicador se a parte relacionada é representante assinante do cedente.	1 a 255
company_registry_number ***	string	Caso não seja diretamente ligado ao cedente, à qual companhia o mesmo está ligado.	1 a 255
company_country ***	string	País onde a companhia-elo entre o beneficiário e o cedente está registrada.	3, de acordo com a ISO 3166-1 alpha-3
address	object	Objeto referenciando as informações do endereço do representante.	Ver Definição de Endereço.
email ****	string	Endereço de e-mail do representante.	1 a 255
phone	object	Objeto referenciando as informações do telefone do representante.	Ver Definição de Telefone.
marital_status	string	Estado civil da parte relacionada.	Ver Enumeradores de estado civil.
property_system	string	Regime de separação de bens.	Ver Enumeradores de regime de separação de bens.
profession	string	Profissão da parte relacionada.	1 a 255.

*Campos obrigatórios.

**document_number obrigatório para brasileiros, para estrangeiros, caso tenha CPF, é possível utilizar o document_number, caso contrário, pelo menos o passport_number deve ser enviado.

***Campos obrigatórios caso a parte relacionada não seja beneficiário diretamente ligada ao cedente. Caso contrário, não devem ser enviados.

****Campos exigidos apenas para representantes assinantes.

info

Campos não obrigatorios, como marital_status e address, podem ser enviados caso deseje uma qualificação mais completa no contrato mãe de cessão, nas etapas futuras.

---

Definição de Análise

Campo	Tipo	Descrição	Caracteres
analysis_key *	string	Identificador da análise.	36
analysis_number *	integer	Número sequencial da análise.	-
status *	string	Status da análise.	Ver Enumeradores de status de análise.
analysis_related_parties *	array	Partes Relacionadas da análise.	Ver Definição de Partes Relacionadas de Análise.
documents *	array	Documentos da anáise.	Ver Definição de Documentos de análise.
analysis_data *	object	Payload da request que originou a análise.	-
analysis_datetime *	string	Objeto date time da criação da análise.	-
reproval_reason	string	Enumerador com o motivo de rejeição da análise.	Ver Enumeradores de motivo de reprovação.
reproval_details	string	Campo livre com detalhes da rejeição da análise.	-

*Campos obrigatórios.

---

Definição de Partes Relacionadas de análise

Campo	Tipo	Descrição	Caracteres
analysis_related_party_key *	string	Identificador da parte relacionada.	36
document_number *	string	Número de documento da parte relacionada.	14 a 18
name *	string	Nome da parte relacionada.	1 a 255
documents *	array	Documentos da anáise da parte relacionada.	Ver Definição de Documentos de análise.

*Campos obrigatórios.

---

Definição de Documentos

Campo	Tipo	Descrição	Caracteres
document_key *	string	Identificador do documento.	36
document_type *	string	Tipo do documento.	Ver Enumeradores de tipo de documento.
status	string	Status do documento.	Ver Enumeradores de status de documento.
observation	string	Observações enviadas.	-

*Campos obrigatórios.

---

Definição de Conta

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência da conta do cedente.	4
account_number *	string	Número da conta do cedente.	3 - 20
account_digit *	string	Dígito da conta do cedente.	1
financial_institution_code *	string	Código do banco da conta do cedente.	3
account_type *	string	Tipo de conta.	Ver Enumeradores de tipo de conta.
default_account *	boolean	Conta padrão de desembolso.	-

*Campos obrigatórios.

Apenas uma conta do cedente pode ser a conta padrão, que será a conta para qual o dinheiro das cessões será enviado caso nenhuma conta alternativa seja indicada. Caso sejam enviadas mais de uma conta padrão, um erro será retornado.

Atenção

Muito cuidado ao preencher os dados da conta. Caso a conta seja inválida, o pagamento da cessão não ocorrerá, e toda a operação será cancelada.

---

Definição de Avalista

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do Avalista.	3 - 255
document_number *	string	Número de documento do avalista.	14 a 18
person_type *	string	Tipo de pessoa (física ou jurídica) do cedente.	-
email *	string	Endereço de e-mail do avalista.	1 a 255
nationality	string	País de origem do avalista.	3, de acordo com a ISO 3166-1 alpha-3
phone	object	Objeto referenciando as informações do telefone do avalista.	Ver Definição de Telefone.
address	object	Objeto referenciando as informações do endereço do avalista.	Ver Definição de Endereço.
guarantor_representatives	array	Assinantes do Avalista - Apenas para avalista pessoa jurídica.	Ver Definição de Representante do Avalista.
marital_status	string	Estado civil do avalista.	Ver Enumeradores de estado civil.
property_system	string	Regime de separação de bens.	Ver Enumeradores de regime de separação de bens.
profession	string	Profissão do avalista.	1 a 255.

*Campos obrigatórios.

O campo guarantor_representatives pode ser utilizado para indicar tanto representantes de um avalista pessoa jurídica, quanto, no caso de avalista pessoa física, onde se encontrar necessário, o cônjuge para realização da Outorga Uxória.

Atenção

Tanto o avalista quanto os representantes também serão adicionados à anáise gerada, sendo necessário enviar os documentos padrão de acordo com o tipo de pessoa do mesmo. Os mesmos também passam pelo processo de compliance, podendo gerar apontamentos.

---

Definição de Representante do Avalista

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do Representante.	3 - 255
document_number *	string	Número de documento do representante do avalista - obrigatóriamente pessoa física.	14
email *	string	Endereço de e-mail do representante do avalista.	1 a 255
nationality	string	País de origem do representante do avalista.	3, de acordo com a ISO 3166-1 alpha-3
address	object	Objeto referenciando as informações do endereço do representante do avalista.	Ver Definição de Endereço.
phone	object	Objeto referenciando as informações do telefone do representante do avalista.	Ver Definição de Telefone.
marital_status	string	Estado civil do representante do avalista.	Ver Enumeradores de estado civil.
property_system	string	Regime de separação de bens.	Ver Enumeradores de regime de separação de bens.
profession	string	Profissão do representante do avalista.	1 a 255.

---

Enumeradores

Assignor Registry Status

Enumerador	Descrição
pending_registry	Pendente Registro
registered	Registrado

---

Analysis Status

Enumerador	Descrição
pending_documents	Pendente Documentos
sent_to_analysis	Enviado para Análise
pending_internal_validation	Em Validação de documentos
in_manual_analysis	Em Análise Manual de Compliance
approved	Aprovado
reproved	Reprovado

---

Related Party Type

Enumerador	Descrição
president	Presidente
partner	Sócio
administrator	Administrador
director	Diretor
manager	Gestor
attorney	Procurador

---

Document Status

Enumerador	Descrição
created	Criado
valid	Válido
invalid	Inválido
canceled	Cancelado
accepted	Aceito, porém não validado

---

Document Type

Enumerador	Descrição
cnh	CNH.
rg_back	RG parte traseira.
rg_front	RG parte frontal.
passport	Passaporte - exclusivo para estrangeiros.
national_migration_registry	Registro Nacional de Migração.
cin_digital	Carteira de Identidade Nacional (Digital).
passport	Passaporte - exclusivo para estrangeiros.
social_contract	Contrato/Estatuto Social.
cnpj_card	Cartão CNPJ.
commercial_board_certificate	Certidão Simplidicada da Junta Comercial.
board_election_record	Ata de Eleição da Diretoria Vigente.
power_of_attorney	Procuração - obrigatório caso o representante seja um procurador.
marital_power_of_attorney	Procuração Uxória - disponível apenas para cônjuges.
compliance_statement	Parecer de Compliance.
financial_statement	Demonstração Financeira.
credit_report	Ata/Parecer de Crédito.
manager_statement	Parecer/Ficha do Gestor.
visit_report	Relatório de Visita.
proof_of_residence	Comprovante de Residência.
credit_agency_consulation	Consulta aos órgãos de Proteção de Crédito.
annual_revenues_declaration	Declaração de Faturamento.
financial_institutions_declaration	Declaração de Relacionamento Bancário.
additional_document	Documento adicional - livre.

---

Account Type

Enumerador	Descrição
checking_account	Conta Corrente

---

Analysis Reproval Reason

Enum	Description
assignor_update	Análise cancelada devido à atualização cadastral posterior
insuficient_documents	Documentação mínima para comprovação de poderes não enviada
compliance_reproval	Reprovação de vínculo por análise do time de compliance
unidentified_related_parties	Parte relacionada enviada, porém vinculo não comprovado
invalid_documents	Documentação inválida/expirada
missing_related_parties	Parte relacionada obrigatória não enviada

---

Marital Status

Enum	Description
single	Solteiro(a)
married	Casado(a)
widower	Viúvo(a)
divorced	Divorciado(a)
separated	Separado(a)
stable_union	Em União Estável

---

Property System

Enum	Descrição
total_communion_of_goods	Comunhão Total de Bens
partial_communion_of_goods	Comunhão Parcial de Bens
total_separation_of_goods	Separação Total de Bens
final_participation_of_acquisitions	Participação Final nos Aquestos
compulsory_separation_of_goods	Separação Obrigatória de Bens