Documents
List all Documents
Returns a list of all of your documents for a customer. The list is sorted by creation date, with the most recently created documents appearing first.
get/customers/{customer_id}/documents
Path parameters
customer_idstring uuid required
The Inscribe customer id.
Query parameters
customer_idsstring uuid
A comma separated list of customer UUIDs. Filter documents by specific customer IDs.
customer_statuses'approved' | 'rejected' | 'unknown'
Filter documents by customer status.
customer_status_reasons'fraud' | 'credit_risk' | 'other'
Filter documents by the customer's review status reason. Reasons are only present when the customer's status is 'rejected'.
document_idsstring uuid
A comma separated list of document UUIDs. Filter documents by specific document IDs.
document_types'UNKNOWN' | 'BANK_STATEMENT' | 'BANK_LETTER' | 'BENEFITS_STATEMENT' | 'BUSINESS_FILING' | 'CHECK' | 'CREDIT_CARD_STATEMENT' | 'DRIVING_LICENSE' | 'EMPLOYMENT_LETTER' | 'FINANCIAL_STATEMENT' | 'INSURANCE_STATEMENT' | 'INVESTMENT_STATEMENT' | 'INVOICE' | 'LEASE' | 'LOAN_DOCUMENT' | 'PAYSLIP' | 'SOCIAL_SECURITY_CARD' | 'TAX_FORM' | 'UTILITY_BILL'
Filter documents by document type
end_datestring date
Filter documents created before this date.
file_types'IMAGE_PDF' | 'SCAN_OCR' | 'TRUE_PDF' | 'IMAGE' | 'MIXED_PAGE_PDF' | 'EMPTY_PDF' | 'FLATTENED_PDF'
Filter documents by file type.
is_fraudulentboolean
Filter documents by fraud status. Warning This field is deprecated.
limitinteger
Set a limit on the number of documents to be returned per page. The limit can range between 1 and 50, the default is 15.
order'-created_at' | 'created_at'
Sort order for documents. Use -created_at for descending order by creation date.
pageinteger
Indicate which page of the document list to return, the default is 1.
searchstring
A search query to filter documents.
start_datestring date
Filter documents created on or after this date.
tagsstring
A comma separated list of tags. Filter documents by tag.
Response
Returns back a list of Document objects.
Example response
{
"data": [
{
"uuid": "6e764ab5-4617-40d5-9076-0bd0e537b4d1",
"id": "42",
"name": "john_smith_payslip_dec20.pdf",
"created_at": "2019-12-12T15:35:08.460Z",
"customer_id": "684502aa-268a-4c2a-b166-ac4bfa2caf44",
"customer_name": "John Smith",
"state": "PROCESSED",
"total_pages": 1,
"document_type": "BANK_STATEMENT",
"subtypes": [
"CP_575"
],
"file_type": "TRUE_PDF",
"language": "en",
"is_fraudulent": true,
"trust_score": 50,
"quality_score": 50,
"review_status": "ACCEPTED",
"review": {
"status": "REJECTED",
"reason": "FRAUD",
"comment": "Rejected due to suspected fraudulent activity"
},
"urls": {
"web_app": "https://app.inscribe.ai/#/customer/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b/document/1234",
"api": "https://api.inscribe.ai/api/v2/customers/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b/documents/1234",
"original_file": "https://production-us-west-2-assets.inscribeusercontent.com/files/users/123/documents/8a2d3b0c-27be-4513-91ab-52c6e0a19691_document.png"
},
"risk_assessment": {
"summary": "This document has been flagged as high risk due to the presence of several fraud signals, as well as concerns about the legitimacy of the seller.",
"insights": [
{
"type": "INVOICE_SELLER_EXISTENCE",
"result": "FAIL",
"title": "Existence of ABC Company Ltd.",
"rationale": "Unable to verify the existence of the seller 'ABC Company Ltd.' through business registries and online presence checks.",
"urls": [
"https://businessregistry.example.com/search?q=abc-company-ltd"
]
}
]
},
"tags": [
{
"id": "ce1d4123-b482-4409-8177-cdf363bea111",
"value": "onboarding"
}
],
"collect_session": {
"id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
"document_request_id": 1,
"created_at": "2019-12-12T15:35:08.460Z",
"completed_at": "2019-12-12T15:35:08.460Z"
},
"checks": [
{
"name": "Document Type Check",
"id": "80b6e47f-4ac7-4dec-b9fc-c35a70fa48ec",
"triggers": [
{
"name": "document_type",
"operator": "equal_to",
"value": "BANK_STATEMENT"
}
],
"requirements": [
{
"name": "document_type",
"operator": "equal_to",
"value": [
"BANK_STATEMENT"
],
"actual_value": "BANK_STATEMENT",
"passed": true
}
]
}
],
"verification": {
"name": {
"verified": true,
"input": "Jane Customer",
"matched": "Jane Customer"
},
"names": [
{
"verified": true,
"input": "Jane Customer",
"matched": "Jane Customer"
}
],
"address": {
"verified": true,
"input": "1000 Walnut Kansas City MO 64106-3686",
"matched": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA",
"structured": {
"line_1": "742 Evergreen Terrace",
"line_2": "Springfield",
"city": "Springfield",
"post_code": "62704",
"state": "IL",
"country": "USA"
}
},
"addresses": [
{
"verified": true,
"input": "1000 Walnut Kansas City MO 64106-3686",
"matched": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA",
"structured": {
"line_1": "742 Evergreen Terrace",
"line_2": "Springfield",
"city": "Springfield",
"post_code": "62704",
"state": "IL",
"country": "USA"
}
}
],
"company": {
"verified": true,
"input": "Inscribe AI Inc",
"matched": "Inscribe AI Inc"
},
"companies": [
{
"verified": true,
"input": "Inscribe AI Inc",
"matched": "Inscribe AI Inc"
}
],
"id_number": {
"verified": true,
"input": "12-1234567",
"matched": "12-1234567"
},
"id_numbers": [
{
"verified": true,
"input": "12-1234567",
"matched": "121234567"
}
],
"strings": [
{
"verified": true,
"input": "9299999111",
"matched": "929-9999-111"
}
],
"patterns": [
{
"verified": true,
"key": "account-number",
"pattern": "(9-?2-?9-?(9-?9)-?(1-?1-?1-?1)",
"matched_string": "929-99-1111",
"matched_groups": [
"929",
"99",
"1111"
],
"error": "Pattern not found"
}
]
},
"parsed_details": {
"document_date": {
"raw": "3rd of December 2019",
"normalized": "2019-12-03",
"confidence": 0.8
},
"address": {
"raw": "1000 walnut kansas city",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA",
"structured": {
"line_1": "1000 Walnut St",
"line_2": "Kansas City",
"city": "Kansas",
"post_code": "64106",
"state": "MO",
"country": "USA"
},
"confidence": 0.8
},
"name": {
"raw": "Frank Abagnale",
"confidence": 0.8
},
"account_number": {
"raw": "CA 1234 5678",
"normalized": "CA12345678",
"confidence": 0.8
},
"beginning_balance": {
"raw": "$12,345.67",
"normalized": 12345.67,
"confidence": 0.8
},
"ending_balance": {
"raw": "$12,345.67",
"normalized": 12345.67,
"confidence": 0.8
},
"date_of_birth": {
"raw": "12.3.1989",
"normalized": "1989-12-03",
"confidence": 0.8
},
"expiry_date": {
"raw": "12.3.2023",
"normalized": "2023-12-03",
"confidence": 0.8
},
"issue_date": {
"raw": "12.3.2023",
"normalized": "2023-12-03",
"confidence": 0.8
},
"document_number": {
"raw": "1234567890",
"normalized": "1234567890",
"confidence": 0.8
},
"country_code": {
"raw": "US",
"confidence": 0.8
},
"bank_accounts": [
{
"institution_name": "BANK_OF_AMERICA",
"account_type": "PERSONAL",
"name": {
"raw": "Checking 360",
"normalized": "Checking 360",
"confidence": 0.98
},
"number": {
"raw": "1234 5678",
"normalized": "12345678",
"confidence": 0.99
},
"beginning_date": {
"raw": "Jan 12 2022",
"normalized": "2022-01-12",
"confidence": 0.99
},
"ending_date": {
"raw": "Feb 12 2022",
"normalized": "2022-02-12",
"confidence": 0.99
},
"currency_code": "USD",
"transactions": [
{
"id": "f5a7b7f0-03dc-491d-bd38-b5f632919178",
"date": "2021-01-01",
"description": "Ssa Treas 310 Des:Xxsoc Sec Id:Xxxxxxxxxa Ssa Indn:Randall J Wright Co Id:9031036360 Ppd",
"amount": 24680,
"currency_code": "USD"
}
],
"transaction_confidence": 0.98,
"transaction_analysis": {
"charges": {
"non_sufficient_funds": [
{
"transaction_id": "12e90e31-0508-413f-8282-f385167e1510",
"refunded": true,
"refund_transaction_id": "81e90e31-0508-413f-8282-f385167e1510"
}
],
"overdrafts": [
{
"transaction_id": "12e90e31-0508-413f-8282-f385167e1510",
"refunded": true,
"refunded_transaction_id": "81e90e31-0508-413f-8282-f385167e1510"
}
]
},
"summary_statistics": {
"average_daily_balance": 2500,
"credits_count": 2,
"credits_total_gross": 1000,
"debits_count": 1,
"debits_total_gross": 2000,
"maximum_balance": 2000,
"minimum_balance": -1000,
"maximum_minus_minimum_balance": 3000,
"number_of_days_with_negative_balance": 5,
"revenue_annual": 300000000,
"revenue_for_period": 25000000,
"salary_annual": 3000000,
"salary_for_period": 250000,
"total_net": -1000,
"transfers_count": 3,
"transfers_credits_total_gross": 2000,
"transfers_debits_total_gross": 1000,
"transfers_total_net": 1000
},
"lending_activity": {
"payments": [
{
"transaction_id": "12e90e31-0508-413f-8282-f385167e1510",
"lender": "BANK OF AMERICA"
}
],
"repayments": [
{
"transaction_id": "12e90e31-0508-413f-8282-f385167e1510",
"lender": "BANK OF AMERICA"
}
]
}
}
}
],
"payslips": [
{
"business_name": {
"raw": "Hot Deals LLC",
"normalized": "Hot Deals LLC",
"confidence": 0.98
},
"business_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut Kansas City, MO, 64106, USA",
"structured": {
"line_1": "1000 Walnut St",
"line_2": "Kansas City",
"city": "Kansas",
"post_code": "64106",
"state": "MO",
"country": "USA"
},
"confidence": 0.99
},
"period_start": {
"raw": "3rd of December 2019",
"normalized": "2019-12-03",
"confidence": 0.8
},
"period_end": {
"raw": "16th of December 2019",
"normalized": "2019-12-16",
"confidence": 0.8
}
}
],
"currency": {
"code": "USD",
"confidence": 0.8
},
"ein": [
{
"normalized": "12-6554311",
"confidence": 0.8
}
],
"ssn": [
{
"raw": "999-99-9999",
"normalized": "999-99-9999",
"confidence": 0.9
}
],
"financial_statements": {
"profit_and_loss": [
{
"costs_of_revenue": {
"raw": "20000.00",
"normalized": "$20,000.00"
},
"gross_profit": {
"raw": "$55,000.00",
"normalized": "$55,000.00"
},
"gross_margin": {
"raw": "55.35%",
"normalized": "55.35%"
},
"net_profit": {
"raw": "$23,250.00",
"normalized": "$23,250.00"
},
"operating_income": {
"raw": "$30,000.00",
"normalized": "$30,000.00"
},
"operating_margin": {
"raw": "55.38%",
"normalized": "55.38%"
},
"net_income": {
"raw": "$23,250.00",
"normalized": "$23,250.00"
},
"business_name": {
"raw": "Example Business Inc.",
"normalized": "Example Business Inc."
},
"business_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"year_issued": {
"raw": "2020",
"normalized": "2020"
},
"total_expenses": {
"raw": "$31,750.00",
"normalized": "$31,750.00"
}
}
]
},
"tax_forms": {
"1040": [
{
"taxpayer_name": {
"raw": "John Smith",
"normalized": "John Smith"
},
"taxpayer_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"social_security_number": {
"raw": "123-45-6789",
"normalized": "123-45-6789"
},
"total_income": {
"normalized": 4500075
},
"deductions": {
"normalized": 750050
},
"taxable_income": {
"normalized": 3750025
},
"total_tax": {
"normalized": 675030
},
"total_payments": {
"normalized": 800000
},
"tax_to_be_refunded": {
"normalized": 50070
},
"tax_owed": {
"normalized": 100050
}
}
],
"1065": [
{
"partnership_name": {
"raw": "ACME Inc.",
"normalized": "ACME Inc."
},
"partnership_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"employer_identification_number": {
"raw": "12-3456789",
"normalized": "12-3456789"
},
"total_income": {
"normalized": 7500075
},
"total_assets": {
"normalized": 100000050
},
"deductions": {
"normalized": 2000025
},
"total_tax_balance_due": {
"normalized": 1500030
},
"total_tax_amount_owed": {
"normalized": 1200050
},
"ordinary_business_income": {
"normalized": 500025
}
}
],
"1120": [
{
"corporation_name": {
"raw": "ACME Inc.",
"normalized": "ACME Inc."
},
"corporation_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"employer_identification_number": {
"raw": "12-3456789",
"normalized": "12-3456789"
},
"total_assets": {
"normalized": 1000000050
},
"total_income": {
"normalized": 75000075
},
"deductions": {
"normalized": 20000025
},
"taxable_income": {
"normalized": 55000050
},
"tax_owed": {
"normalized": 15000030
},
"total_payments_and_credits": {
"normalized": 20000050
}
}
],
"w2": [
{
"employer_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"employer_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"employer_identification_number": {
"raw": "12-6554311",
"normalized": "12-6554311"
},
"social_security_number": {
"raw": "999-99-9999",
"normalized": "999-99-9999"
},
"wages_tips_comp": {
"normalized": 12345
},
"fed_income_tax_withheld": {
"normalized": 12345
},
"social_security_wages": {
"normalized": 12345
},
"state_wages_tips": {
"normalized": 12345
},
"social_security_tax_withheld": {
"normalized": 12345
},
"medicare_wages_tips": {
"normalized": 12345
},
"medicare_tax_withheld": {
"normalized": 12345
}
}
],
"w9": [
{
"business_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"business_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"employer_identification_number": {
"raw": "12-6554311",
"normalized": "12-6554311"
}
}
],
"1040_schedule_c": [
{
"proprietor_name": {
"raw": "John Smith",
"normalized": "John Smith"
},
"business_name": {
"raw": "ACME Inc.",
"normalized": "ACME Inc."
},
"business_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"employer_identification_number": {
"raw": "12-3456789",
"normalized": "12-3456789"
},
"social_security_number": {
"raw": "123-45-6789",
"normalized": "123-45-6789"
},
"gross_profit": {
"normalized": 2500075
},
"gross_income": {
"normalized": 3500050
},
"total_expenses": {
"normalized": 1000025
},
"net_profit": {
"normalized": 2500025
},
"cost_of_goods_sold": {
"normalized": 2500025
},
"total_other_expenses": {
"normalized": 2500025
}
}
],
"1120_s": [
{
"corporation_name": {
"raw": "ACME Inc.",
"normalized": "ACME Inc."
},
"corporation_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"employer_identification_number": {
"raw": "12-3456789",
"normalized": "12-3456789"
},
"total_assets": {
"normalized": 100000050
},
"total_income": {
"normalized": 75000075
},
"deductions": {
"normalized": 20000025
},
"ordinary_business_income": {
"normalized": 500025
},
"tax_owed": {
"normalized": 150030
}
}
],
"1099_misc": [
{
"payers_name": {
"raw": "John Smith",
"normalized": "John Smith"
},
"payers_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"payers_tin": {
"raw": "12-3456789",
"normalized": "12-3456789"
},
"state_tax_withheld": {
"normalized": 25050
},
"state_income": {
"normalized": 500075
},
"recipients_tin": {
"raw": "98-7654321",
"normalized": "98-7654321"
},
"recipients_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"recipients_address": {
"raw": "123 Main St, Anytown",
"normalized": "123 Main St, Anytown, USA"
},
"rents": {
"normalized": 150025
},
"royalties": {
"normalized": 75050
},
"other_income": {
"normalized": 50075
},
"medical_and_healthcare": {
"normalized": 100025
},
"gross_attorney_payments": {
"normalized": 50050
},
"section_409a_deferrals": {
"normalized": 75075
},
"excess_golden_parachute_payments": {
"normalized": 100025
},
"non_qualified_deferred_compensation": {
"normalized": 150050
}
}
],
"1099_nec": [
{
"payers_name": {
"raw": "John Smith",
"normalized": "John Smith"
},
"payers_address": {
"raw": "1000 Walnut Kansas City MO 64106-3686",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA"
},
"payers_tin": {
"raw": "12-3456789",
"normalized": "12-3456789"
},
"state_tax_withheld": {
"normalized": 25050
},
"state_income": {
"normalized": 500075
},
"recipients_tin": {
"raw": "98-7654321",
"normalized": "98-7654321"
},
"recipients_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"recipients_address": {
"raw": "123 Main St, Anytown",
"normalized": "123 Main St, Anytown, USA"
},
"non_employee_compensation": {
"normalized": 150025
},
"federal_income_tax_withheld": {
"normalized": 20050
}
}
],
"cp_575": [
{
"proprietor_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"employer_identification_number": {
"raw": "12-6554311",
"normalized": "12-6554311"
}
}
],
"147c": [
{
"proprietor_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"employer_identification_number": {
"raw": "12-6554311",
"normalized": "12-6554311"
}
}
],
"ss4": [
{
"proprietor_name": {
"raw": "John Doe",
"normalized": "John Doe"
},
"employer_identification_number": {
"raw": "12-6554311",
"normalized": "12-6554311"
}
}
]
},
"checks": [
{
"check_number": {
"raw": "362",
"normalized": "362",
"confidence": 0.99
},
"account_number": {
"raw": "485726463",
"normalized": "485726463",
"confidence": 0.99
},
"routing_number": {
"raw": "026009593",
"normalized": "026009593",
"confidence": 0.99
}
}
],
"invoices": [
{
"seller_name": {
"raw": "Inscribe AI LLC",
"normalized": "Inscribe AI LLC",
"confidence": 0.99
},
"seller_address": {
"raw": "1000 walnut kansas city",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA",
"structured": {
"line_1": "742 Evergreen Terrace",
"line_2": "Springfield",
"city": "Springfield",
"post_code": "62704",
"state": "IL",
"country": "USA"
},
"confidence": 0.99
}
}
],
"business_filings": [
{
"state_of_formation": {
"raw": "Delaware",
"normalized": "Delaware",
"confidence": 0.99
}
}
],
"utility_bills": [
{
"account_number": {
"raw": "1234-567890",
"normalized": "1234567890",
"confidence": 0.99
},
"period_start": {
"raw": "01/01/2024",
"normalized": "2024-01-01",
"confidence": 0.99
},
"period_end": {
"raw": "01/31/2024",
"normalized": "2024-01-31",
"confidence": 0.99
},
"service_provider_name": {
"raw": "City Power & Light",
"normalized": "City Power & Light",
"confidence": 0.99
},
"service_provider_address": {
"raw": "1000 walnut kansas city",
"normalized": "1000 Walnut St, Kansas City, MO 64106, USA",
"structured": {
"line_1": "742 Evergreen Terrace",
"line_2": "Springfield",
"city": "Springfield",
"post_code": "62704",
"state": "IL",
"country": "USA"
},
"confidence": 0.99
},
"service_provider_website_url": {
"raw": "www.citypowerandlight.com",
"normalized": "www.citypowerandlight.com",
"confidence": 0.99
}
}
],
"company": {
"name": "Inscribe AI LLC",
"current_status": "Active",
"retrieved_at": "2019-12-12T15:35:08.460Z",
"opencorporates_url": "https://opencorporates.com/companies/us_ca/C4575591",
"registry_url": "https://businesssearch.sos.ca.gov/CBS/SearchResults?SearchType=NUMBER&SearchCriteria=C4575591"
}
},
"device_fingerprint": {
"visitor_id": "3HNey93AkBW6CRbxV6xP",
"incognito_mode_used": true,
"ip_address": "1.2.3.4",
"ip_location": {
"city": {
"name": "Dublin"
},
"subdivisions": [
{
"name": "Leinster",
"iso_code": "L"
}
],
"country": {
"name": "Ireland",
"code": "IE"
},
"continent": {
"name": "Europe",
"code": "EU"
},
"timezone": "Europe/Dublin",
"latitude": 53.3379,
"longitude": -6.2591,
"postal_code": "D02",
"accuracy_radius": 10
},
"device_details": {
"browser_name": "Chrome Mobile",
"browser_major_version": "106",
"browser_full_version": "106.0.0",
"os": "Android",
"os_version": "12",
"device": "Samsung SM-G991U1",
"user_agent": "Mozilla/5.0 (Linux; Android 12; SM-G991U1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Mobile Safari/537.36"
}
}
}
],
"metadata": {
"pagination": {
"limit": 10,
"current_page": 1,
"number_of_pages": 1,
"total": 1
},
"fraud_results": {
"fraudulent_count": 1
}
}
}