Consulta de análise
Esta página cobre a consulta da análise e o download dos documentos anexados a ela, do cedente e das partes relacionadas.
O campo status da análise segue os Enumeradores de status de análise.
canceledUma análise que fica 1 mês sem movimentação — tipicamente parada em pending_documents, sem documentos anexados ou sem o disparo da análise — é cancelada automaticamente e passa a canceled. O status é terminal: a análise não aceita mais documentos nem disparo. Para retomar o cadastro, gere uma nova análise por meio da Atualização de Cadastro.
Consulta de Análise Por Chave
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Ler Cedentes |
| Cedente | assignor-api | Leitura |
URL base de cada host: Ambientes (Hosts).
Request
Response
{
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 1,
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_documents",
"documents": [
{
"document_key": "994621ac-7d3f-4f6b-90c5-74a4d8c5d017",
"document_type": "social_contract",
"status": "valid"
}
],
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"document_number": "969.698.790-03",
"name": "Roberto Carlos",
"documents": [
{
"document_key": "72bad379-dbe6-40ca-97f2-1181257889ba",
"document_type": "cnh",
"status": "valid"
}
]
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"document_number": "123.456.789-09",
"name": "Natália Nascimento",
"documents": [
{
"document_key": "8b9fe448-7ad7-4410-b8f7-5c920b07b9a7",
"document_type": "cnh",
"status": "valid"
}
]
}
],
"analysis_data": {
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_registry",
"name": "Cedente Exemplo LTDA",
"document_number": "33.344.455/0001-83",
"person_type": "legal_person",
"email": "financeiro@cedente-exemplo.com.br",
"phone": {
"number": "936360268",
"area_code": "11"
},
"address": {
"uf": "SP",
"city": "São Paulo",
"number": "215",
"street": "Gilberto Sabino",
"country": "BRA",
"postal_code": "05425-020",
"neighborhood": "Pinheiros"
},
"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"
}
}
]
}
}
Consulta Paginada de Análises
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Ler Cedentes |
| Cedente | assignor-api | Leitura |
URL base de cada host: Ambientes (Hosts).
Request
Query params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
limit | integer | Itens por página. Padrão 10, máximo 50. Acima do máximo, a API devolve 400 | - |
page | integer | Página, começando em 0. Use is_last_page da resposta para saber quando parar | - |
Response
{
"data": [
{
"analysis_key": "d7805a05-98a7-486b-a440-807f1d3d5691",
"analysis_number": 1,
"assignor_registry_key": "c4295375-4077-4092-a258-5bcdf8875907",
"status": "pending_documents",
"documents": [
{
"document_key": "994621ac-7d3f-4f6b-90c5-74a4d8c5d017",
"document_type": "social_contract",
"status": "valid"
}
],
"analysis_related_parties": [
{
"analysis_related_party_key": "5cdcc13b-c67d-45f3-aa66-36cb4f178b59",
"document_number": "969.698.790-03",
"name": "Roberto Carlos",
"documents": [
{
"document_key": "72bad379-dbe6-40ca-97f2-1181257889ba",
"document_type": "cnh",
"status": "valid"
}
]
},
{
"analysis_related_party_key": "d4c75c93-4aa9-4567-89c4-b49334927721",
"document_number": "123.456.789-09",
"name": "Natália Nascimento",
"documents": [
{
"document_key": "8b9fe448-7ad7-4410-b8f7-5c920b07b9a7",
"document_type": "cnh",
"status": "valid"
}
]
}
]
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
Download de Documento do Cedente
Retorna um documento anexado à análise do cedente, com uma URL temporária para baixar o arquivo. O document_key vem do array documents da Consulta de Análise Por Chave.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Ler Cedentes |
| Cedente | assignor-api | Leitura |
URL base de cada host: Ambientes (Hosts).
Request
Response
{
"document_key": "994621ac-7d3f-4f6b-90c5-74a4d8c5d017",
"document_type": "social_contract",
"status": "valid",
"observation": null,
"reference_date": null,
"document_url": "https://URL_TEMPORARIA_DO_DOCUMENTO"
}
| Campo | Tipo | Descrição |
|---|---|---|
document_key | string | Identificador do documento. |
document_type | string | Tipo do documento. Ver Enumeradores de tipo de documento. |
status | string | Status do documento. Ver Enumeradores de status de documento. |
observation | string | Observação registrada no documento. null quando não há. |
reference_date | string | Data de referência do documento (YYYY-MM-DD). null quando não há. |
document_url | string | URL pré-assinada para baixar o arquivo. |
A document_url vale 10 minutos. Baixe o arquivo logo depois da consulta e não guarde a URL: para baixar de novo, consulte o documento outra vez e use a URL nova.
Download de Documento de Parte Relacionada
Retorna um documento anexado a uma parte relacionada da análise (sócio, administrador, procurador etc.), com uma URL temporária para baixar o arquivo. O analysis_related_party_key e o document_key vêm do array analysis_related_parties da Consulta de Análise Por Chave.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Ler Cedentes |
| Cedente | assignor-api | Leitura |
URL base de cada host: Ambientes (Hosts).
Request
Response
{
"document_key": "72bad379-dbe6-40ca-97f2-1181257889ba",
"document_type": "cnh",
"status": "valid",
"observation": null,
"document_url": "https://URL_TEMPORARIA_DO_DOCUMENTO"
}
| Campo | Tipo | Descrição |
|---|---|---|
document_key | string | Identificador do documento. |
document_type | string | Tipo do documento. Ver Enumeradores de tipo de documento. |
status | string | Status do documento. Ver Enumeradores de status de documento. |
observation | string | Observação registrada no documento. null quando não há. |
document_url | string | URL pré-assinada para baixar o arquivo. |
A document_url vale 10 minutos. Baixe o arquivo logo depois da consulta e não guarde a URL: para baixar de novo, consulte o documento outra vez e use a URL nova.
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | ASR000004 | Cedente não encontrado para o assignor_registry_key informado. Verificar se a chave está correta (ou, para gestora e consultoria, se o cadastro pertence à sua integração). No download de documento de parte relacionada, também quando o analysis_key não existe. |
| 404 | ASR000033 | Análise não encontrada para o analysis_key informado, ou a análise não pertence ao cedente. Verificar o analysis_key. |
| 404 | ASR000006 | Download de documento do cedente: documento não encontrado na análise informada. Verificar o document_key. |
| 404 | ASR000035 | Download de documento de parte relacionada: parte relacionada não encontrada no cadastro do cedente. Verificar o analysis_related_party_key. |
| 404 | ASR000036 | Download de documento de parte relacionada: documento não encontrado para a parte relacionada informada. Verificar o document_key. |
Erros de autenticação, permissão e host: veja Erros da API.