Branch Registration

For branch enablement, there are two operational flows that can be followed:

Complete Flow (From scratch): This is the comprehensive branch registration, covering everything from address and billing data to legal representative and guarantor information. In this flow, enablement follows the standard process presented previously in the documentation, going through document approval and power validation. This flow requires a new assignment contract for effective enablement of the assignor in the fund.
Simplified Flow (Linked Registration): Presented on this page, this flow treats the branch registration as a link to a previously registered parent company. In it, only basic data is sent and a new assignor_registry_key is created, but data such as representatives and guarantors are mandatorily reused from the parent company analysis.

info

If the branch is already registered as an assignor, it's also possible to link it to the parent company. In this case, previous documentation, representation and guarantors are discarded, and it inherits the parent company's data.

Advantages of the Facilitated Flow

There are two main advantages in the facilitated branch activation flow:

Payment Options: When performing an assignment operation with the branch, the parent company accounts also become payment options.
Configuration Replication: All Assignment Configurations from the parent company are automatically replicated to the branch as soon as it's approved, avoiding the need for the contract signing step. To retrieve the new keys, we recommend using the paginated assignment configuration GET, topic 5.3.1.2., with parameters such as assignment_contract_key, asset_type and assignor_document_number, using the contract formalized by the parent company as reference.

Attention

The facilitated branch flow requires the presence of the following clause in the parent contract formalized with the parent company to be used:

CONSIDERING that the ASSIGNOR declares and guarantees that, if applicable, it is the parent company and holds full powers to legally represent all its branches before the ASSIGNEE, including for the practice of all acts necessary for the formalization and execution of assignments. The ASSIGNOR recognizes and assumes joint and unlimited responsibility for all obligations assumed by its branches as a result of assignments made with the ASSIGNEE, waiving, for all purposes, any allegation of lack of powers or autonomy.

Creating a new Branch

Even though the parent company's AML has already been performed, the first analysis (the linking one) of a branch always goes through the external data consultation and validation step, requiring waiting for the analysis approval or rejection hook, which is sent automatically.

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/branch

MÉTODO

POST

info

The assignor_registry_key sent in the request must belong to the assignor's PARENT COMPANY, and it must already be enabled.

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
        }
    ]
}

Field	Type	Description	Characters
`document_number` *	string	Assignor document number (CNPJ).	14 to 18
`annual_revenues` *	number	Declaration of assignor's annual revenue, in integers.	Minimum of 1
`email` *	string	Assignor email address.	1 to 255
`phone`	object	Object referencing assignor's phone information.	See Phone Definition.
`address` *	object	Object referencing assignor's address information.	See Address Definition.
`accounts` *	array	List of assignor's disbursement accounts.	See Account Definition.

*Required fields.

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": {}
  }
}

Field	Type	Description	Characters
`assignor_registry_key`	string	Registry identifier.	36
`status`	string	Registry status.	See Registry status enumerators.
`name`	string	Assignor name.	1 to 255
`document_number`	string	Assignor document.	14 to 18
`last_analysis`	object	Analysis object.	See Analysis Definition.

info

All representation, guarantor and document information will be automatically replicated from the parent company registry. However, the account sent must be owned by the branch, otherwise, future transfers will fail.

info

It's important to store the assignor_registry_key, as it will be used in various other processes, as well as the analysis_key and analysis_related_party_key.

Linking an existing branch to the parent company

If both the branch and parent company already exist in different registries, it's possible to force the link between them. In this flow, all branch information that wasn't part of the creation request payload will be replaced by the parent company information.

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/branch

MÉTODO

PUT

info

The assignor_registry_key sent in the request must belong to the assignor's PARENT COMPANY, and it must already be enabled.

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

Field	Type	Description	Characters
`branch_assignor_registry_key` *	string	Registry identifier.	36

*Required fields.

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": {}
  }
}

Field	Type	Description	Characters
`assignor_registry_key`	string	Registry identifier.	36
`status`	string	Registry status.	See Registry status enumerators.
`name`	string	Assignor name.	1 to 255
`document_number`	string	Assignor document.	14 to 18
`last_analysis`	object	Analysis object.	See Analysis Definition.

Updating Branch Data

Even though it's a linked registry, branch information can still be updated, but with some restrictions:

Information such as email, phone, address and annual_revenues can be updated using the same endpoint used to change parent company data (presented below). However, data such as name, related_parties, guarantors and documentation itself must always be updated in the Parent Company. When the parent company change is approved, all linked branches automatically replicate the data.

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"
  }
}

Field	Type	Description	Characters
`annual_revenues`	number	Declaration of assignor's annual revenue.	-
`email`	string	Assignor email address.	1 to 255
`phone`	object	Object referencing assignor's phone information.	See Phone Definition.
`address`	object	Object referencing assignor's address information.	See Address Definition.

If you don't want to change a field, simply don't send it in the 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": {}
  }
}

Field	Type	Description	Characters
`assignor_registry_key`	string	Registry identifier.	36
`status`	string	Registry status.	See Registry status enumerators.
`name`	string	Assignor name.	1 to 255
`document_number`	string	Assignor document.	14 to 18
`last_analysis`	object	Analysis object.	See Analysis Definition.

