Skip to main content

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.

Information

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.

Sandbox

In sandbox, the analysis result depends on the first digit of the assignor's document (document_number): starting with 1, automatic rejection; starting with 8, the analysis goes to manual validation (pending_internal_validation); all others are approved automatically.


Assignor Registration​

Available on
ProfileHostRequired permission
Managermanager-apiWrite
Consultantconsultant-apiRegister Assignor
Assignorassignor-apiWrite

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/assignor_registry/assignor_registry
METHOD
POST
Request Body
{
"name": "Cedente Exemplo LTDA",
"document_number": "55.666.777/0001-81",
"person_type": "legal_person",
"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",
"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": "969.698.790-03",
"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": "Avalista PF",
"address": {
"street": "Rua Maria Carolina",
"number": "624",
"neighborhood": "Jardim Paulistano",
"city": "São Paulo",
"postal_code": "01445-000",
"uf": "SP",
"country": "BRA"
},
"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",
"address": {
"street": "Rua Maria Carolina",
"number": "624",
"neighborhood": "Jardim Paulistano",
"city": "São Paulo",
"postal_code": "01445-000",
"uf": "SP",
"country": "BRA"
}
}
]
}
]
}

Assignor Definition​

FieldTypeDescriptionCharacters
name *stringAssignor's name.1 to 255
document_number *stringAssignor's CPF or CNPJ, formatted (000.000.000-00 or 00.000.000/0000-00).14 to 18
annual_revenues *numberAssignor's declared annual revenue, as an integer.Minimum of 1
person_type *stringnatural_person (natural person) or legal_person (legal entity).-
email *stringAssignor's e-mail address.1 to 255
is_in_national_financial_system *booleanIndicates whether the assignor is part of the Brazilian National Financial System (SFN).-
phoneobjectObject referencing the assignor's phone information.See Phone Definition.
address *objectObject referencing the assignor's address information.See Address Definition.
related_parties **arrayList of the company's related parties.See Related Party Definition.
accountsarrayList of the assignor's disbursement accounts. Without an account, it is not possible to propose an assignment contract.See Account Definition.
guarantorsarrayList of the assignor's guarantors.See Guarantor Definition.
minimum_required_signersintegerMinimum number of representatives who must sign on behalf of the assignor.Minimum of 1

*Required fields.

**Required for legal entities, with at least one signing representative (is_representative: true).

Response​

