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.

Notice

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.

info

If an analysis is in progress and a registration update is submitted, the last open analysis is automatically closed and rejected, with the reason "assignor_update".

---

Registration Update for a Legal Entity Assignor

Request

ENDPOINT

/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY

METHOD

PUT

Request Body

{
  "email": "qidtvm@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",
      "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": true,
      "email": "roberto.carlos@yopmail.com",
      "phone": {
        "international_dial_code": "+64",
        "area_code": "11",
        "number": "936360268"
      }
    }
  ],
  "guarantors": [
    {
      "name": "Natural person guarantor",
      "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"
        }
      ]
    },
  ]
}

---

Assignor Definition

Field	Type	Description	Characters
annual_revenues	number	Assignor's declared annual revenue.	-
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.
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

STATUS

200

Response Body

{
  "assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
  "status": "registred",
  "name": "QI Tech",
  "document_number": "32.402.502/0001-35",
  "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": "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.

info

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.

---

Attention!

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.

Important!

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);

Treatable Errors

Code	HTTP	Cause	How to resolve
ASR000004	404	Assignor not found for the assignor_registry_key provided.	Check whether the assignor_registry_key exists and belongs to the authenticated agent.
ASR000100	400	The field submitted cannot be updated on a branch.	For branches, only email, phone, address and annual_revenues can be updated. To change name, is_in_national_financial_system, related_parties or guarantors, update the parent company's registration.
ASR000056	400	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.
ASR000054	400	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.
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.
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.	Do not send guarantor_representatives for guarantors with person_type=natural_person.
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

*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, and passport_number for foreigners.

***Required fields when the related party is not a beneficiary directly linked to the assignor.

****Fields required for signing representatives only.

---

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.

---

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.

Guarantor representatives must be submitted only for legal entity guarantors.

Attention

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.

---

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.

---

Analysis Related Parties Definition

Field	Type	Description	Characters
analysis_representative_key *	string	Representative identifier.	36
document_number *	string	Representative's document number.	14 to 18
name	string	Beneficiary's name.	1 to 255
documents *	enumerator	Analysis documents of the representative.	See Document Definition.

*Required fields.

---

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.

---

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