Skip to content
Tunic Pay Documentation

Get analysis results

GET
/analyses/{analysis_id}/results

Retrieve the results of a completed analysis.

Authorizations

Parameters

Path Parameters

analysis_id
required
string

Responses

200

Analysis results retrieved

object
analysis_id
required

The unique identifier for the analysis.

string
content

Results of the content analysis.

object
document_type

Type of document (e.g., Invoice).

string
Allowed values: UNKNOWN ACCOUNT_STATEMENT BANK_DETAILS INSURANCE_CLAIM INVOICE PAYSLIP RECEIPT ORDER UTILITY_BILL
document_number

Document number.

string
document_date_of_issue

ISO-8601 date of document issuance.

string format: date
payer
object
name

Name of the party.

string
company_name

Company name associated with the party.

string
company_info
object
company_number
required

Registration number for the company.

string
company_status
required

Current operating status of the company.

string
Allowed values: active dissolved liquidation receivership administration voluntary-arrangement converted-closed insolvency-proceedings registered removed closed open
company_type
required

Type of company.

string
Allowed values: private-unlimited ltd plc old-public-company private-limited-guarant-nsc-limited-exemption limited-partnership private-limited-guarant-nsc converted-or-closed private-unlimited-nsc private-limited-shares-section-30-exemption protected-cell-company assurance-company oversea-company eeig icvc-securities icvc-warrant icvc-umbrella registered-society-non-jurisdictional industrial-and-provident-society northern-ireland northern-ireland-other royal-charter investment-company-with-variable-capital unregistered-company llp other european-public-limited-liability-company-se uk-establishment scottish-partnership charitable-incorporated-organisation scottish-charitable-incorporated-organisation further-education-or-sixth-form-college-corporation registered-overseas-entity
date_of_creation
required

ISO 8601 date of company formation.

string format: date
registered_office_address
required

Official registered address of the company.

string
sic_codes
required

Standard Industrial Classification (SIC) codes.

Array<string>
date_of_cessation

ISO 8601 date of company cessation (if applicable).

string format: date
fca_registration

Status of the company’s registration with the FCA, if any.

string
Allowed values: AUTHORISED UNAUTHORISED
bank_account
object
type

Type of bank account identifier.

string
Allowed values: GB_BSC_AN IBAN
sort_code

Sort code (for UK bank accounts). Set if type is GB_BSC_AN.

string
account_number

Account number (for UK bank accounts). Set if type is GB_BSC_AN.

string
iban

International Bank Account Number (see ISO 13616:2020).

string
/^[A-Z]{2}\d{2}[A-Z]\d]{,30}$/
bic

Bank Identifier Code.

string
/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/
tax_id

Tax identification number of the party.

string
locations

Addresses associated with the party.

Array<string>
emails

Email addresses of the party.

Array<string>
phone_numbers

Phone numbers of the party.

Array<string>
websites

Websites associated with the party.

Array<string>
payee
object
name

Name of the party.

string
company_name

Company name associated with the party.

string
company_info
object
company_number
required

Registration number for the company.

string
company_status
required

Current operating status of the company.

string
Allowed values: active dissolved liquidation receivership administration voluntary-arrangement converted-closed insolvency-proceedings registered removed closed open
company_type
required

Type of company.

string
Allowed values: private-unlimited ltd plc old-public-company private-limited-guarant-nsc-limited-exemption limited-partnership private-limited-guarant-nsc converted-or-closed private-unlimited-nsc private-limited-shares-section-30-exemption protected-cell-company assurance-company oversea-company eeig icvc-securities icvc-warrant icvc-umbrella registered-society-non-jurisdictional industrial-and-provident-society northern-ireland northern-ireland-other royal-charter investment-company-with-variable-capital unregistered-company llp other european-public-limited-liability-company-se uk-establishment scottish-partnership charitable-incorporated-organisation scottish-charitable-incorporated-organisation further-education-or-sixth-form-college-corporation registered-overseas-entity
date_of_creation
required

ISO 8601 date of company formation.

string format: date
registered_office_address
required

Official registered address of the company.

string
sic_codes
required

Standard Industrial Classification (SIC) codes.

Array<string>
date_of_cessation

ISO 8601 date of company cessation (if applicable).

string format: date
fca_registration

Status of the company’s registration with the FCA, if any.

string
Allowed values: AUTHORISED UNAUTHORISED
bank_account
object
type

Type of bank account identifier.

string
Allowed values: GB_BSC_AN IBAN
sort_code

Sort code (for UK bank accounts). Set if type is GB_BSC_AN.

