Registration update
It is the manager's responsibility to keep the assignors' data up to date, in line with the company's current situation. This commitment is extremely important, both to keep the AML analyses current and to update the signer groups, which change constantly and expire, requiring a new analysis. In addition, every 2 years a new analysis is generated automatically to ensure they are periodically updated.
It is the manager's responsibility to keep the assignor's data up to date and reflecting the company's reality.
When updating a registration, regardless of which field is changed, a new analysis is generated, which will require new documents according to the changes made. Analyses follow a sequence and may fail several times until they are finally approved by compliance. The changes are only applied after the analysis is successfully concluded. If the related parties change, there will be a stage validating the assignor's signer groups. Note that if a related party or a guarantor is NOT submitted, it is considered DELETED.
If an analysis is in progress when the registration update is submitted, it is canceled automatically (analysis_status: canceled, with reproval_details indicating the registration update) and a new analysis is generated.
Registration Update for a Legal Entity Assignor
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Register Assignor |
| Assignor | assignor-api | Write |
Base URL for each host: Environments (Hosts).
Request
{
"email": "financeiro@cedente-exemplo.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": "123.456.789-09",
"related_party_type": "attorney",
"nationality": "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": "969.698.790-03",
"related_party_type": "director",
"nationality": "BRA",
"direct_beneficiary": false,
"company_country": "NZL",
"company_registry_number": "4984037284610",
"is_representative": true,
"email": "roberto.carlos@yopmail.com",
"phone": {
"international_dial_code": "+64",
"area_code": "11",
"number": "936360268"
}
}
],
"guarantors": [
{
"name": "Avalista PF",
"document_number": "222.333.444-05",
"person_type": "natural_person",
"email": "email@avalista.com"
},
{
"name": "Avalista PJ",
"document_number": "22.333.444/0001-81",
"person_type": "legal_person",
"email": "email@avalista.com",
"guarantor_representatives": [
{
"name": "Assinante do Avalista",
"document_number": "111.444.777-35",
"email": "emailrepresentante@avalista.com"
}
]
}
]
}
Assignor Definition
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Assignor's name/corporate name. | 1 to 255 |
annual_revenues | integer | Assignor's declared annual revenue, as an integer. | Minimum of 1 |
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. |
minimum_required_signers | integer | Minimum number of representatives who must sign on behalf of the assignor. | Minimum of 1 |
guarantors | array | List of the assignor's guarantors. | See Guarantor Definition. |
If you do not wish to change a field, simply do not send it in the request. For lists, as is the case with related_parties and guarantors, sending an empty list — or omitting a party that was previously in the list — is treated as a deletion.
Response
{
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "registered",
"name": "Cedente Exemplo LTDA",
"document_number": "55.666.777/0001-81",
"last_analysis": {
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 2,
"status": "pending_documents",
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"document_number": "969.698.790-03",
"name": "Roberto Carlos",
"documents": []
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"document_number": "123.456.789-09",
"name": "Natália Nascimento",
"documents": []
},
{
"analysis_related_party_key": "8a3e2f61-0c4b-4d7e-9f15-2b6c7d8e9a01",
"passport_number": "C01X00T47",
"name": "Maria Vitoria",
"documents": []
}
],
"documents": [
{
"document_key": "994621ac-7d3f-4f6b-90c5-74a4d8c5d017",
"document_type": "social_contract",
"status": "valid"
}
]
}
}
| 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 analysis_key and the analysis_related_party_key values, which are used to submit the assignor's and the related parties' documents.
When updating an assignor's registration, a new registration analysis is generated, resulting in a new analysis_key and new analysis_related_party_key values. The registration is only effectively updated after this new analysis is approved.
It is not possible to update essential assignor data such as Document Number and Person Type. The registration data that can be changed includes:
- Name/Corporate name;
- E-mail;
- Address;
- Phone;
- Revenue;
- SFN participant;
- Related parties (adding and changing existing ones);
- Guarantors (adding and changing existing ones);
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key exists (or, for the manager and the consultant, whether the registration belongs to your integration). |
| 400 | ASR000100 | The field submitted cannot be updated on a branch: name, related_parties and guarantors are always those of the parent company. To change them, update the parent company's registration. |
| 400 | ASR000128 | A branch linked to this parent company has an analysis in progress. Wait for the branch's analysis to conclude and resubmit the parent company's update. |
| 400 | ASR000056 | A natural person cannot be part of the National Financial System. For natural person assignors, send is_in_national_financial_system=false or omit the field. |
| 400 | ASR000054 | A legal entity assignor must have at least 1 related party. Make sure related_parties (after the update) has at least one item for legal entity assignors. |
| 400 | ASR000057 | A legal entity assignor must have at least 1 signing representative. Make sure at least one related party has is_representative=true. |
| 400 | ASR000011 | Duplicate related party document number. Each document_number in related_parties must be unique. |
| 400 | ASR000041 | E-mail required for a representative. For related parties with is_representative=true, provide email. |
| 400 | ASR000058 | A foreign person without a CPF cannot be a signer. Foreigners without a document_number (CPF) cannot have is_representative=true. |
| 400 | ASR000078 | Duplicate guarantor document number. Each guarantor in guarantors must have a unique document_number. |
| 400 | ASR000079 | A natural person guarantor does not accept representatives. For person_type=natural_person, only the spouse is accepted: related_party_type: spouse. |
| 400 | ASR000080 | Duplicate guarantor representative document. Each representative in guarantor_representatives must have a unique document_number. |
| 400 | ASR000091 | A legal entity guarantor must have at least one representative. For person_type=legal_person, send at least one item in guarantor_representatives. |
Authentication, permission and host errors: see API Errors.