Obtaining Case Result
This guide explains how to obtain case results via the API.
A case may contain one or more conversations (dialogs). While you can retrieve results for an individual conversation using the Get Conversation Result endpoint, you can also obtain results for the entire case.
The case result includes:
- detailed information about the company
- results for each completed conversation within the case.
The case result is available only for the closed (approved/rejected/archived) cases. The case state is changed via the Case Manager Web UI.
To retrieve the case result, call GET /api/v1/cases/{case_id}/result, passing case_id of the completed case. Since generating the results may take some time, you may receive the following response if the results are not yet ready:
{
"case_id": "...",
"status": "not_ready"
}You can continue polling every few seconds until the results are ready. Once they are available, the response will look like this:
{
"case_id": "1ff00dec-bfa6-45c4-9b9d-1e2d4fd7f64e",
"status": "ready",
"result": {
"conversation_results": [
{
"case_id": "1ff00dec-bfa6-45c4-9b9d-1e2d4fd7f64e",
"conversation_id": "6db45393-18b2-4e95-bc3e-a206b1869354",
"web_report_link": "...",
"pdf_report_link": "...",
"client_documents": [
{
"document_id": "7473be27-ecad-4a30-8b99-e45bb7ce1473",
"document_type": "shareholders_registrar_extract",
"document_name": "Shareholders Registrar Extract",
"rejected": false,
"translated": false,
"download_link": "...",
"original_files": [],
"extracted_data": {},
"entity_id": "691307d6-351b-4aa0-a0b9-a63f600e12ce"
}
],
"conversation_log": [],
"legal_entities": null
},
{
"case_id": "1ff00dec-bfa6-45c4-9b9d-1e2d4fd7f64e",
"conversation_id": "84733c92-c2a2-4b72-9071-43205c418e7c",
"web_report_link": "...",
"pdf_report_link": "...",
"client_documents": [
{
"document_id": "b38789e6-bda9-46b8-8a7b-2ce73702fcd6",
"document_type": "business_license",
"document_name": "Business License",
"rejected": false,
"translated": false,
"download_link": "...",
"original_files": [],
"extracted_data": {},
"entity_id": "7a99e628-6132-4659-832e-6bb94f634fa3"
}
],
"conversation_log": [],
"legal_entities": null
}
],
"main_entity_id": "691307d6-351b-4aa0-a0b9-a63f600e12ce",
"account_owner_entity_ids": [
"ea3a964d-95fe-4b1a-bfb4-97f65c5fc629"
],
"legal_entities": [
{
"entity_id": "691307d6-351b-4aa0-a0b9-a63f600e12ce",
"entity_details": {
"type": "company",
"entity_id": "691307d6-351b-4aa0-a0b9-a63f600e12ce",
"company_full_name": "...",
"incorporation_date": "2021-01-01",
"company_status": "Active",
"company_country_code": "GB",
"company_website": {
"url": "https://example.com/"
},
"company_reg_number": "12345678",
"tax_residency_country_code": "GB",
"tax_residence_number": "12345678",
"vat_number": "GB12345678",
"legal_address": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"legal_address_translated": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"operational_address": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"operational_address_translated": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"registered_industry_codes": [
{
"classification": "UKSIC2007",
"code": "01120"
},
{
"classification": "NACE",
"code": "A1.1.2"
}
],
"auto_assigned_industry_codes": [
{
"classification": "UKSIC2007",
"code": "01120"
},
{
"classification": "NACE",
"code": "A1.1.2"
}
],
"shareholders": [
{
"entity_id": "e092c3ef-76e3-4947-9dd4-bf87a39e7faa",
"ownership": {
"range": [
0.25,
0.5
]
}
},
{
"entity_id": "ea3a964d-95fe-4b1a-bfb4-97f65c5fc629",
"ownership": {
"fraction": 0.7
}
}
],
"ultimate_beneficiary_owners": [
{
"person_entity_id": "ea3a964d-95fe-4b1a-bfb4-97f65c5fc629",
"effective_ownership": {
"fraction": 0.7
}
}
],
"directors": [
{
"person_entity_id": "ea3a964d-95fe-4b1a-bfb4-97f65c5fc629",
"nominal": false
}
],
"is_license_required": false,
"counterparties": [
{
"entity_id": "e092c3ef-76e3-4947-9dd4-bf87a39e7faa",
"nature_of_relationship": "...",
"counterparty_role": [
"customer",
"supplier"
]
}
]
}
},
{
"entity_id": "e092c3ef-76e3-4947-9dd4-bf87a39e7faa",
"entity_details": {
"type": "company",
"entity_id": "e092c3ef-76e3-4947-9dd4-bf87a39e7faa",
"company_full_name": "...",
"incorporation_date": "2015-02-12",
"company_status": "...",
"company_country_code": "UK",
"company_website": {
"url": "..."
},
"company_reg_number": "...",
"tax_residency_country_code": "GB",
"tax_residence_number": "...",
"vat_number": "...",
"legal_address": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"legal_address_translated": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"operational_address": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"operational_address_translated": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"registered_industry_codes": [],
"auto_assigned_industry_codes": [],
"shareholders": [],
"ultimate_beneficiary_owners": [],
"directors": [],
"is_license_required": null,
"counterparties": []
}
},
{
"entity_id": "ea3a964d-95fe-4b1a-bfb4-97f65c5fc629",
"entity_details": {
"type": "person",
"entity_id": "ea3a964d-95fe-4b1a-bfb4-97f65c5fc629",
"first_name": "...",
"last_name": "...",
"date_of_birth": "1990-01",
"id_number": "...",
"citizenship_country_code": "GB",
"residency_country_code": "GB",
"tax_residency_country_code": "GB",
"tax_residence_number": "...",
"is_us_person": false,
"is_pep_self_assessment": false,
"email": "...",
"phone": "+1234567890",
"residential_address": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"residential_address_translated": {
"street_address": "...",
"city": "...",
"postcode": "...",
"country_code": "GB",
"state_or_province": "..."
},
"linkedin_profile": "https://www.linkedin.com/in/test/"
}
}
],
"business_description_summary": "...",
"questionnaire": null
}
}The case result object contains:
legal_entities- all known legal entities within the case - companies (shareholding companies, counterparties) or stakeholders/persons (beneficiaries, directors, account owners). Each legal entity has an ID which is used to reference this entity from other places (like list of beneficiaries contains links to person entities by ID).business_description_summary- Summary of the business description derived from the dialog with the account owner.questionnaire- Selected answers to the questionnaire, if it was filledmain_entity_id- identifies the legal entity which represents the onboarding company.account_owner_entity_ids- identifies the legal entity which represents the account owner person.conversation_results- an array containing the results of individual conversations (dialogs) within the case. Each conversation result contains:- the list of documents uploaded within the case (and each documents references the legal entity which this document was requested for);
- the conversation log.
For a full and up-to-date specification of the results object, please refer to the Get Case Result endpoint documentation.
Updated about 2 months ago