info

Unlike parent company registration, since the changes don't involve representation and AML data, branch changes are always AUTOMATICALLY approved.

info

Account maintenance follows exactly the same logic as parent company account maintenance, according to section 5.2.2.5.

Definitions

Address Definition

Field	Type	Description	Characters
`street` *	string	Street name.	1 to 255
`number` *	string	Address number.	1 to 4
`neighborhood` *	string	Neighborhood.	1 to 255
`city` *	string	City.	1 to 255
`uf` *	string	State abbreviation.	2
`complement`	string	Address complement.	1 to 255
`postal_code` *	string	Postal code.	9 (format: XXXXX-XXX)
`country` *	string	Country (abbreviation).	3, according to ISO 3166-1 alpha-3

*Required fields.

Phone Definition

Field	Type	Description	Characters
`international_dial_code` *	string	International dialing code.	1 to 3
`area_code` *	string	Area code.	2
`number` *	string	Phone number.	8 to 9

*Required fields.

Field	Type	Description	Characters
`name` *	string	Related party name.	1 to 255
`document_number` **	string	Beneficiary document number (CPF).	14 to 18
`passport_number` **	string	Foreign beneficiary document number.	8 to 9
`related_party_type` *	string	Related party relationship type.	See Related party type enumerators
`nationality` *	string	Beneficiary's country of origin.	3, according to ISO 3166-1 alpha-3
`direct_beneficiary` *	boolean	Beneficiary directly or indirectly linked to the assignor.	1 to 255
`is_representative` *	boolean	Indicator if the related party is a signing representative of the assignor.	1 to 255
`company_registry_number` ***	string	If not directly linked to the assignor, which company they are linked to.	1 to 255
`company_country` ***	string	Country where the link company between the beneficiary and assignor is registered.	3, according to ISO 3166-1 alpha-3
`address`	object	Object referencing the representative's address information.	See Address Definition.
`email` ****	string	Representative email address.	1 to 255
`phone`	object	Object referencing the representative's phone information.	See Phone Definition.
`marital_status`	string	Related party marital status.	See Marital status enumerators.
`property_system`	string	Property separation regime.	See Property system enumerators.
`profession`	string	Related party profession.	1 to 255.

*Required fields.

**document_number required for Brazilians, for foreigners, if they have CPF, document_number can be used, otherwise, at least passport_number must be sent.

***Required fields if the related party is not a beneficiary directly linked to the assignor. Otherwise, they shouldn't be sent.

****Fields required only for signing representatives.

info

Non-mandatory fields like marital_status and address can be sent if you want more complete qualification in the parent assignment contract in future steps.

Analysis Definition

Field	Type	Description	Characters
`analysis_key` *	string	Analysis identifier.	36
`analysis_number` *	integer	Sequential analysis number.	-
`status` *	string	Analysis status.	See Analysis status enumerators.
`analysis_related_parties` *	array	Analysis related parties.	See Analysis Related Parties Definition.
`documents` *	array	Analysis documents.	See Document Definition.
`analysis_data` *	object	Request payload that originated the analysis.	-
`analysis_datetime` *	string	Analysis creation datetime object.	-
`reproval_reason`	string	Enumerator with analysis rejection reason.	See Reproval reason enumerators.
`reproval_details`	string	Free field with analysis rejection details.	-

*Required fields.

Field	Type	Description	Characters
`analysis_related_party_key` *	string	Related party identifier.	36
`document_number` *	string	Related party document number.	14 to 18
`name` *	string	Related party name.	1 to 255
`documents` *	array	Related party analysis documents.	See Document Definition.

*Required fields.

Document Definition

Field	Type	Description	Characters
`document_key` *	string	Document identifier.	36
`document_type` *	string	Document type.	See Document type enumerators.
`status`	string	Document status.	See Document status enumerators.
`observation`	string	Sent observations.	-

*Required fields.

Account Definition

Field	Type	Description	Characters
`account_branch` *	string	Assignor account branch.	4
`account_number` *	string	Assignor account number.	3 - 20
`account_digit` *	string	Assignor account digit.	1
`financial_institution_code` *	string	Assignor account bank code.	3
`account_type` *	string	Account type.	See Account type enumerators.
`default_account` *	boolean	Default disbursement account.	-

*Required fields.

Only one assignor account can be the default account, which will be the account to which assignment money will be sent if no alternative account is specified. If more than one default account is sent, an error will be returned.

Attention

Be very careful when filling in account data. If the account is invalid, the assignment payment will not occur, and the entire operation will be canceled.

Guarantor Definition

Field	Type	Description	Characters
`name` *	string	Guarantor name.	3 - 255
`document_number` *	string	Guarantor document number.	14 to 18
`person_type` *	string	Person type (individual or legal entity) of the assignor.	-
`email` *	string	Guarantor email address.	1 to 255
`nationality`	string	Guarantor's country of origin.	3, according to ISO 3166-1 alpha-3
`phone`	object	Object referencing guarantor's phone information.	See Phone Definition.
`address`	object	Object referencing guarantor's address information.	See Address Definition.
`guarantor_representatives`	array	Guarantor signers - Only for legal entity guarantor.	See Guarantor Representative Definition.
`marital_status`	string	Guarantor marital status.	See Marital status enumerators.
`property_system`	string	Property separation regime.	See Property system enumerators.
`profession`	string	Guarantor profession.	1 to 255.