STATUS
201
Response Body
{
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_registry",
"name": "Cedente Exemplo LTDA",
"document_number": "55.666.777/0001-81",
"related_parties": [
{
"related_party_key": "0b6f6a52-6c1e-4f4e-9d2a-1f3c5e7a9b10",
"name": "Natália Nascimento",
"document_number": "123.456.789-09",
"direct_beneficiary": true,
"is_representative": true,
"related_party_type": "attorney"
},
{
"related_party_key": "3e9d1c7b-2a4f-4b8e-8c6d-5f7a9b1c3d20",
"name": "Maria Vitoria",
"document_number": null,
"direct_beneficiary": true,
"is_representative": false,
"related_party_type": "president",
"passport_number": "C01X00T47"
},
{
"related_party_key": "7a2c4e6f-8b0d-4f1a-9c3e-5d7f9a1b3c30",
"name": "Roberto Carlos",
"document_number": "969.698.790-03",
"direct_beneficiary": false,
"is_representative": false,
"related_party_type": "director"
}
],
"last_analysis": {
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 1,
"status": "pending_documents",
"analysis_datetime": "2026-01-15T14:32:10Z",
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"name": "Roberto Carlos",
"document_number": "969.698.790-03",
"analysis_roles": [{ "related_party_type": "director" }],
"documents": []
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"name": "Natália Nascimento",
"document_number": "123.456.789-09",
"analysis_roles": [{ "related_party_type": "attorney" }],
"documents": []
},
{
"analysis_related_party_key": "8a3e2f61-0c4b-4d7e-9f15-2b6c7d8e9a01",
"name": "Maria Vitoria",
"document_number": null,
"analysis_roles": [{ "related_party_type": "president" }],
"documents": [],
"passport_number": "C01X00T47"
},
{
"analysis_related_party_key": "1f4b6d8a-3c5e-4a7b-9d1f-2e4a6c8b0d40",
"name": "Avalista PF",
"document_number": "222.333.444-05",
"analysis_roles": [{ "related_party_type": "guarantor" }],
"documents": []
},
{
"analysis_related_party_key": "9c1e3a5b-7d9f-4b2c-8e4a-6f8b0c2d4e50",
"name": "Avalista PJ",
"document_number": "22.333.444/0001-81",
"analysis_roles": [{ "related_party_type": "guarantor" }],
"documents": []
},
{
"analysis_related_party_key": "4d6f8b0c-2e4a-4c6d-8f0b-1a3c5e7d9f60",
"name": "Assinante do Avalista",
"document_number": "111.444.777-35",
"analysis_roles": [{ "related_party_type": "guarantor_representative" }],
"documents": []
}
],
"documents": [],
"annotations": [],
"last_updated": "2026-01-15T14:32:10Z",
"analysis_origin_type": "assignor_registry",
"reproval_reason": null,
"reproval_details": null
}
}
FieldTypeDescriptionCharacters
assignor_registry_keystringRegistration identifier.36
statusstringRegistration status.See Registration status enumerators.
namestringAssignor's name.1 to 255
document_numberstringAssignor's document.14 to 18
related_partiesarrayAssignor's related parties, with related_party_key, name, document_number, direct_beneficiary, is_representative, related_party_type and, for foreigners, passport_number.-
last_analysisobjectAnalysis object.See Analysis Definition.
info

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.

info

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.

info

Representatives of a natural person are limited to the attorney-in-fact who can sign on their behalf.


Definitions​

Address Definition​

FieldTypeDescriptionCharacters
street *stringStreet name.1 to 255
number *stringAddress number.1 to 4
neighborhood *stringNeighborhood.1 to 255
city *stringCity.1 to 255
uf *stringState abbreviation.2
complementstringAddress complement.1 to 255
postal_code *stringPostal code.9 (format: XXXXX-XXX)
country *stringCountry (abbreviation).3, according to ISO 3166-1 alpha-3

*Required fields.


Phone Definition​

FieldTypeDescriptionCharacters
international_dial_code *stringInternational dialing code.1 to 3
area_code *stringArea code.2
number *stringPhone number.8 to 9

*Required fields.


FieldTypeDescriptionCharacters
name *stringRelated party's name.1 to 255
document_number **stringBeneficiary's document number (CPF).14 to 18
passport_number **stringDocument number of a foreign beneficiary.8 to 9
related_party_type *stringType of the related party's relationship.See Related party type enumerators
nationality *stringBeneficiary's country of origin.3, according to ISO 3166-1 alpha-3
direct_beneficiary *booleanBeneficiary directly or indirectly linked to the assignor.1 to 255
is_representative *booleanIndicates whether the related party is a signing representative of the assignor.1 to 255
company_registry_number ***stringIf not directly linked to the assignor, which company they are linked to.1 to 255
company_country ***stringCountry where the company linking the beneficiary to the assignor is registered.3, according to ISO 3166-1 alpha-3
addressobjectObject referencing the representative's address information.See Address Definition.
email ****stringRepresentative's e-mail address.1 to 255
phoneobjectObject referencing the representative's phone information. Recommended for signing representatives.See Phone Definition.
marital_statusstringRelated party's marital status.See Marital status enumerators.
property_systemstringMarital property system.See Property system enumerators.
professionstringRelated 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.

****Field required for signing representatives only.

info

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​

