Pular para o conteúdo principal

Consulta de Cedente


Consulta Assinantes do Cedente

Request

ENDPOINT
/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/signers
MÉTODO
GET

Response

Response Body
{
"signer_groups": [
{
"signers": [
{
"name": "Natália Nascimento",
"document_number": "883.512.866-80",
"email": "natalia.nascimento@yopmail.com",
"is_required_signer": true,
},
{
"name": "Roberto Carlos",
"document_number": "802.834.257-41",
"email": "roberto.carlos@yopmail.com",
"is_required_signer": true,
}
],
"minimum_required_signers": 2,
"expiration": "2025-10-20"
},
{
"signers": [
{
"name": "Roberto Carlos",
"document_number": "802.834.257-41",
"email": "roberto.carlos@yopmail.com",
"is_required_signer": true,
}
],
"minimum_required_signers": 1,
}
]
}

Objeto Grupo de Assinantes

CampoTipoDescriçãoCaracteres
signersarrayIdentificação dos assinantes do grupo.-
minimum_required_signersnumberNúmero de assinantes mínimo do grupo para considerar o documento assinado.-
expirationdateData de expiração do grupo de assinantes, opicional.10 (Formato: YYYY-MM-DD)

Os grupos de assinantes são montados internamente, de acordo com a análise dos documentos enviados, e vínculos comprovados entre os representantes e o cedente.


Consulta de Cedente Específico

Request

ENDPOINT
/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY
MÉTODO
GET

Response

STATUS
200
Response Body
{
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "registred",
"name": "QI DTVM",
"document_number": "67.987.787/0001-06",
"person_type": "legal_person",
"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"
}
}
],
"last_analysis": {
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 1,
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_documents",
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"document_number": "802.834.257-41",
"name": "Natália Nascimento",
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"document_number": "883.512.866-80",
"name": "Natália Nascimento",
}
],
"documents": [],
"analysis_data": {}
}
}

Objeto Cadastro de Cedente

CampoTipoDescriçãoCaracteres
assignor_registry_keystringIdentificador do cadastro.36
statusenumeradorStatus do cadastro.14 a 18
namestringNome do cedente.1 a 255
document_numberstringNúmero de documento do cedente (CNPJ).14 a 18
annual_revenuesnumberDeclaração de faturamento anual do cedente.-
person_typestringTipo de pessoa (física ou jurídica) do cedente.1 a 255
emailstringEndereço de e-mail do cedente.1 a 255
is_in_national_financial_systembooleanIndicador se o cedente é integrante do SFN.-
phoneobjectObjeto referenciando as informações do telefone do cedente.Ver Definição de Telefone.
addressobjectObjeto referenciando as informações do endereço do cedente.Ver Definição de Endereço.
related_partiesarrayLista de partes relacionadas da empresa.Ver Definição de Parte Relacionada.

Consulta Paginada de Cedentes

Request

ENDPOINT
/assignor_registry/assignor_registries
MÉTODO
GET

Path params

CampoTipoDescriçãoCaracteres
namestringNome do cedente1-255
document_numberstringNúmero de documento do cedente1-18
assignor_registry_statusstringStatus do cedente1-255
analysis_statusstringStatus da análise mais recente1-255
limitintegerLimite de objetos-
pageintegerPágina desejada-

Response

STATUS
200
Response Body
{
"data": [
{
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "registred",
"name": "QI DTVM",
"document_number": "67.987.787/0001-06",
"person_type": "legal_person",
"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": "49.846.582/0001-10",
"is_representative": true,
"email": "roberto.carlos@yopmail.com",
"phone": {
"international_dial_code": "+64",
"area_code": "11",
"number": "936360268"
}
}
],
"last_analysis": {
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 1,
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_documents",
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"document_number": "802.834.257-41",
"name": "Natália Nascimento",
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"document_number": "883.512.866-80",
"name": "Natália Nascimento",
}
],
"documents": [],
"analysis_data": {}
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true,
}