*Required fields.

The guarantor_representatives field can be used to indicate both representatives of a legal entity guarantor, as well as, in the case of an individual guarantor, where necessary, the spouse for Spousal Consent.

Attention

Both the guarantor and representatives will also be added to the generated analysis, requiring sending standard documents according to their person type. They also go through the compliance process, which may generate findings.

Guarantor Representative Definition

Field	Type	Description	Characters
`name` *	string	Representative name.	3 - 255
`document_number` *	string	Guarantor representative document number - must be an individual.	14
`email` *	string	Guarantor representative email address.	1 to 255
`nationality`	string	Guarantor representative's country of origin.	3, according to ISO 3166-1 alpha-3
`address`	object	Object referencing guarantor representative's address information.	See Address Definition.
`phone`	object	Object referencing guarantor representative's phone information.	See Phone Definition.
`marital_status`	string	Guarantor representative marital status.	See Marital status enumerators.
`property_system`	string	Property separation regime.	See Property system enumerators.
`profession`	string	Guarantor representative profession.	1 to 255.

Enumerators

Assignor Registry Status

Enumerator	Description
pending_registry	Pending Registration
registered	Registered

Analysis Status

Enumerator	Description
pending_documents	Pending Documents
sent_to_analysis	Sent to Analysis
pending_internal_validation	In Document Validation
in_manual_analysis	In Manual Compliance Analysis
approved	Approved
reproved	Rejected

Enumerator	Description
president	President
partner	Partner
administrator	Administrator
director	Director
manager	Manager
attorney	Attorney

Document Status

Enumerator	Description
created	Created
valid	Valid
invalid	Invalid
canceled	Canceled
accepted	Accepted, but not validated

Document Type

Enumerator	Description
cnh	Driver's License.
rg_back	ID back side.
rg_front	ID front side.
passport	Passport - exclusive for foreigners.
national_migration_registry	National Migration Registry.
cin_digital	National Identity Card (Digital).
passport	Passport - exclusive for foreigners.
social_contract	Social Contract/Bylaws.
cnpj_card	CNPJ Card.
commercial_board_certificate	Simplified Commercial Board Certificate.
board_election_record	Current Board Election Minutes.
power_of_attorney	Power of Attorney - required if the representative is an attorney.
marital_power_of_attorney	Spousal Power of Attorney - available only for spouses.
compliance_statement	Compliance Opinion.
financial_statement	Financial Statement.
credit_report	Credit Minutes/Opinion.
manager_statement	Manager Opinion/Record.
visit_report	Visit Report.
proof_of_residence	Proof of Residence.
credit_agency_consulation	Credit Protection Agency Consultation.
annual_revenues_declaration	Revenue Declaration.
financial_institutions_declaration	Banking Relationship Declaration.
additional_document	Additional document - free.

Account Type

Enumerator	Description
checking_account	Checking Account

Analysis Reproval Reason

Enum	Description
assignor_update	Analysis canceled due to subsequent registry update
insuficient_documents	Minimum documentation for power verification not sent
compliance_reproval	Link rejection by compliance team analysis
unidentified_related_parties	Related party sent, but link not proven
invalid_documents	Invalid/expired documentation
missing_related_parties	Mandatory related party not sent

Marital Status

Enum	Description
single	Single
married	Married
widower	Widowed
divorced	Divorced
separated	Separated
stable_union	In Stable Union

Property System

Enum	Description
total_communion_of_goods	Total Communion of Goods
partial_communion_of_goods	Partial Communion of Goods
total_separation_of_goods	Total Separation of Goods
final_participation_of_acquisitions	Final Participation in Acquisitions
compulsory_separation_of_goods	Compulsory Separation of Goods

Advantages of the Facilitated Flow​

Creating a new Branch​

Request​

Response​

Linking an existing branch to the parent company​

Request​

Response​

Updating Branch Data​

Request​

Response​

Definitions​

Address Definition​

Phone Definition​

Related Party Definition​

Analysis Definition​

Analysis Related Parties Definition​

Document Definition​

Account Definition​

Guarantor Definition​

Guarantor Representative Definition​

Enumerators

Assignor Registry Status​

Analysis Status​

Related Party Type​

Document Status​

Document Type​

Account Type​

Analysis Reproval Reason​

Marital Status​

Property System​

Advantages of the Facilitated Flow

Creating a new Branch

Request

Response

Linking an existing branch to the parent company

Request

Response

Updating Branch Data

Request

Response

Definitions

Address Definition

Phone Definition

Related Party Definition

Analysis Definition

Analysis Related Parties Definition

Document Definition

Account Definition

Guarantor Definition

Guarantor Representative Definition

Assignor Registry Status

Analysis Status

Related Party Type

Document Status

Document Type

Account Type

Analysis Reproval Reason

Marital Status

Property System