FieldTypeDescriptionCharacters
analysis_key *stringAnalysis identifier.36
analysis_number *integerSequential number of the analysis.-
status *stringAnalysis status.See Analysis status enumerators.
analysis_related_parties *arrayAnalysis related parties.See Analysis Related Parties Definition.
documents *arrayAnalysis documents.See Document Definition.
analysis_datetime *stringDate and time the analysis was created (ISO 8601, UTC).-
annotations *arrayAnalysis annotations.-
last_updated *stringDate and time of the analysis's last change (ISO 8601, UTC).-
analysis_origin_type *stringOrigin of the analysis. For registrations submitted through the API, assignor_registry.-
analysis_dataobjectRequest body that originated the analysis. Returned only by the analysis query, not in the registration response.-
reproval_reasonstringEnumerator with the reason the analysis was rejected.See Rejection reason enumerators.
reproval_detailsstringFree-form field with details of the analysis rejection.-

*Required fields.


FieldTypeDescriptionCharacters
analysis_related_party_key *stringRelated party identifier.36
document_number *stringRelated party's document number.14 to 18
name *stringRelated party's name.1 to 255
passport_numberstringPassport, only for foreigners who provided one.-
analysis_roles *arrayThe person's roles in the analysis, each with a related_party_type (for example, director, guarantor or guarantor_representative).-
documents *arrayAnalysis documents of the related party.See Document Definition.

*Required fields.


Document Definition​

FieldTypeDescriptionCharacters
document_key *stringDocument identifier.36
document_type *stringDocument type.See Document type enumerators.
statusstringDocument status.See Document status enumerators.
observationstringObservations submitted.-

*Required fields.


Account Definition​

FieldTypeDescriptionCharacters
account_branch *stringBranch of the assignor's account.4
account_number *stringNumber of the assignor's account. Digits only.3 - 20
account_digit *stringDigit of the assignor's account.1
financial_institution_code *stringBank code of the assignor's account.3
account_type *stringAccount type.See Account type enumerators.
default_account *booleanDefault disbursement account.-
descriptionstringFree-form description of the account.Up to 255

*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.

Attention

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​

FieldTypeDescriptionCharacters
name *stringGuarantor's name.3 - 255
document_number *stringGuarantor's document number.14 to 18
person_type *stringGuarantor's person type (natural or legal).-
email *stringGuarantor's e-mail address.1 to 255
nationalitystringGuarantor's country of origin.3, according to ISO 3166-1 alpha-3
phoneobjectObject referencing the guarantor's phone information.See Phone Definition.
addressobjectObject referencing the guarantor's address information.See Address Definition.
guarantor_representativesarrayRepresentatives of a legal entity guarantor, or the spouse of a natural person guarantor.See Guarantor Representative Definition.
marital_statusstringGuarantor's marital status.See Marital status enumerators.
property_systemstringMarital property system.See Property system enumerators.
professionstringGuarantor'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.

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​

FieldTypeDescriptionCharacters
name *stringRepresentative's name.3 - 255
document_number *stringDocument number of the guarantor's representative - necessarily a natural person.14
email *stringE-mail address of the guarantor's representative.1 to 255
nationalitystringCountry of origin of the guarantor's representative.3, according to ISO 3166-1 alpha-3
addressobjectObject referencing the address information of the guarantor's representative.See Address Definition.
phoneobjectObject referencing the phone information of the guarantor's representative.See Phone Definition.
marital_statusstringMarital status of the guarantor's representative.See Marital status enumerators.
property_systemstringMarital property system.See Property system enumerators.
professionstringProfession of the guarantor's representative.1 to 255.
related_party_typestringguarantor_representative (default) for a representative of a legal entity guarantor; spouse for the spouse of a natural person guarantor (spousal consent).-

Enumerators​

Assignor Registry Status​

EnumeratorDescription
createdCreated (transient)
pending_registryPending Registry
pending_manual_approvalPending manual approval by QI DTVM
registeredRegistered
rejectedRejected
blockedBlocked

Analysis Status​

EnumeratorDescription
createdCreated (transient)
pending_documentsPending Documents
sent_to_analysisSent for Analysis
pending_internal_validationUnder document validation
in_manual_analysisUnder manual Compliance analysis
in_risk_analysisUnder Risk analysis
approvedApproved
reprovedRejected
canceledCanceled

