Registration Submission
In the first stage of the assignor's registration, its data is provided as defined below. It is worth recalling that merely submitting the data does not create an operational assignor — it will only be activated after its documents have been successfully analyzed.
Mandatorily for legal entities, and optionally for natural persons, it is possible to register related parties, which represent the ultimate beneficial owners linked to the assignor.
An ultimate beneficial owner is defined as the individual, or group of individuals, with significant relevance in the company or conglomerate, holding decision-making power or a significant stake in the ownership structure. For registration purposes, any associates with a stake above 15% in the company, or in the conglomerate they are part of, must be taken into account; or, if there is no such relevant stake, the three largest ones in descending order.
If the relevant beneficiary is another company, its own ultimate beneficial owners must be assigned, indicated as indirect beneficiaries. In addition, any attorneys-in-fact, managers and directors involved in the operation are considered related parties, and they will be the assignor's signing representatives in it.
Signing representatives are related parties responsible for following and signing the documents addressed to the assignor by our system. Evidence of the relationship is required — for companies, through the ownership structure or the list of directors, or with a power of attorney. It is not possible to register a related party that is not an attorney-in-fact for a natural person assignor. In addition, you must indicate whether the related party considered an ultimate beneficial owner has a direct or indirect link to the assignor.
In the Sandbox environment, we apply the following approval rule: CPF/CNPJ starting with 1: automatic rejection; CPF/CNPJ starting with 8: pending manual validation; all others are approved automatically.
Assignor Registration
Request
{
"name": "QI Tech",
"document_number": "32.402.502/0001-35",
"person_type": "legal_person",
"email": "qitech@qitech.com.br",
"annual_revenues": 1000000,
"is_in_national_financial_system": true,
"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"
},
"related_parties": [
{
"name": "Natália Nascimento",
"document_number": "883.512.866-80",
"related_party_type": "attorney",
"nationality": "BRA",
"address": {
"street": "Rua Maria Carolina",
"number": "624",
"neighborhood": "Jardim Paulistano",
"city": "São Paulo",
"postal_code": "01445-000",
"uf": "SP",
"country": "BRA"
},
"direct_beneficiary": true,
"is_representative": true,
"email": "natalia.nascimento@yopmail.com",
"phone": {
"international_dial_code": "+55",
"area_code": "11",
"number": "936360268"
}
},
{
"name": "Maria Vitoria",
"related_party_type": "president",
"nationality": "DEU",
"passport_number": "C01X00T47",
"direct_beneficiary": true,
"is_representative": false
},
{
"name": "Roberto Carlos",
"document_number": "802.834.257-41",
"related_party_type": "director",
"nationality": "BRA",
"direct_beneficiary": false,
"company_country": "NZL",
"company_registry_number": "4984037284610",
"is_representative": false,
"email": "roberto.carlos@yopmail.com",
"phone": {
"international_dial_code": "+64",
"area_code": "11",
"number": "936360268"
}
}
],
"accounts": [
{
"account_branch": "0001",
"account_number": "7912584",
"account_digit": "1",
"financial_institution_code": "329",
"account_type": "checking_account",
"default_account": true
},
{
"account_branch": "0001",
"account_number": "8758931",
"account_digit": "5",
"financial_institution_code": "329",
"account_type": "escrow_account",
"default_account": false
}
],
"guarantors": [
{
"name": "Natural person guarantor",
"address": {
"street": "Rua Maria Carolina",
"number": "624",
"neighborhood": "Jardim Paulistano",
"city": "São Paulo",
"postal_code": "01445-000",
"uf": "SP",
"country": "BRA"
},
"document_number": "172.775.419-01",
"person_type": "natural_person",
"email": "email@avalista.com"
},
{
"name": "Legal entity guarantor",
"document_number": "65.679.662/0001-85",
"person_type": "legal_person",
"email": "email@avalista.com",
"guarantor_representatives": [
{
"name": "Guarantor signer",
"document_number": "244.412.084-13",
"email": "emailrepresentante@avalista.com",
"address": {
"street": "Rua Maria Carolina",
"number": "624",
"neighborhood": "Jardim Paulistano",
"city": "São Paulo",
"postal_code": "01445-000",
"uf": "SP",
"country": "BRA"
}
}
]
},
]
}
Assignor Definition
| Field | Type | Description | Characters |
|---|---|---|---|
name * | string | Assignor's name. | 1 to 255 |
document_number * | string | Assignor's document number (CNPJ). | 14 to 18 |
annual_revenues * | number | Assignor's declared annual revenue, as an integer. | Minimum of 1 |
person_type * | string | Assignor's person type (natural or legal). | - |
email * | string | Assignor's e-mail address. | 1 to 255 |
is_in_national_financial_system * | boolean | Indicates whether the assignor is part of the Brazilian National Financial System (SFN). | - |
phone | object | Object referencing the assignor's phone information. | See Phone Definition. |
address * | object | Object referencing the assignor's address information. | See Address Definition. |
related_parties * | array | List of the company's related parties. | See Related Party Definition. |
accounts * | array | List of the assignor's disbursement accounts. | See Account Definition. |
guarantors * | array | List of the assignor's guarantors. | See Guarantor Definition. |
*Required fields.
Response
{
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_registry",
"name": "QI Tech",
"document_number": "32.402.502/0001-35",
"last_analysis": {
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 1,
"status": "pending_documents",
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"document_number": "802.834.257-41",
"name": "Roberto Carlos",
"documents": []
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"document_number": "883.512.866-80",
"name": "Natália Nascimento",
"documents": []
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"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 | Registration identifier. | 36 |
status | string | Registration status. | See Registration status enumerators. |
name | string | Assignor's name. | 1 to 255 |
document_number | string | Assignor's document. | 14 to 18 |
last_analysis | object | Analysis object. | See Analysis Definition. |
It is important to store the assignor_registry_key, as it will be used in several other processes, as will the analysis_key and the analysis_related_party_key values, which are used to submit the assignor's and the related parties' documents.
In the analysis structure, a guarantor, or a guarantor's representative, is also represented by an analysis_related_party. Note that it is unique per document_number, so if the same person is both a guarantor and a related party of the assignor, for example, only one analysis_related_party is generated, with a single analysis_related_party_key, which serves both the related party and the guarantor.
Representatives of a natural person are limited to the attorney-in-fact who can sign on their behalf.
Treatable Errors
| Code | HTTP | Cause | How to resolve |
|---|---|---|---|
| ASR000032 | 409 | This agent has already registered this assignor. | The document_number already has a registration; use the registration update flow. |
| ASR000054 | 400 | A legal entity assignor must have at least 1 related party. | Include at least one related party in related_parties. |
| ASR000056 | 400 | A natural person cannot be part of the National Financial System. | For person_type=natural_person, send is_in_national_financial_system=false. |
| ASR000057 | 400 | A legal entity assignor must have at least 1 signing representative. | Make sure at least one related party has is_representative=true. |
| ASR000011 | 400 | Duplicate related party document number. | Each document_number in related_parties must be unique. |
| ASR000041 | 400 | E-mail required for a representative. | For related parties with is_representative=true, provide email. |
| ASR000058 | 400 | A foreign person without a CPF cannot be a signer. | Foreigners without a document_number (CPF) cannot have is_representative=true. |
| ASR000071 | 404 | Financial institution not found. | Validate the financial_institution_code (bank code) provided for the account. |
| ASR000087 | 400 | Account information must contain digits only. | Send account_branch, account_number and account_digit with digits only. |
| ASR000081 | 400 | More than one default account was submitted. | Only one account may have default_account=true. |
| ASR000078 | 400 | Duplicate guarantor document number. | Each guarantor in guarantors must have a unique document_number. |
| ASR000079 | 400 | A natural person guarantor cannot have representatives. | For guarantors with person_type=natural_person, guarantor_representatives must be of the spouse type. |
| ASR000080 | 400 | Duplicate guarantor representative document. | Each representative in guarantor_representatives must have a unique document_number. |
| ASR000091 | 400 | A legal entity guarantor must have at least one representative. | For person_type=legal_person, send at least one item in guarantor_representatives. |
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.
Related Party Definition
| Field | Type | Description | Characters |
|---|---|---|---|
name * | string | Related party's name. | 1 to 255 |
document_number ** | string | Beneficiary's document number (CPF). | 14 to 18 |
passport_number ** | string | Document number of a foreign beneficiary. | 8 to 9 |
related_party_type * | string | Type of the related party's relationship. | 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 | Indicates whether 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 company linking the beneficiary to the 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's e-mail address. | 1 to 255 |
phone | object | Object referencing the representative's phone information. | See Phone Definition. |
marital_status | string | Related party's marital status. | See Marital status enumerators. |
property_system | string | Marital property system. | See Property system enumerators. |
profession | string | Related party's profession. | 1 to 255. |
*Required fields.
**document_number is required for Brazilians. For foreigners, if they have a CPF, document_number may be used; otherwise, at least passport_number must be submitted.
***Required fields when the related party is not a beneficiary directly linked to the assignor. Otherwise, they must not be submitted.
****Fields required for signing representatives only.
Non-required fields, such as marital_status and address, may be submitted if you want a more complete qualification in the master assignment contract at later stages.
Analysis Definition
| Field | Type | Description | Characters |
|---|---|---|---|
analysis_key * | string | Analysis identifier. | 36 |
analysis_number * | integer | Sequential number of the analysis. | - |
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 | Payload of the request that originated the analysis. | - |
analysis_datetime * | string | Datetime object of the analysis creation. | - |
reproval_reason | string | Enumerator with the reason the analysis was rejected. | See Rejection reason enumerators. |
reproval_details | string | Free-form field with details of the analysis rejection. | - |
*Required fields.
Analysis Related Parties Definition
| Field | Type | Description | Characters |
|---|---|---|---|
analysis_related_party_key * | string | Related party identifier. | 36 |
document_number * | string | Related party's document number. | 14 to 18 |
name * | string | Related party's name. | 1 to 255 |
documents * | array | Analysis documents of the related party. | 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 | Observations submitted. | - |
*Required fields.
Account Definition
| Field | Type | Description | Characters |
|---|---|---|---|
account_branch * | string | Branch of the assignor's account. | 4 |
account_number * | string | Number of the assignor's account. | 3 - 20 |
account_digit * | string | Digit of the assignor's account. | 1 |
financial_institution_code * | string | Bank code of the assignor's account. | 3 |
account_type * | string | Account type. | See Account type enumerators. |
default_account * | boolean | Default disbursement account. | - |
*Required fields.
Only one of the assignor's accounts can be the default account, which is the account the assignment money will be sent to when no alternative account is indicated. If more than one default account is submitted, an error is returned.
Be very careful when filling in the 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's name. | 3 - 255 |
document_number * | string | Guarantor's document number. | 14 to 18 |
person_type * | string | Guarantor's person type (natural or legal). | - |
email * | string | Guarantor's e-mail address. | 1 to 255 |
nationality | string | Guarantor's country of origin. | 3, according to ISO 3166-1 alpha-3 |
phone | object | Object referencing the guarantor's phone information. | See Phone Definition. |
address | object | Object referencing the guarantor's address information. | See Address Definition. |
guarantor_representatives | array | Guarantor's signers - for legal entity guarantors only. | See Guarantor Representative Definition. |
marital_status | string | Guarantor's marital status. | See Marital status enumerators. |
property_system | string | Marital property system. | See Property system enumerators. |
profession | string | Guarantor's profession. | 1 to 255. |
*Required fields.
The guarantor_representatives field can be used both to indicate representatives of a legal entity guarantor and, in the case of a natural person guarantor where it is necessary, the spouse, for the purposes of spousal consent.
Both the guarantor and their representatives are also added to the analysis generated, so the standard documents must be submitted according to each one's person type. They also go through the compliance process and may generate annotations.
Guarantor Representative Definition
| Field | Type | Description | Characters |
|---|---|---|---|
name * | string | Representative's name. | 3 - 255 |
document_number * | string | Document number of the guarantor's representative - necessarily a natural person. | 14 |
email * | string | E-mail address of the guarantor's representative. | 1 to 255 |
nationality | string | Country of origin of the guarantor's representative. | 3, according to ISO 3166-1 alpha-3 |
address | object | Object referencing the address information of the guarantor's representative. | See Address Definition. |
phone | object | Object referencing the phone information of the guarantor's representative. | See Phone Definition. |
marital_status | string | Marital status of the guarantor's representative. | See Marital status enumerators. |
property_system | string | Marital property system. | See Property system enumerators. |
profession | string | Profession of the guarantor's representative. | 1 to 255. |
Enumerators
Assignor Registry Status
| Enumerator | Description |
|---|---|
| pending_registry | Pending Registry |
| registered | Registered |
Analysis Status
| Enumerator | Description |
|---|---|
| pending_documents | Pending Documents |
| sent_to_analysis | Sent for Analysis |
| pending_internal_validation | Under document validation |
| in_manual_analysis | Under manual Compliance analysis |
| approved | Approved |
| reproved | Rejected |
| canceled | Canceled |
Related Party Type
| Enumerator | Description |
|---|---|
| president | President |
| partner | Partner |
| administrator | Administrator |
| director | Director |
| manager | Manager |
| attorney | Attorney-in-fact |
Document Status
| Enumerator | Description |
|---|---|
| created | Created |
| valid | Valid |
| invalid | Invalid |
| canceled | Canceled |
| accepted | Accepted, but not validated |
Document Type
| Enumerator | Description |
|---|---|
| cnh | CNH (Brazilian driver's license). |
| rg_back | RG, back side. |
| rg_front | RG, front side. |
| passport | Passport - for foreigners only. |
| national_migration_registry | National Migration Registry. |
| cin_digital | National Identity Card (Digital). |
| social_contract | Articles of Association / Bylaws. |
| cnpj_card | CNPJ card. |
| commercial_board_certificate | Simplified Certificate from the Board of Trade. |
| board_election_record | Minutes of the Election of the Current Board of Directors. |
| power_of_attorney | Power of attorney - mandatory when the representative is an attorney-in-fact. |
| marital_power_of_attorney | Spousal power of attorney - available for spouses only. |
| compliance_statement | Compliance Opinion. |
| financial_statement | Financial Statement. |
| credit_report | Credit Minutes/Opinion. |
| manager_statement | Manager's Opinion/Record. |
| visit_report | Visit Report. |
| proof_of_residence | Proof of Residence. |
| credit_agency_consulation | Credit bureau inquiry. |
| annual_revenues_declaration | Revenue Declaration. |
| financial_institutions_declaration | Banking Relationship Declaration. |
| additional_document | Additional document - free-form. |
Account Type
| Enumerator | Description |
|---|---|
| checking_account | Checking account |
Analysis Reproval Reason
| Enum | Description |
|---|---|
| assignor_update | Analysis canceled due to a subsequent registration update |
| insuficient_documents | Minimum documentation evidencing powers was not submitted |
| compliance_reproval | Relationship rejected by the compliance team's review |
| unidentified_related_parties | Related party submitted, but the relationship was not evidenced |
| invalid_documents | Invalid/expired documentation |
| missing_related_parties | Required related party not submitted |
Marital Status
| Enum | Description |
|---|---|
| single | Single |
| married | Married |
| widower | Widowed |
| divorced | Divorced |
| separated | Separated |
| stable_union | In a stable union |
Property System
| Enum | Description |
|---|---|
| total_communion_of_goods | Full community of property |
| partial_communion_of_goods | Partial community of property |
| total_separation_of_goods | Full separation of property |
| final_participation_of_acquisitions | Final participation in acquisitions |
| compulsory_separation_of_goods | Compulsory separation of property |