string
account_number

Account number (for UK bank accounts). Set if type is GB_BSC_AN.

string
iban

International Bank Account Number (see ISO 13616:2020).

string
/^[A-Z]{2}\d{2}[A-Z]\d]{,30}$/
bic

Bank Identifier Code.

string
/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/
tax_id

Tax identification number of the party.

string
locations

Addresses associated with the party.

Array<string>
emails

Email addresses of the party.

Array<string>
phone_numbers

Phone numbers of the party.

Array<string>
websites

Websites associated with the party.

Array<string>
line_items
Array<object>
object
description

Description of the item or service.

string
quantity

Quantity of the item or service.

number format: float
total_price

Total price for the item or service.

object
monetary_value
required

The numerical part of the monetary amount, in decimal notation (negative values permitted).

string format: number
/^(\-|\+)?((\d+(\.\d*)?)|(\.\d+))$/ 
-123.45678
currency_code

The ISO 4217 alpha code for the currency.

string
/^[A-Z]{3}$/ 
GBP
totals
object
bill_due_date

ISO 8601 date when the bill is due.

string format: date
subtotal_amount

Subtotal amount before taxes and discounts.

object
monetary_value
required

The numerical part of the monetary amount, in decimal notation (negative values permitted).

string format: number
/^(\-|\+)?((\d+(\.\d*)?)|(\.\d+))$/ 
-123.45678
currency_code

The ISO 4217 alpha code for the currency.

string
/^[A-Z]{3}$/ 
GBP
discount_amount

Total discount applied.

object
monetary_value
required

The numerical part of the monetary amount, in decimal notation (negative values permitted).

string format: number
/^(\-|\+)?((\d+(\.\d*)?)|(\.\d+))$/ 
-123.45678
currency_code

The ISO 4217 alpha code for the currency.

string
/^[A-Z]{3}$/ 
GBP
tax_amount

Total tax amount.

object
monetary_value
required

The numerical part of the monetary amount, in decimal notation (negative values permitted).

string format: number
/^(\-|\+)?((\d+(\.\d*)?)|(\.\d+))$/ 
-123.45678
currency_code

The ISO 4217 alpha code for the currency.

string
/^[A-Z]{3}$/ 
GBP
tax_included

Whether the tax is included in the total amount.

boolean
total_amount

Final total amount after tax and discounts.

object
monetary_value
required

The numerical part of the monetary amount, in decimal notation (negative values permitted).

string format: number
/^(\-|\+)?((\d+(\.\d*)?)|(\.\d+))$/ 
-123.45678
currency_code

The ISO 4217 alpha code for the currency.

string
/^[A-Z]{3}$/ 
GBP
indicators
required
Array<object>
object
indicator_id
required

Unique identifier for the indicator.

string
name

Name of the indicator.

string
level

Risk level associated with the indicator.

string
Allowed values: HIGH_RISK MEDIUM_RISK LOW_RISK INFO TRUST
description
required

Detailed explanation of what the indicator is describing.

string
entity_type

Type of entity associated with the indicator.

string
entity_value

Value of the entity associated with the risk.

string
forensic

Results of the forensic analysis.

object
file_metadata
required
object
producer

The software or application which was used for generating the document.

string
creator

The original author or software that first created the document content.

string
creation_date

ISO 8601 timestamp of file creation.

string format: date-time
modification_date

ISO 8601 timestamp of last modification.

string format: date-time
author

Author of the document.

string
title

Title of the document.

string
file_type
required

The MIME type of the file (e.g., application/pdf).

string
quality_score

Quality assessment of the file.

string
Allowed values: HIGH_QUALITY MEDIUM_QUALITY LOW_QUALITY
sha256
required

SHA-256 hash of the file content.

string
file_name
required

Name of the file.

string
indicators
required
Array<object>
object
indicator_id
required

Unique identifier for the indicator.

string
name

Name of the indicator.

string
level

Risk level associated with the indicator.

string
Allowed values: HIGH_RISK MEDIUM_RISK LOW_RISK INFO TRUST
description
required

Detailed explanation of what the indicator is describing.

string
entity_type

Type of entity associated with the indicator.

string
entity_value

Value of the entity associated with the risk.

string

401

Unauthorized

object
error_code
required

A unique error code identifying the issue.

string
message
required

A human-readable error message.

string

403

Forbidden

object
error_code
required

A unique error code identifying the issue.

string
message
required

A human-readable error message.

string

404

No analysis found with ID {analysis_id}

object
error_code
required

A unique error code identifying the issue.

string
message
required

A human-readable error message.

string