EnumeratorDescription
presidentPresident
partnerPartner
administratorAdministrator
directorDirector
managerManager
attorneyAttorney-in-fact
spouseSpouse
legal_representativeLegal representative

Document Status​

EnumeratorDescription
createdCreated
validValid
invalidInvalid
canceledCanceled
acceptedAccepted, but not validated
inconclusiveInconclusive validation

Document Type​

EnumeratorDescription
cnhCNH (Brazilian driver's license).
rg_backRG, back side.
rg_frontRG, front side.
passportPassport - for foreigners only.
national_migration_registryNational Migration Registry.
national_registry_of_foreignersNational Registry of Foreigners.
cin_digitalNational Identity Card (Digital).
social_contractArticles of Association / Bylaws.
cnpj_cardCNPJ card.
commercial_board_certificateSimplified Certificate from the Board of Trade.
board_election_recordMinutes of the Election of the Current Board of Directors.
power_of_attorneyPower of attorney - mandatory when the representative is an attorney-in-fact.
marital_power_of_attorneySpousal power of attorney - available for spouses only.
compliance_statementCompliance Opinion.
financial_statementFinancial Statement.
credit_reportCredit Minutes/Opinion.
manager_statementManager's Opinion/Record.
visit_reportVisit Report.
proof_of_residenceProof of Residence.
credit_agency_consulationCredit bureau inquiry.
annual_revenues_declarationRevenue Declaration.
financial_institutions_declarationBanking Relationship Declaration.
additional_documentAdditional document - free-form.

Account Type​

EnumeratorDescription
checking_accountChecking account
saving_accountSavings account
escrow_accountEscrow account

Analysis Reproval Reason​

EnumDescription
assignor_updateAnalysis canceled due to a subsequent registration update
insuficient_documentsMinimum documentation evidencing powers was not submitted
compliance_reprovalRelationship rejected by the compliance team's review
unidentified_related_partiesRelated party submitted, but the relationship was not evidenced
invalid_documentsInvalid/expired documentation
missing_related_partiesRequired related party not submitted
risk_analysis_reprovalRejected in the risk analysis

Marital Status​

EnumDescription
singleSingle
marriedMarried
widowerWidowed
divorcedDivorced
separatedSeparated
stable_unionIn a stable union

Property System​

EnumDescription
total_communion_of_goodsFull community of property
partial_communion_of_goodsPartial community of property
total_separation_of_goodsFull separation of property
final_participation_of_acquisitionsFinal participation in acquisitions
compulsory_separation_of_goodsCompulsory separation of property

Errors​

StatusCodeWhen it happens
409ASR000032This agent has already registered this assignor. The document_number already has a registration; use the registration update flow.
400ASR000054A legal entity assignor must have at least 1 related party. Include at least one related party in related_parties.
400ASR000056A natural person cannot be part of the National Financial System. For person_type=natural_person, send is_in_national_financial_system=false.
400ASR000057A legal entity assignor must have at least 1 signing representative. Make sure at least one related party has is_representative=true.
400ASR000011Duplicate related party document number. Each document_number in related_parties must be unique.
400ASR000041Related party with is_representative=true without email. Provide the representative's e-mail.
400ASR000058A foreign person without a CPF cannot be a signer. Foreigners without a document_number (CPF) cannot have is_representative=true.
404ASR000071Financial institution not found. Validate the financial_institution_code (bank code) provided for the account.
400ASR000087Account information must contain digits only. Send account_branch, account_number and account_digit with digits only.
400ASR000081More than one default account was submitted. Only one account may have default_account=true.
400ASR000078Duplicate guarantor document number. Each guarantor in guarantors must have a unique document_number.
400ASR000079A natural person guarantor does not accept representatives. For person_type=natural_person, only the spouse is accepted: related_party_type: spouse.
400ASR000080Duplicate guarantor representative document. Each representative in guarantor_representatives must have a unique document_number.
400ASR000091A 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.