Analysis query
The analysis status field follows the Analysis status enumerators.
canceled statusAn analysis that goes 1 month without activity — typically stuck in pending_documents, with no documents attached or without the analysis being triggered — is canceled automatically and moves to canceled. The status is terminal: the analysis no longer accepts documents or triggering. To resume the registration, generate a new analysis through Registration Update.
Analysis Query by Key
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | View Assignors |
| Assignor | assignor-api | Read |
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/analysis/ANALYSIS_KEYMETHOD
GETResponse
STATUS
200Response Body
{
"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"
}
}
]
}
}
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key is correct (or, for the manager and the consultant, whether the registration belongs to your integration). |
| 404 | ASR000033 | Analysis not found for the analysis_key provided. Check whether the analysis_key is correct. |
Authentication, permission and host errors: see API errors.
Paginated Analysis Query
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Read |
| Consultant | consultant-api | View Assignors |
| Assignor | assignor-api | Read |
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/assignor_registry/assignor_registry/ASSIGNOR_REGISTRY_KEY/analysesMETHOD
GETQuery params
| Field | Type | Description | Characters |
|---|---|---|---|
limit | integer | Items per page. Default 10, maximum 50. Above the maximum, the API returns 400 | - |
page | integer | Page, starting at 0. Use is_last_page from the response to know when to stop | - |
Response
STATUS
200Response Body
{
"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
}
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key is correct (or, for the manager and the consultant, whether the registration belongs to your integration). |
Authentication, permission and host errors: see API errors.