openapi: 3.2.0
info:
description: Inscribe Fraud Detection API Documentation
version: 2.0.0
title: Core Resources Documents API
termsOfService: http://swagger.io/terms/
contact:
email: api@inscribe.ai
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.inscribe.ai/api/v2
security:
- ApiKeyAuth: []
tags:
- name: Documents
description: Document objects are created to store a document. You can create, get, delete, and list your documents against a customer. Documents are identified by an id.
paths:
/customers/{customer_id}/documents:
post:
x-readme:
code-samples:
- language: curl
code: 'curl "https://api.inscribe.ai/api/v2/customers/{customer_id}/documents/" \
-H "Authorization: Inscribe ..." \
-F ''fileX=@/path/to/fileX'' \
-F ''fileY=@/path/to/fileY'' \
-F ''verify_entities=[{"name":"Jane Customer", "address":"1000 Walnut Kansas City MO"}]'' \
-F ''tags=[{"text": "onboarding"}, {"text": "new_system"}]''
'
- language: python
code: "import requests\nimport os\nimport json\n\ncustomer_id = \"CUSTOMER_ID\"\n\nurl = f\"https://api.inscribe.ai/api/v2/customers/{customer_id}/documents\"\n\nheaders = {\n \"Authorization\": \"Inscribe ...\"\n}\n\nverify_entities = [{\n \"name\": \"Jane Customer\",\n \"address\": \"1000 Walnut Kansas City MO\",\n \"company\": \"Smith & Sons\",\n \"id_number\": \"92914567\",\n \"strings\": [{\"key\": \"phone\", \"input\": \"929-7113-145\"}]\n}]\n\ntags = [{\"text\": \"onboarding\"}, {\"text\": \"new_customer\"}]\n\nwith open(\"DOCUMENT_FILE_PATH\", \"rb+\") as document:\n filename = os.path.basename(document.name)\n files = {\n \"verify_entities\": (None, json.dumps(verify_entities), 'application/json'),\n \"tags\": (None, json.dumps(tags), 'application/json'),\n \"file\": (filename, document, \"application/octet-stream\")\n }\n response = requests.request(\"POST\", url, files=files, headers=headers)\n print(response.text)\n"
- language: node
code: "const FormData = require('form-data');\nconst fetch = require('node-fetch');\nconst formData = new FormData();\nconst fs = require('fs');\n\nconst verifyEntities = [{\n name: \"Jane Customer\",\n address: \"1000 Walnut Kansas City MO\",\n company: \"Smith & Sons\",\n id_number: \"92914567\",\n strings: [{key: \"phone\", input: \"929-7113-145\"}]\n}];\n\nconst tags = [{text: \"onboarding\"}, {text: \"new_customer\"}];\n\nformData.append(\"verify_entities\", JSON.stringify(verifyEntities));\nformData.append(\"tags\", JSON.stringify(tags));\nformData.append(\"file\", fs.createReadStream(\"DOCUMENT_FILE_PATH\"));\n\nconst customer_id = \"CUSTOMER_ID\";\n\nconst url = `https://api.inscribe.ai/api/v2/customers/${customer_id}/documents`;\nconst options = {\n method: 'POST',\n headers: {\n Authorization: 'Inscribe ...'\n },\n body: formData,\n};\n\nfetch(url, options)\n .then(res => res.json())\n .then(json => console.log(json))\n .catch(err => console.error('error:' + err));\n"
tags:
- Documents
summary: Upload Document(s)
description: Uploads document(s) to a customer. Once the document(s) are uploaded, they will be queued for processing by Inscribe's fraud detection, parsing, and optionally verification algorithms. The file size limit is 50 MB and the page limit for PDFs is 350.
operationId: uploadDocuments
parameters:
- name: customer_id
in: path
description: The Inscribe customer id.
example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b
required: true
schema:
type: string
format: uuid
requestBody:
description: 'The document(s) you would like to upload. These document(s) must be one of the following supported mime type: application/pdf, image/jpg, image/png, application/octet-stream.'
content:
multipart/form-data:
schema:
type: object
properties:
files:
type: array
description: A list of files to be uploaded for analysis.
items:
type: string
format: binary
verify_entities:
type: array
description: Each verify_entity object in this array corresponds to a file in the above "files" parameter.
items:
$ref: '#/components/schemas/VerificationsRequest'
tags:
type: array
description: These tags will be associated with all the uploaded document(s).
items:
$ref: '#/components/schemas/UploadTag'
responses:
'202':
description: Successfully uploaded.
content:
application/json:
schema:
$ref: '#/components/schemas/UploadDocuments'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/PermissionDenied'
'429':
$ref: '#/components/responses/TooManyRequests'
x-samples-code-samples:
- language: curl
code: 'curl "https://api.inscribe.ai/api/v2/customers/{customer_id}/documents/" \
-H "Authorization: Inscribe ..." \
-F ''fileX=@/path/to/fileX'' \
-F ''fileY=@/path/to/fileY'' \
-F ''verify_entities=[{"name":"Jane Customer", "address":"1000 Walnut Kansas City MO"}]'' \
-F ''tags=[{"text": "onboarding"}, {"text": "new_system"}]''
'
- language: python
code: "import requests\nimport os\nimport json\n\ncustomer_id = \"CUSTOMER_ID\"\n\nurl = f\"https://api.inscribe.ai/api/v2/customers/{customer_id}/documents\"\n\nheaders = {\n \"Authorization\": \"Inscribe ...\"\n}\n\nverify_entities = [{\n \"name\": \"Jane Customer\",\n \"address\": \"1000 Walnut Kansas City MO\",\n \"company\": \"Smith & Sons\",\n \"id_number\": \"92914567\",\n \"strings\": [{\"key\": \"phone\", \"input\": \"929-7113-145\"}]\n}]\n\ntags = [{\"text\": \"onboarding\"}, {\"text\": \"new_customer\"}]\n\nwith open(\"DOCUMENT_FILE_PATH\", \"rb+\") as document:\n filename = os.path.basename(document.name)\n files = {\n \"verify_entities\": (None, json.dumps(verify_entities), 'application/json'),\n \"tags\": (None, json.dumps(tags), 'application/json'),\n \"file\": (filename, document, \"application/octet-stream\")\n }\n response = requests.request(\"POST\", url, files=files, headers=headers)\n print(response.text)\n"
- languages: node
code: "const FormData = require('form-data');\nconst fetch = require('node-fetch');\nconst formData = new FormData();\nconst fs = require('fs');\n\nconst verifyEntities = [{\n name: \"Jane Customer\",\n address: \"1000 Walnut Kansas City MO\",\n company: \"Smith & Sons\",\n id_number: \"92914567\",\n strings: [{key: \"phone\", input: \"929-7113-145\"}]\n}];\n\nconst tags = [{text: \"onboarding\"}, {text: \"new_customer\"}];\n\nformData.append(\"verify_entities\", JSON.stringify(verifyEntities));\nformData.append(\"tags\", JSON.stringify(tags));\nformData.append(\"file\", fs.createReadStream(\"DOCUMENT_FILE_PATH\"));\n\nconst customer_id = \"CUSTOMER_ID\";\n\nconst url = `https://api.inscribe.ai/api/v2/customers/${customer_id}/documents`;\nconst options = {\n method: 'POST',\n headers: {\n Authorization: 'Inscribe ...'\n },\n body: formData,\n};\n\nfetch(url, options)\n .then(res => res.json())\n .then(json => console.log(json))\n .catch(err => console.error('error:' + err));\n"
get:
tags:
- Documents
summary: List all Documents
description: 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.
operationId: getDocuments
parameters:
- name: customer_id
in: path
description: The Inscribe customer id.
example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b
required: true
schema:
type: string
format: uuid
- in: query
name: customer_ids
required: false
description: A comma separated list of customer UUIDs. Filter documents by specific customer IDs.
example: 7c812569-ce51-45c1-859f327bfa06d7c5,7c812569-ce51-45c1-859f327bfa06d7c4
schema:
type: string
format: uuid
- in: query
name: customer_statuses
required: false
description: Filter documents by customer status.
example: unknown
schema:
type: string
enum:
- approved
- rejected
- unknown
- in: query
name: customer_status_reasons
required: false
description: Filter documents by the customer's review status reason. Reasons are only present when the customer's status is 'rejected'.
example: fraud
schema:
type: string
enum:
- fraud
- credit_risk
- other
- in: query
name: document_ids
required: false
description: A comma separated list of document UUIDs. Filter documents by specific document IDs.
example: 3616baa9-9caf-434e-b4d0-8a32c644dfd4,3616baa9-9caf-434e-b4d0-8a32c644dfe5
schema:
type: string
format: uuid
- in: query
name: document_types
required: false
description: Filter documents by document type
example: BANK_STATEMENT
schema:
type: string
enum:
- 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
- in: query
name: end_date
required: false
description: Filter documents created before this date.
example: '2025-01-23'
schema:
type: string
format: date
- in: query
name: file_types
required: false
description: Filter documents by file type.
example: TRUE_PDF
schema:
type: string
enum:
- IMAGE_PDF
- SCAN_OCR
- TRUE_PDF
- IMAGE
- MIXED_PAGE_PDF
- EMPTY_PDF
- FLATTENED_PDF
- in: query
name: is_fraudulent
required: false
deprecated: true
description: Filter documents by fraud status. **Warning** This field is deprecated.
example: false
schema:
type: boolean
- in: query
name: limit
required: false
description: 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.
example: 15
schema:
type: integer
format: int64
minimum: 1
maximum: 50
- in: query
name: order
required: false
description: Sort order for documents. Use -created_at for descending order by creation date.
example: -created_at
schema:
type: string
enum:
- -created_at
- created_at
- in: query
name: page
required: false
description: Indicate which page of the document list to return, the default is 1.
example: 1
schema:
type: integer
format: int64
minimum: 1
- in: query
name: search
required: false
description: A search query to filter documents.
example: hsbc_bank_statement
schema:
type: string
- in: query
name: start_date
required: false
description: Filter documents created on or after this date.
example: '2025-01-22'
schema:
type: string
format: date
- in: query
name: tags
required: false
description: A comma separated list of tags. Filter documents by tag.
example: HSBC,Wells Fargo
schema:
type: string
responses:
'200':
description: Returns back a list of Document objects.
content:
application/json:
schema:
$ref: '#/components/schemas/ListDocuments'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
/customers/{customer_id}/documents/{document_id}:
get:
tags:
- Documents
summary: Retrieve a Document
description: Retrieve results and information of an existing document. Supply the unique customer id from either a customer creation request or the customer list, and the document id from either a document upload request or a list of documents from the customer. Inscribe will return the corresponding document overview when the document is in the PROCESSED state, until then some information will be unavailable. A webhook can be configured to receive PROCESSED document results in real-time.
operationId: getDocumentResults
parameters:
- name: customer_id
in: path
description: The Inscribe customer id.
example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b
required: true
schema:
type: string
format: uuid
- name: document_id
in: path
description: The id of the document for which you want to retrieve results.
example: 12345
required: true
schema:
type: integer
responses:
'200':
description: Successfully retrieved document results.
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
put:
tags:
- Documents
summary: Update a Document
description: Update document.
operationId: updateDocument
parameters:
- name: customer_id
in: path
description: The Inscribe customer id.
example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b
required: true
schema:
type: string
format: uuid
- name: document_id
in: path
description: The id of the document to be updated.
example: 12345
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdateRequest'
responses:
'200':
description: Successfully updated document.
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
x-samples-code-samples:
- language: curl
code: 'curl -X PUT "https://api.inscribe.ai/api/v2/customers/{customer_id}/documents/{document_id}" \ -H "Authorization: Inscribe ..." \ -F ''tags=[{"text": "onboarding"}, {"text": "new_system"}]'''
delete:
tags:
- Documents
summary: Delete a Document
description: Delete document. This cannot be undone
operationId: deleteDocument
parameters:
- name: customer_id
in: path
description: The Inscribe customer id.
example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b
required: true
schema:
type: string
format: uuid
- name: document_id
in: path
description: The id of the document to be deleted.
example: 12345
required: true
schema:
type: integer
responses:
'204':
description: Successfully deleted document.
'400':
$ref: '#/components/responses/BadRequest'
'403':
$ref: '#/components/responses/PermissionDenied'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
components:
schemas:
UploadDocuments:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DocumentCompact'
description: A map with a data property that contains an array of documents that have been uploaded. Each entry in the array is a separate document object.
Taxform1099Misc:
type: array
description: A list of U.S. Form 1099-MISC (Miscellaneous Income) found in the document.
items:
type: object
properties:
payers_name:
type: object
description: The payer name found in the document.
properties:
raw:
type: string
description: The payer name as it appears in the document.
example: John Smith
normalized:
type: string
description: The normalized payer name (same as raw in this case).
example: John Smith
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed payer name.
minimum: 0
maximum: 1
payers_address:
type: object
description: The payer address found in the document.
properties:
raw:
type: string
description: The payer address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized payer address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed payer address.
minimum: 0
maximum: 1
payers_tin:
type: object
description: The Taxpayer Identification Number (TIN) of the payer
properties:
raw:
type: string
description: The TIN of the payer as it appears in the document.
example: 12-3456789
normalized:
type: string
description: The normalized TIN of the payer (same as raw in this case).
example: 12-3456789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed TIN of the payer.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
state_tax_withheld:
type: object
description: The state tax withheld by the payer
properties:
raw:
type: string
description: The state tax withheld as it appears in the document.
example: 250.5
normalized:
type: integer
description: The normalized state tax withheld in cents.
example: 25050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed state tax withheld.
minimum: 0
maximum: 1
state_income:
type: object
description: The state income reported in the document
properties:
raw:
type: string
description: The state income as it appears in the document.
example: 5000.75
normalized:
type: integer
description: The normalized state income in cents.
example: 500075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed state income.
minimum: 0
maximum: 1
recipients_tin:
type: object
description: The Taxpayer Identification Number (TIN) of the recipient
properties:
raw:
type: string
description: The TIN of the recipient as it appears in the document.
example: 98-7654321
normalized:
type: string
description: The normalized TIN of the recipient (same as raw in this case).
example: 98-7654321
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed TIN of the recipient.
minimum: 0
maximum: 1
recipients_name:
type: object
description: The name of the recipient
properties:
raw:
type: string
description: The name of the recipient as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized name of the recipient (same as raw in this case).
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed name of the recipient.
minimum: 0
maximum: 1
recipients_address:
type: object
description: The address of the recipient
properties:
raw:
type: string
description: The address of the recipient as it appears in the document.
example: 123 Main St, Anytown
normalized:
type: string
description: The normalized address of the recipient. Where possible, this will be in the format Address Line 1, Address Line 2, Postcode, City, State, Country.
example: 123 Main St, Anytown, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed address of the recipient.
minimum: 0
maximum: 1
rents:
type: object
description: Income from rents reported in the document
properties:
raw:
type: string
description: Income from rents as it appears in the document.
example: 1500.25
normalized:
type: integer
description: The normalized income from rents in cents.
example: 150025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed income from rents.
minimum: 0
maximum: 1
royalties:
type: object
description: Royalties reported in the document
properties:
raw:
type: string
description: Royalties as they appear in the document.
example: 750.5
normalized:
type: integer
description: The normalized royalties in cents.
example: 75050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed royalties.
minimum: 0
maximum: 1
other_income:
type: object
description: Other income reported in the document
properties:
raw:
type: string
description: Other income as it appears in the document.
example: 500.75
normalized:
type: integer
description: The normalized other income in cents.
example: 50075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed other income.
minimum: 0
maximum: 1
medical_and_healthcare:
type: object
description: Medical and healthcare payments reported in the document
properties:
raw:
type: string
description: Medical and healthcare payments as they appear in the document.
example: 1000.25
normalized:
type: integer
description: The normalized medical and healthcare payments in cents.
example: 100025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed medical and healthcare payments.
minimum: 0
maximum: 1
account_number:
type: object
description: Account number associated with the payment
properties:
raw:
type: string
description: The account number as it appears in the document.
example: 12345678
normalized:
type: string
description: The normalized account number (same as raw in this case).
example: 12345678
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed account number.
minimum: 0
maximum: 1
gross_attorney_payments:
type: object
description: Gross attorney payments reported in the document
properties:
raw:
type: string
description: Gross attorney payments as they appear in the document.
example: 500.5
normalized:
type: integer
description: The normalized gross attorney payments in cents.
example: 50050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed gross attorney payments.
minimum: 0
maximum: 1
section_409a_deferrals:
type: object
description: Section 409A deferrals reported in the document
properties:
raw:
type: string
description: Section 409A deferrals as they appear in the document.
example: 750.75
normalized:
type: integer
description: The normalized Section 409A deferrals in cents.
example: 75075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed Section 409A deferrals.
minimum: 0
maximum: 1
excess_golden_parachute_payments:
type: object
description: Excess golden parachute payments reported in the document
properties:
raw:
type: string
description: Excess golden parachute payments as they appear in the document.
example: 1000.25
normalized:
type: integer
description: The normalized excess golden parachute payments in cents.
example: 100025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed excess golden parachute payments.
minimum: 0
maximum: 1
non_qualified_deferred_compensation:
type: object
description: Non-qualified deferred compensation reported in the document
properties:
raw:
type: string
description: Non-qualified deferred compensation as it appears in the document.
example: 1500.5
normalized:
type: integer
description: The normalized non-qualified deferred compensation in cents.
example: 150050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed non-qualified deferred compensation.
minimum: 0
maximum: 1
TaxformCP575:
type: array
description: A list of U.S. Letter CP-575 (EIN Confirmation Letter) found in the document.
items:
type: object
properties:
proprietor_name:
type: object
description: The proprietor name found in the document.
properties:
raw:
type: string
description: The proprietor name as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized proprietor name. In this case, the normalized value is the same as the raw value.
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the business
properties:
raw:
type: string
description: The employer identification number as it appears in the document.
example: 12-6554311
normalized:
type: string
description: The normalized employer identification number. In this case, the normalized value is the same as the raw value.
example: 12-6554311
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
TaxformW9:
type: array
description: A list of U.S. Form W-9 (Request for Taxpayer Identification Number and Certification) found in the document.
items:
type: object
properties:
business_name:
type: object
description: The business name found in the document
properties:
raw:
type: string
description: The business name as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized business name. In this case, the normalized value is the same as the raw value.
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
business_address:
type: object
description: The address of the business
properties:
raw:
type: string
description: The business address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized business address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the business
properties:
raw:
type: string
description: The employer identification number as it appears in the document.
example: 12-6554311
normalized:
type: string
description: The normalized employer identification number. In this case, the normalized value is the same as the raw value.
example: 12-6554311
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
VerificationsRequest:
type: object
description: Optional information to be verified against a document. If supplied there must be exactly one entry for each document, an entry can be blank if no information is to be verified.
properties:
name:
type: string
deprecated: true
example: Frank Abagnale
description: A personal name you wish to verify against the document. **Warning** This field is deprecated and will be removed in a future release. Please use `names` instead.
names:
type: array
description: An array of personal names you wish to verify against the document.
items:
type: string
example: Frank Abagnale
description: A personal name you wish to verify against the document.
address:
type: string
deprecated: true
description: An address you wish to verify is represented in the document. **Warning** This field is deprecated and will be removed in a future release. Please use `addresses` instead.
example: 123 Fake Street
addresses:
type: array
description: An array of address you wish to verify are represented in the document.
items:
type: string
example: 123 Fake Street
description: An address you wish to verify is represented in the document.
company:
type: string
deprecated: true
example: Inscribe AI Inc
description: A company name you wish to verify against the document. **Warning** This field is deprecated and will be removed in a future release. Please use `companies` instead.
companies:
type: array
description: An array of company names you wish to verify against the document.
items:
type: string
example: Inscribe AI Inc
description: A company name you wish to verify against the document.
id_number:
type: string
deprecated: true
pattern: ^(?!666|000|9\d{2})\d{3}-(?!00)\d{2}-(?!0{4})\d{4}$|\d{2}-\d{7}|\d{9}
example: 12-1234567
description: An identification number you wish to verify against the document. Currently, SSN and EIN formats are supported. **Warning** This field is deprecated and will be removed in a future release. Please use `id_numbers` instead.
id_numbers:
type: array
description: An array of identification numbers you wish to verify against the document.
items:
type: string
pattern: ^(?!666|000|9\d{2})\d{3}-(?!00)\d{2}-(?!0{4})\d{4}$|\d{2}-\d{7}|\d{9}
example: 12-1234567
description: An identification number you wish to verify against the document. Currently, SSN and EIN formats are supported.
strings:
type: array
items:
type: object
properties:
key:
type: string
description: An identifier for the input. Set by you for your own reference.
example: Phone number
input:
type: string
description: A string you wish to verify against the document.
example: 929 947 9991
patterns:
type: array
items:
type: object
properties:
key:
type: string
description: An identifier for the pattern. Set by you for your own reference.
example: Phone number
pattern:
type: string
description: A regular expression pattern you wish to verify against the document.
example: ^\d{3} \d{3} \d{4}$
use_parsed_details_only:
type: boolean
default: false
description: If true, only the parsed details will be used for verification not the whole document text. If false or not present, both parsed details and the whole document text will be used for verification.
example: false
TaxformSS4:
type: array
description: A list of U.S. Form SS-4 (Application for Employer Identification Number) found in the document.
items:
type: object
properties:
proprietor_name:
type: object
description: The proprietor name found in the document.
properties:
raw:
type: string
description: The proprietor name as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized proprietor name. In this case, the normalized value is the same as the raw value.
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the business
properties:
raw:
type: string
description: The employer identification number as it appears in the document.
example: 12-6554311
normalized:
type: string
description: The normalized employer identification number. In this case, the normalized value is the same as the raw value.
example: 12-6554311
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
Invoices:
type: array
description: 'An array of invoices found in the document. Currently, only the first invoice present in a document is returned. If the document isn''t of type `INVOICE`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service.
'
items:
type: object
required:
- seller_name
- seller_address
- total_invoice_amount
- total_taxes
- total_discounts
- total_additional_fees
properties:
seller_name:
type: object
description: 'The parsed seller name, i.e., the issuer of the invoice. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The seller name as it appears on the document
example: Inscribe AI LLC
normalized:
type: string
description: The normalized seller name. In this case the returned normalized value is the same as raw.
example: Inscribe AI LLC
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
seller_address:
type: object
description: 'The parsed seller address. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The seller address as it appears on the document.
example: 1000 walnut kansas city
normalized:
type: string
description: The normalized form of the seller address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
structured:
$ref: '#/components/schemas/Address'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
total_invoice_amount:
description: 'The parsed total invoice amount. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $1000.00
normalized: 100000
confidence: 0.99
total_taxes:
description: 'The parsed total taxes. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '150.00'
normalized: 15000
confidence: 0.99
total_discounts:
description: 'The parsed total discounts. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $20.00
normalized: 2000
confidence: 0.99
total_additional_fees:
description: 'The parsed total additional fees. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $30.00
normalized: 3000
confidence: 0.99
ProfitAndLoss:
type: array
description: A list of financial statements found in the document.
items:
type: object
properties:
costs_of_revenue:
type: object
description: The costs directly associated with producing the revenue.
properties:
raw:
type: string
description: The raw costs of revenue as it appears in the document.
example: '20000.00'
normalized:
type: string
description: The normalized costs of revenue.
example: $20,000.00
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
gross_profit:
type: object
description: The profit a company makes after deducting the costs associated with making and selling its products, or the costs associated with providing its services.
properties:
raw:
type: string
description: The gross profit as it appears in the document.
example: $55,000.00
normalized:
type: string
description: The normalized gross profit.
example: $55,000.00
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
gross_margin:
type: object
description: The gross margin represents the percent of total sales revenue that the company retains after incurring the direct costs associated with producing the goods and services sold by a company.
properties:
raw:
type: string
description: The gross margin as it appears in the document.
example: 55.35%
normalized:
type: string
description: The normalized gross margin.
example: 55.35%
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
net_profit:
type: object
description: Net profit is the amount of money that is left after subtracting the company's total expenses from total revenue.
properties:
raw:
type: string
description: The net profit as it appears in the document.
example: $23,250.00
normalized:
type: string
description: The normalized net profit.
example: $23,250.00
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
operating_income:
type: object
description: Operating income is an accounting figure that measures the amount of profit realized from a business's operations, after deducting operating expenses such as wages, depreciation, and cost of goods sold (COGS).
properties:
raw:
type: string
description: The operating income as it appears in the document.
example: $30,000.00
normalized:
type: string
description: The normalized operating income.
example: $30,000.00
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
operating_margin:
type: object
description: Operating margin is a margin ratio used to measure a company's pricing strategy and operating efficiency.
properties:
raw:
type: string
description: The operating margin as it appears in the document.
example: 55.38%
normalized:
type: string
description: The normalized operating margin.
example: 55.38%
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
net_income:
type: object
description: Net income is a company's total earnings (or profit); net income is calculated by taking revenues and subtracting the costs of doing business such as depreciation, interest, taxes and other expenses.
properties:
raw:
type: string
description: The net income as it appears in the document.
example: $23,250.00
normalized:
type: string
description: The normalized net income.
example: $23,250.00
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
business_name:
type: object
description: The name of the business.
properties:
raw:
type: string
description: The business name as it appears in the document.
example: Example Business Inc.
normalized:
type: string
description: The normalized business name.
example: Example Business Inc.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
business_address:
type: object
description: The address of the business.
properties:
raw:
type: string
description: The business address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized business address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
year_issued:
type: object
description: The year the document or data was issued or created.
properties:
raw:
type: string
description: The year issued as it appears in the document.
example: '2020'
normalized:
type: string
description: The normalized year issued.
example: '2020'
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
total_expenses:
type: object
description: The total expenses incurred by the business.
properties:
raw:
type: string
description: The total expenses as it appears in the document.
example: $31,750.00
normalized:
type: string
description: The normalized total expenses.
example: $31,750.00
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
VerificationRequestPluralizedFormsOnly:
type: object
description: Optional information to be verified against a document.
properties:
names:
type: array
description: An array of personal names you wish to verify against the document.
items:
type: string
example: Frank Abagnale
description: A personal name you wish to verify against the document.
addresses:
type: array
description: An array of address you wish to verify are represented in the document.
items:
type: string
example: 123 Fake Street
description: An address you wish to verify is represented in the document.
companies:
type: array
description: An array of company names you wish to verify against the document.
items:
type: string
example: Inscribe AI Inc
description: A company name you wish to verify against the document.
id_numbers:
type: array
description: An array of identification numbers you wish to verify against the document.
items:
type: string
pattern: ^(?!666|000|9\d{2})\d{3}-(?!00)\d{2}-(?!0{4})\d{4}$|\d{2}-\d{7}|\d{9}
example: 12-1234567
description: An identification number you wish to verify against the document. Currently, SSN and EIN formats are supported.
strings:
type: array
items:
type: object
properties:
key:
type: string
description: An identifier for the input. Set by you for your own reference.
example: Phone number
input:
type: string
description: A string you wish to verify against the document.
example: 929 947 9991
patterns:
type: array
items:
type: object
properties:
key:
type: string
description: An identifier for the pattern. Set by you for your own reference.
example: Phone number
pattern:
type: string
description: A regular expression pattern you wish to verify against the document.
example: ^\d{3} \d{3} \d{4}$
use_parsed_details_only:
type: boolean
default: false
description: If true, only the parsed details will be used for verification not the whole document text. If false or not present, both parsed details and the whole document text will be used for verification.
example: false
BusinessFilings:
type: array
description: 'An array of business filings found in the document. Currently, only the first business filing present in a document is returned. If the document isn''t of type `BUSINESS_FILING` and of one of the subtypes `CERTIFICATE_OF_INCORPORATION`, `ARTICLES_OF_INCORPORATION`, `CERTIFICATE_OF_FORMATION`, `ARTICLES_OF_ORGANIZATION`, `CERTIFICATE_OF_ORGANIZATION`, `PARTNERSHIP_AGREEMENT`, `CERTIFICATE_OF_GOOD_STANDING`, or `OPERATING_AGREEMENT` the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service.
'
items:
type: object
required:
- state_of_formation
properties:
state_of_formation:
type: object
description: 'The parsed U.S. state where the the company is formed or incorporated. An empty object is returned if a matching result has not been found.
'
required:
- raw
- normalized
- confidence
properties:
raw:
type: string
description: The state as it appears on the document
example: Delaware
normalized:
type: string
description: The normalized state name.
example: Delaware
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
Document:
allOf:
- $ref: '#/components/schemas/DocumentCompact'
- type: object
properties:
tags:
type: array
description: A list of tags that you have assigned to a document. Tags are used to group documents together across customers.
items:
$ref: '#/components/schemas/Tag'
collect_session:
type:
- object
- 'null'
description: An optional object, this will be non-null if this document was uploaded as part of a Collect session.
properties:
id:
type: string
format: uuid
description: Unique identifier for the Collect session.
example: 0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b
document_request_id:
type: integer
description: Unique identifier for the document request that this document document was uploaded to.
example: 1
created_at:
type: string
format: date-time
description: 'Time at which the session was created. In the format: yyyy-MM-dd''T''HH:mm:ssZ'
example: '2019-12-12T15:35:08.460Z'
completed_at:
type: string
format: date-time
description: 'Time at which the session was completed. This will be null if the session has not been completed. In the format: yyyy-MM-dd''T''HH:mm:ssZ'
example: '2019-12-12T15:35:08.460Z'
live_capture_mode:
type: boolean
description: Indicates if the document was collected with Live Image Capture.
example: false
checks:
type: array
description: A list of checks that were applied to the document.
items:
type: object
properties:
name:
type: string
description: The name of the check
example: Document Type Check
id:
type: string
format: uuid
description: Unique identifier for the check.
example: 80b6e47f-4ac7-4dec-b9fc-c35a70fa48ec
public:
type: boolean
description: Whether the check is shown to customers during collect sessions
example: false
passed:
type: boolean
description: Whether the check passed all of its conditions
example: false
triggers:
type: array
description: A list of trigger conditions that were satisfied, causing the check to be applied to the document
items:
type: object
properties:
name:
type: string
description: The name of the condition variable
example: document_type
operator:
type: string
description: The operator of the condition
example: equal_to
value:
type: string
description: The value of the condition
example: BANK_STATEMENT
requirements:
type: array
description: A list of requirement conditions applied to the document
items:
type: object
properties:
name:
type: string
description: The name of the condition variable
example: document_type
operator:
type: string
description: The operator of the condition
example: equal_to
value:
oneOf:
- type: array
items:
type: string
example: BANK_STATEMENT
- type: boolean
example: true
- type: integer
example: 90
- type: number
format: float
example: 0.98
description: The value of the condition
actual_value:
type: string
description: The value of the condition variable
example: BANK_STATEMENT
passed:
type: boolean
description: Whether the requirement condition was met or not
example: true
verification:
type: object
properties:
name:
type: object
deprecated: true
description: The name key will only exist if a name was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state. **Warning** This field is deprecated and will be removed in a future release. Please use `names` instead.
properties:
verified:
type: boolean
description: Indicates if the name submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: Jane Customer
description: The name submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: Jane Customer
description: The name found in the document that matches the submitted name. This value is only available when the document is in the PROCESSED state.
names:
type: array
items:
type: object
description: The `names` key will only exist if a `names` array was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state.
properties:
verified:
type: boolean
description: Indicates if the name submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: Jane Customer
description: The name submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: Jane Customer
description: The name found in the document that matches the submitted name. This value is only available when the document is in the PROCESSED state.
address:
type: object
deprecated: true
description: The address key will only exist if an address was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state. **warning** This field is deprecated and will be removed in a future release. Please use `addresses` instead.
properties:
verified:
type: boolean
description: Indicates if the address submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: 1000 Walnut Kansas City MO 64106-3686
description: The address submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type:
- string
- 'null'
example: 1000 Walnut Kansas City MO 64106-3686
description: The address found in the document that matches the submitted address.This value is only available when the document is in the PROCESSED state.
normalized:
type: string
example: 1000 Walnut St, Kansas City, MO 64106, USA
description: The normalized version of the submitted address. This value is only available when the document is in the PROCESSED state.
structured:
$ref: '#/components/schemas/Address'
addresses:
type: array
items:
type: object
description: The `addresses` key will only exist if a `addresses` array was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state.
properties:
verified:
type: boolean
description: Indicates if the address submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: 1000 Walnut Kansas City MO 64106-3686
description: The address submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type:
- string
- 'null'
example: 1000 Walnut Kansas City MO 64106-3686
description: The address found in the document that matches the submitted address. This value is only available when the document is in the PROCESSED state.
normalized:
type: string
example: 1000 Walnut St, Kansas City, MO 64106, USA
description: The normalized version of the submitted address. This value is only available when the document is in the PROCESSED state.
structured:
$ref: '#/components/schemas/Address'
company:
type: object
deprecated: true
description: The company key will only exist if a company was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state. **Warning** This field is deprecated and will be removed in a future release. Please use `companies` instead.
properties:
verified:
type: boolean
description: Indicates if the company submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: Inscribe AI Inc
description: The company submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: Inscribe AI Inc
description: The company found in the document that matches the submitted company. This value is only available when the document is in the PROCESSED state.
companies:
type: array
items:
type: object
description: The `companies` key will only exist if a `companies` array was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state.
properties:
verified:
type: boolean
description: Indicates if the company submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: Inscribe AI Inc
description: The company submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: Inscribe AI Inc
description: The company found in the document that matches the submitted company. This value is only available when the document is in the PROCESSED state.
id_number:
type: object
deprecated: true
description: The id_number key will only exist if a id_number was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state. **Warning** This field is deprecated and will be removed in a future release. Please use `id_numbers` instead.
properties:
verified:
type: boolean
description: Indicates if the id_number submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: 12-1234567
description: The id_number submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: 12-1234567
description: The id_number found in the document that matches the submitted id_number. This will not always be the exact same string as the input as we do some intelligent matching. This value is only available when the document is in the PROCESSED state.
id_numbers:
type: array
items:
type: object
description: The `id_numbers` key will only exist if a `id_numbers` array was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state.
properties:
verified:
type: boolean
description: Indicates if the id_number submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: 12-1234567
description: The id_number submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: '121234567'
description: The id_number found in the document that matches the submitted id_number. This will not always be the exact same string as the input as we do some intelligent matching. This value is only available when the document is in the PROCESSED state.
strings:
type: array
description: The strings key will only exist if a `strings` array was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state.
items:
type: object
properties:
verified:
type: boolean
description: Indicates if the string submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
input:
type: string
example: '9299999111'
description: The string submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched:
type: string
example: 929-9999-111
description: The string found in the document that matches the submitted id_number. This will not always be the exact same string as the input as we do some intelligent matching. This value is only available when the document is in the PROCESSED state.
patterns:
type: array
description: The patterns key will only exist if a `patterns` array was submitted to be verified against this document. The values within will only be available when the document is in the PROCESSED state. This feature is in beta and will improve over time.
required:
- verified
- key
- pattern
- matched_string
- matched_groups
items:
type: object
properties:
verified:
type: boolean
description: Indicates if the pattern submitted was verified to be in the document. This value is only available when the document is in the PROCESSED state.
example: true
key:
type: string
example: account-number
description: The key identifying the pattern submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
pattern:
type: string
example: (9-?2-?9-?(9-?9)-?(1-?1-?1-?1)
description: The pattern submitted to be verified in the document. This value is only available when the document is in the PROCESSED state.
matched_string:
type: string
example: 929-99-1111
description: The first string found in the document that matches the submitted pattern. This value is only available when the document is in the PROCESSED state.
matched_groups:
type: array
items:
type: string
example:
- '929'
- '99'
- '1111'
description: The strings found in the document that matched the capturing groups in the submitted pattern. If the pattern contained no capturing groups then this will be an empty array. This value is only available when the document is in the PROCESSED state.
error:
type: string
example: Pattern not found
description: A description of the error that occurred. This value is only available when the document is in the PROCESSED state and an error occurred.
parsed_details:
type: object
description: Relevant information that has been parsed from the document you supplied.
properties:
document_date:
type: object
description: The document date. For documents such as bank statements, this will be the last day of the statement period. For utility bills and invoices, this will be the date of issue of the bill or invoice. For payslips, this will be the check date or advice date. The document_date key will not exist if a date could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The raw date as it appears in the document. This value is only available when the document is in the PROCESSED state.
example: 3rd of December 2019
normalized:
type: string
format: date
description: 'Normalized date. In the format yyyy-MM-dd - example: 2019-12-03. If a day is not present in the raw date, the normalized date will correspond to the last day of the month. For example, February 2019 will be normalized as 2019-02-28. This value is only available when the document is in the PROCESSED state.'
example: '2019-12-03'
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
address:
type: object
description: The address of the document recipient. The address key will not exist if an address could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The raw address as it appears in the document. This value is only available when the document is in the PROCESSED state.
example: 1000 walnut kansas city
normalized:
type: string
description: Normalized address. This value is only available when the document is in the PROCESSED state.
example: 1000 Walnut St, Kansas City, MO 64106, USA
structured:
type: object
description: The structured output of the address. Any or all of these fields can be empty depending on the raw address.
properties:
line_1:
type: string
description: First line of the address
example: 1000 Walnut St
line_2:
type: string
description: Second line of the address
example: Kansas City
city:
type: string
description: City of the address
example: Kansas
post_code:
type: string
description: Post code of the address
example: '64106'
state:
type: string
description: State field of the address
example: MO
country:
type: string
description: Country of the address
example: USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
name:
type: object
description: The relevant name that this document references. The name key will not exist if a name could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The name of the document recipient. This value is only available when the document is in the PROCESSED state.
example: Frank Abagnale
variants:
type: array
description: List of name variants for matching against, obtained by formatting by line and removing titles and incorporation suffixes. For example, the raw name "MR FRANK ABAGNALE\nHOT DEALS LLC" will have as a list of variants ["Mr Frank Abagnale", "Frank Abagnale" "Hot Deals Llc", "Hot Deals"]. This value is only available when the document is in the PROCESSED state.
items:
type: string
example:
- Mr Frank Abagnale
- Frank Abagnale
- Hot Deals Llc
- Hot Deals
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
account_number:
type: object
description: The account_number key contains information about the account number as presented in relevant documents such as bank statements or utility bills. The account_number key will not exist if an account number could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The account number as it appears on the document. This value is only available when the document is in the PROCESSED state.
example: CA 1234 5678
normalized:
type: string
description: A formatted version of the account number, with all spaces removed. This value is only available when the document is in the PROCESSED state.
example: CA12345678
formatted:
type: string
description: This key has been deprecated.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
beginning_balance:
type: object
deprecated: true
description: This key has been deprecated by `"beginning_balance"` in the `"bank_accounts"` parsed details.
properties:
raw:
type: string
description: The beginning balance as it appears on the document. This value is only available when the document is in the PROCESSED state.
example: $12,345.67
normalized:
type: number
format: float
description: The numeric part of the balance, with currency information removed. This value is only available when the document is in the PROCESSED state.
example: 12345.67
formatted:
type: string
description: This key has been deprecated.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
ending_balance:
type: object
deprecated: true
description: This key has been deprecated by `"beginning_balance"` in the `"bank_accounts"` parsed details.
properties:
raw:
type: string
description: The ending balance as it appears on the document. This value is only available when the document is in the PROCESSED state.
example: $12,345.67
normalized:
type: number
format: float
description: The numeric part of the balance, with currency information removed. This value is only available when the document is in the PROCESSED state.
example: 12345.67
formatted:
type: string
description: This key has been deprecated.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
date_of_birth:
type: object
description: The date_of_birth key contains information about the date of birth as presented in relevant documents such as driving licences and passports. The date_of_birth key will not exist if a relevant date could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The date as it appears on the document. This value is only available when the document is in the PROCESSED state.
example: 12.3.1989
normalized:
type: string
format: date
description: Normalized date. When normalizing, ambiguous dates such as "12.03.1989" are assumed to be in the form MM/dd/yyyy. Value returned in the format yyyy-MM-dd. This value is only available when the document is in the PROCESSED state.
example: '1989-12-03'
formatted:
type: string
description: This key has been deprecated.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
expiry_date:
type: object
description: The expiry_date key contains information about the expiry date as presented in relevant documents such as driving licences and passports. The expiry_date key will not exist if a relevant date could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The date as it appears on the document. This value is only available when the document is in the PROCESSED state.
example: 12.3.2023
normalized:
type: string
format: date
description: Normalized date. When normalizing, ambiguous dates such as "12.03.2023" are assumed to be in the form MM/dd/yyyy. Value returned in the format yyyy-MM-dd. This value is only available when the document is in the PROCESSED state.
example: '2023-12-03'
formatted:
type: string
description: This key has been deprecated.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
issue_date:
type: object
description: The issue_date key contains information about the issue date as presented in relevant documents such as utility bills. The issue_date key will not exist if a relevant date could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.
properties:
raw:
type: string
description: The date as it appears on the document. This value is only available when the document is in the PROCESSED state.
example: 12.3.2023
normalized:
type: string
format: date
description: Normalized date. When normalizing, ambiguous dates such as "12.03.2023" are assumed to be in the form MM/dd/yyyy. Value returned in the format yyyy-MM-dd. This value is only available when the document is in the PROCESSED state.
example: '2023-12-03'
formatted:
type: string
description: This key has been deprecated.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
document_number:
type: object
description: The document_number key contains information about the document identification number as presented in relevant documents such as passports and driving licences. The document_number key will not exist if a document number could not be parsed from the document and values within will only be available when the document is in the PROCESSED state. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
properties:
raw:
type: string
description: The document number as it appears on the document.
example: '1234567890'
normalized:
type: string
description: The normalized document number - lower cased and with punctuation removed.
example: '1234567890'
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
country_code:
type: object
description: The country_code key contains the ISO 3166-1 alpha-2 country code of relevant documents such as passports and driving licences. The country_code key will not exist if a country could not be parsed from the document and values within will only be available when the document is in the PROCESSED state.Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
properties:
raw:
type: string
description: The alpha-2 country code for the country of the document.
example: US
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
bank_accounts:
type: array
description: An array of parsed bank accounts found in the document and the parsed details associated with each account. If no bank accounts are found, an empty array is returned. If the document is not of type `BANK_STATEMENT`, the key will not be present in the response.
items:
type: object
required:
- name
- number
- beginning_balance
- ending_balance
- transactions_match_balances
properties:
institution_name:
type: string
description: The name of the bank which issued the document, see documentation for supported banks [here](https://docs.inscribe.ai/docs/documents-classified-by-bank-names).
example: BANK_OF_AMERICA
account_type:
type: string
description: 'The bank account type identified by Inscribe. This can have one of the following values: `"BUSINESS"`, `"PERSONAL"`. The value will be `null` if no account type was identified.'
example: PERSONAL
name:
type: object
description: 'An object providing information about the name of the bank account as it appears on the bank statement. This is distinct from the name of the document owner, which is available as a top-level key within the `"parsed_details"` object. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The name of the bank account as it appears on the bank statement.
example: Checking 360
normalized:
type: string
description: A normalized form of the name.
example: Checking 360
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.98
number:
type: object
description: 'An object providing information about the bank account number as it appears on the document. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The number of the bank account as it appears on the bank statement.
example: 1234 5678
normalized:
type: string
description: A normalized form of the number.
example: '12345678'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.99
beginning_date:
type: object
description: 'An object providing information about the beginning date of activity associated with bank account. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The beginning date as it appears on the bank statement.
example: Jan 12 2022
normalized:
type: string
format: date
description: ISO 8601 formatted date string.
example: '2022-01-12'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.99
ending_date:
type: object
description: 'An object providing information about the ending date of activity associated with bank account. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The ending date as it appears on the bank statement.
example: Feb 12 2022
normalized:
type: string
format: date
description: ISO 8601 formatted date string.
example: '2022-02-12'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.99
beginning_balance:
description: 'An object providing information about the beginning balance of the bank account. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.98
ending_balance:
description: 'An object providing information about the ending balance of the bank account. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '-678.90'
normalized: -67890
confidence: 0.99
currency_code:
type: string
description: The ISO 4217 currency code of the bank account.
example: USD
transactions_match_balances:
type: boolean
description: Indicates if the sum of the beginning balance and transaction total are equal to the ending balance if a beginning and ending balance are present for the account. Otherwise, returns `null`.
example: false
transactions:
type: array
description: An array of the transactions found to be associated with this account. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
items:
type: object
required:
- id
- date
- description
- amount
properties:
id:
type: string
format: uuid
description: A unique identifier for each transaction.
example: f5a7b7f0-03dc-491d-bd38-b5f632919178
date:
type: string
format: date
description: The date of the transaction in the form `YYYY-MM-DD`.
example: '2021-01-01'
description:
type: string
description: The description of the transaction as it appears on the statement.
example: Ssa Treas 310 Des:Xxsoc Sec Id:Xxxxxxxxxa Ssa Indn:Randall J Wright Co Id:9031036360 Ppd
amount:
type: integer
description: A signed integer giving the transaction amount in cents. Negative values indicate debits, positive values indicate credits.
example: 24680
currency_code:
type: string
description: The ISO 4217 currency code of the transaction.
example: USD
transaction_confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the document-level confidence of the transactions returned in the `"transactions"` section. The value will be `null` if no transactions were found for the account.
example: 0.98
transaction_analysis:
type: object
description: '**Beta:** Relevant information that has been extracted from the parsed transactions associated with the bank account. Transaction analysis must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. This feature is in beta and will improve over time.'
required:
- charges
properties:
charges:
type: object
description: Detected charges found within the bank account parsed transactions. Non-sufficent fund and overdraft charges are supported currently.
required:
- non_sufficient_funds
- overdrafts
properties:
non_sufficient_funds:
type: array
description: A list of non-sufficient fund charges detected from the bank account parsed transactions. If no charges are found, an empty array is returned.
items:
type: object
required:
- transaction_id
- refunded
- refund_transaction_id
properties:
transaction_id:
type: string
format: uuid
description: The ID of the non-sufficient fund parsed transaction.
example: 12e90e31-0508-413f-8282-f385167e1510
refunded:
type: boolean
description: An indication of whether or not the charge was refunded.
example: true
refund_transaction_id:
type: string
format: uuid
description: If a charge refund was issued, the ID of the transaction containing the refund. Otherwise returns `null`.
example: 81e90e31-0508-413f-8282-f385167e1510
overdrafts:
type: array
description: A list of overdraft charges detected from the bank account parsed transactions. If no charges are found, an empty array is returned.
items:
type: object
required:
- transaction_id
- refunded
- refunded_transaction_id
properties:
transaction_id:
type: string
format: uuid
description: The ID of the overdraft charge parsed transaction.
example: 12e90e31-0508-413f-8282-f385167e1510
refunded:
type: boolean
description: An indication of whether or not the overdraft charge was refunded.
example: true
refunded_transaction_id:
type: string
format: uuid
description: If a charge refund was issued, the ID of the transaction containing the refund. Otherwise returns `null`.
example: 81e90e31-0508-413f-8282-f385167e1510
summary_statistics:
type: object
description: Credit analysis signals calculated from parsed document transactions during time period starting on date of beginning balance to the last date of month of the last transaction.
required:
- credits_count
- credits_total_gross
- debits_count
- debits_total_gross
- total_net
- average_daily_balance
- maximum_balance
- minimum_balance
- maximum_minus_minimum_balance
- number_of_days_with_negative_balance
- transfers_count
- transfers_credits_total_gross
- transfers_debits_total_gross
- transfers_total_net
- revenue_annual
- revenue_for_period
- salary_annual
- salary_for_period
properties:
average_daily_balance:
type: number
format: integer
description: Average daily balance in cents.
example: 2500
credits_count:
type: number
format: integer
description: Number of credits found in parsed transactions.
example: 2
credits_total_gross:
type: number
format: integer
description: Sum of credits found in parsed transactions in cents.
example: 1000
debits_count:
type: number
format: integer
description: Number of debits found in parsed transactions.
example: 1
debits_total_gross:
type: integer
format: integer
description: Sum of debits found in parsed transactions in cents.
example: 2000
maximum_balance:
type: number
format: integer
description: Maximum daily balance in cents.
example: 2000
minimum_balance:
type: number
format: integer
description: Minimum daily balance in cents.
example: -1000
maximum_minus_minimum_balance:
type: number
format: integer
description: Difference between the maximum and minimum daily balances in cents, calculated by `maximum_balance - minimum_balance`
example: 3000
number_of_days_with_negative_balance:
type: number
format: integer
description: Number of days when account balance is negative.
example: 5
revenue_annual:
type: number
format: integer
description: Estimated annual revenue, based on `revenue_for_period` and the time period of the bank statement.
example: 300000000
revenue_for_period:
type: number
format: integer
description: Sum of all revenue transactions found within the bank statement.
example: 25000000
salary_annual:
type: number
format: integer
description: Estimated annual salary, based on `salary_for_period` and the time period of the bank statement.
example: 3000000
salary_for_period:
type: number
format: integer
description: Sum of all salary transactions found within the bank statement.
example: 250000
total_net:
type: number
format: integer
description: Sum of transactions in cents, calculated by `credits_total_gross - debits_total_gross`. In statements where `beginning_balance` and `ending_balance` are found for the bank account, `total_net` should equal `ending_balance - beginning_balance`.
example: -1000
transfers_count:
type: number
format: integer
description: Number of transfer transactions found.
example: 3
transfers_credits_total_gross:
type: integer
format: integer
description: Sum of credit transfers found in parsed transactions in cents.
example: 2000
transfers_debits_total_gross:
type: integer
format: integer
description: Sum of debit transfers found in parsed transactions in cents.
example: 1000
transfers_total_net:
type: number
format: integer
description: Sum of transfer transactions in cents, transfers_credits_total_gross - transfers_debits_total_gross.
example: 1000
lending_activity:
type: object
description: Detected loan payment and repayment transactions with identified lenders made to and from the customer respectively.
required:
- payments
- repayments
properties:
payments:
type: array
description: List of all loan payment transactions made to the customer from a lender
items:
type: object
required:
- transaction_id
- lender
properties:
transaction_id:
type: string
format: uuid
description: The ID of the associated loan payment transaction.
example: 12e90e31-0508-413f-8282-f385167e1510
lender:
type: string
description: The name of the lender associated with the loan payment
example: BANK OF AMERICA
repayments:
type: array
description: List of all loan repayment transactions made by the customer to a lender
items:
type: object
required:
- transaction_id
- lender
properties:
transaction_id:
type: string
format: uuid
description: The ID of the associated loan repayment transaction.
example: 12e90e31-0508-413f-8282-f385167e1510
lender:
type: string
description: The name of the lender associated with the loan repayment
example: BANK OF AMERICA
payslips:
type: array
description: An array of parsed payslips found in the document and the parsed details associated with the payslips. If no payslips are found, an empty array is returned. If the document is not of type `PAYSLIP`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
items:
type: object
required:
- business_name
- business_address
- gross_pay
- net_pay
- gross_pay_ytd
- net_pay_ytd
- period_start
- period_end
- gross_pay_breakdown
- deductions
properties:
business_name:
type: object
description: 'An object providing information about the business name on the payslip. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: A string giving the business name as it appears on the payslip.
example: Hot Deals LLC
normalized:
type: string
description: A normalized form of the business name.
example: Hot Deals LLC
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.98
business_address:
type: object
description: 'An object providing information about the business address on the payslip. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: A string giving the business address as it appears on the payslip.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: A normalized form of the number.
example: 1000 Walnut Kansas City, MO, 64106, USA
structured:
type: object
description: The structured output of the address. Any or all of these fields can be empty depending on the raw address.
properties:
line_1:
type: string
description: First line of the address
example: 1000 Walnut St
line_2:
type: string
description: Second line of the address
example: Kansas City
city:
type: string
description: City of the address
example: Kansas
post_code:
type: string
description: Post code of the address
example: '64106'
state:
type: string
description: State field of the address
example: MO
country:
type: string
description: Country of the address
example: USA
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.99
gross_pay:
description: 'An object providing information about the gross pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.98
net_pay:
description: 'An object providing information about the net pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
gross_pay_ytd:
description: 'An object providing information about the year-to-date gross pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.98
net_pay_ytd:
description: 'An object providing information about the year-to-date net pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
period_start:
type: object
description: 'An object providing information about date of the start of the pay period recorded on the payslip. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: A string giving the period start date as it appears on the payslip.
example: 3rd of December 2019
normalized:
type: string
format: date
description: 'A string giving the period start date in the format YYYY-MM-DD.
'
example: '2019-12-03'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.8
period_end:
type: object
description: 'An object providing information about date of the end of the pay period recorded on the payslip. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: A string giving the period end date as it appears on the payslip.
example: 16th of December 2019
normalized:
type: string
format: date
description: 'A string giving the period end date in the format YYYY-MM-DD.
'
example: '2019-12-16'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 giving the confidence associated with this result.
example: 0.8
gross_pay_breakdown:
type: object
description: 'An object providing information about the specific components of the gross pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
required:
- bonus_pay
- bonus_pay_ytd
- commission_pay
- commission_pay_ytd
- overtime_pay
- overtime_pay_ytd
properties:
bonus_pay:
description: 'An object providing information about the bonus pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
bonus_pay_ytd:
description: 'An object providing information about the year-to-date bonus pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
commission_pay:
description: 'An object providing information about the commission pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
commission_pay_ytd:
description: 'An object providing information about the year-to-date commission pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
overtime_pay:
description: 'An object providing information about the overtime pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
overtime_pay_ytd:
description: 'An object providing information about the year-to-date overtime pay recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
deductions:
type: object
description: 'An object providing information about the specific components of the deductions recorded on the payslip. An empty object is returned if a matching result has not been found.
'
required:
- pre_tax_401k
- pre_tax_401k_ytd
properties:
pre_tax_401k:
description: 'An object providing information about the pre-tax 401k contribution recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
pre_tax_401k_ytd:
description: 'An object providing information about the year-to-date pre-tax 401k contribution recorded on the payslip. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '123.45'
normalized: 12345
confidence: 0.99
currency:
type: object
properties:
code:
type: string
description: The main ISO 4217 currency code found in the document.
example: USD
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
ein:
type: array
description: A list of unique Employer Identification Numbers found in the document. The ein key will not exist if no EINs were parsed from the document and values within will only be available when the document is in the PROCESSED state.
items:
type: object
properties:
raw:
type: string
description: The EIN as it appears in the document.
example: 126554311
normalized:
type: string
description: 'The EIN in the format ##-#######'
example: 12-6554311
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.8
ssn:
type: array
description: A list of unique Social Security Numbers found in the document. The ssn key will not exist if no SSNs were parsed from the document and values within will only be available when the document is in the PROCESSED state.
items:
type: object
properties:
raw:
type: string
description: The SSN as it appears in the document.
example: 999-99-9999
normalized:
type: string
description: 'The SSN in the format ###-##-####'
example: 999-99-9999
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output. This value is only available when the document is in the PROCESSED state.
example: 0.9
financial_statements:
type: object
description: If the document contains financial statements, we parse certain financial information from these forms. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
properties:
profit_and_loss:
$ref: '#/components/schemas/ProfitAndLoss'
tax_forms:
type: object
description: If the document contains tax forms, we will attempt to parse information from these forms. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
properties:
'1040':
$ref: '#/components/schemas/Taxform1040'
'1065':
$ref: '#/components/schemas/Taxform1065'
'1120':
$ref: '#/components/schemas/Taxform1120'
w2:
$ref: '#/components/schemas/TaxformW2'
w9:
$ref: '#/components/schemas/TaxformW9'
1040_schedule_c:
$ref: '#/components/schemas/Taxform1040ScheduleC'
1120_s:
$ref: '#/components/schemas/Taxform1120s'
1099_misc:
$ref: '#/components/schemas/Taxform1099Misc'
1099_nec:
$ref: '#/components/schemas/Taxform1099NEC'
cp_575:
$ref: '#/components/schemas/TaxformCP575'
147c:
$ref: '#/components/schemas/TaxformLTR147C'
ss4:
$ref: '#/components/schemas/TaxformSS4'
checks:
type: array
description: 'An array of checks found in the document. Currently, only the first check present in a document is returned. If the document isn''t of type `CHECK`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service. If the service is not enabled for your account, the key will be omitted from the response.
'
items:
type: object
required:
- check_number
- account_number
- routing_number
- amount
properties:
check_number:
type: object
description: 'The parsed check number. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The check number as it appears on the document
example: '362'
normalized:
type: string
description: The normalized check number. In this case the returned normalized value is the same as raw.
example: '362'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
account_number:
type: object
description: 'The parsed account number. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The account number as it appears on the document
example: '485726463'
normalized:
type: string
description: The normalized account number. In this case the returned normalized value is the same as raw.
example: '485726463'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
routing_number:
type: object
description: 'The parsed routing number. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The routing number as it appears on the document
example: 026009593
normalized:
type: string
description: The normalized routing number. In this case the returned normalized value is the same as raw.
example: 026009593
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
amount:
description: 'The parsed check amount. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: '500.00'
normalized: 50000
confidence: 0.99
invoices:
$ref: '#/components/schemas/Invoices'
business_filings:
$ref: '#/components/schemas/BusinessFilings'
utility_bills:
$ref: '#/components/schemas/UtilityBills'
benefits_statements:
$ref: '#/components/schemas/BenefitsStatements'
company:
type: object
description: If the name parsed from a document is the name of a registered company, we will attempt to gather information about this entity using external databases. The company key will not exist if the name parsed from a document is not the name of a registered company, and values within will only be available when the document is in the PROCESSED state. This feature is in beta and will improve over time.
properties:
name:
type: string
description: The name of the company as it appears on the external registry. This feature is in beta and will improve over time.
example: Inscribe AI LLC
current_status:
type: string
description: The current status of the company as it appears on the external registry. The range of possible statuses and the meaning of a given status are dependent on the external registry used.
example: Active
retrieved_at:
type: string
format: date-time
description: Time at which the information was extracted from the external registry. In the format yyyy-MM-dd'T'HH:mm:ssZ.
example: '2019-12-12T15:35:08.460Z'
opencorporates_url:
type: string
description: A URL to the company's page on Opencorporates.
example: https://opencorporates.com/companies/us_ca/C4575591
registry_url:
type: string
description: A URL to the company's page on the relevant external registry.
example: https://businesssearch.sos.ca.gov/CBS/SearchResults?SearchType=NUMBER&SearchCriteria=C4575591
device_fingerprint:
type: object
description: An optional object that provides details on how and where a document was uploaded. This can be enabled either through Collect or through an API integration. See [here](https://docs.inscribe.ai/docs/device-identification) for more details.
properties:
visitor_id:
type: string
description: Unique identifier for the device used to upload the document.
example: 3HNey93AkBW6CRbxV6xP
incognito_mode_used:
type: boolean
description: Was the device's browser using enhanced privacy features when uploading the document. For example, Incognito on Chrome, Private Window on Safari, Private Browsing on Firefox, or InPrivate on Edge.
example: true
ip_address:
type: string
description: The IP address used to upload the document.
example: 1.2.3.4
ip_location:
type: object
description: Location associated with the IP address used to upload the document.
properties:
city:
type: object
description: The city the location is contained within. This value will be `null` if the location associated with the IP address is not contained within a city.
properties:
name:
type: string
description: The city name.
example: Dublin
subdivisions:
type: array
description: Subdivisions associated with the location.
items:
type: object
properties:
name:
type: string
description: The subdivision name.
example: Leinster
iso_code:
type: string
description: The subdivision ISO code.
example: L
country:
type: object
description: The country the location is contained within.
properties:
name:
type: string
description: The country name.
example: Ireland
code:
type: string
description: The country code.
example: IE
continent:
type: object
description: The continent the location is contained within.
properties:
name:
type: string
description: The continent name.
example: Europe
code:
type: string
description: The continent code.
example: EU
timezone:
type: string
description: The timezone the location is contained within.
example: Europe/Dublin
latitude:
type: number
format: float
description: The location's latitude.
example: 53.3379
longitude:
type: number
format: float
description: The location's longitude.
example: -6.2591
postal_code:
type: string
description: The postal code associated with the location. The value will be `null` if there is no postal code associated with the location.
example: D02
accuracy_radius:
type: integer
description: The accuracy radius in kilometers of the location associated with the IP address.
example: 10
device_details:
type: object
description: Details about the device and browser used to upload the document.
properties:
browser_name:
type: string
description: The name of the browser used.
example: Chrome Mobile
browser_major_version:
type: string
description: The major version of the browser.
example: '106'
browser_full_version:
type: string
description: The full version of the browser.
example: 106.0.0
os:
type: string
description: The operating system used.
example: Android
os_version:
type: string
description: The operating system version.
example: '12'
device:
type: string
description: The type of device used.
example: Samsung SM-G991U1
user_agent:
type: string
description: User agent details.
example: Mozilla/5.0 (Linux; Android 12; SM-G991U1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Mobile Safari/537.36
Taxform1065:
type: array
description: A list of U.S. Form 1065 (Partnership Return) found in the document.
items:
type: object
properties:
partnership_name:
type: object
description: The partnership name found in the document.
properties:
raw:
type: string
description: The partnership name as it appears in the document.
example: ACME Inc.
normalized:
type: string
description: The normalized partnership name (same as raw in this case).
example: ACME Inc.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed partnership name.
minimum: 0
maximum: 1
partnership_address:
type: object
description: The partnership address found in the document.
properties:
raw:
type: string
description: The partnership address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized partnership address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed partnership address.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the partnership
properties:
raw:
type: string
description: The EIN as it appears in the document.
example: 12-3456789
normalized:
type: string
description: The normalized EIN (same as raw in this case).
example: 12-3456789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed EIN.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
total_income:
type: object
description: The total income reported on the Form 1065 document
properties:
raw:
type: string
description: The total income as it appears in the document.
example: 75000.75
normalized:
type: integer
description: The normalized total income in cents.
example: 7500075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total income.
minimum: 0
maximum: 1
total_assets:
type: object
description: The total assets of the partnership
properties:
raw:
type: string
description: The total assets as they appear in the document.
example: 1000000.5
normalized:
type: integer
description: The normalized total assets in cents.
example: 100000050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total assets.
minimum: 0
maximum: 1
deductions:
type: object
description: The deductions claimed on the Form 1065 document
properties:
raw:
type: string
description: The deductions as they appear in the document.
example: 20000.25
normalized:
type: integer
description: The normalized deductions in cents.
example: 2000025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed deductions.
minimum: 0
maximum: 1
total_tax_balance_due:
type: object
description: The total tax balance due from the partnership
properties:
raw:
type: string
description: The tax balance due as it appears in the document.
example: 15000.3
normalized:
type: integer
description: The normalized tax balance due in cents.
example: 1500030
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed tax balance due.
minimum: 0
maximum: 1
total_tax_amount_owed:
type: object
description: The total tax amount owed by the partnership
properties:
raw:
type: string
description: The tax amount owed as it appears in the document.
example: 12000.5
normalized:
type: integer
description: The normalized tax amount owed in cents.
example: 1200050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed tax amount owed.
minimum: 0
maximum: 1
ordinary_business_income:
type: object
description: The ordinary business income reported on the Form 1065 document
properties:
raw:
type: string
description: The ordinary business income as it appears in the document.
example: 5000.25
normalized:
type: integer
description: The normalized ordinary business income in cents.
example: 500025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed ordinary business income.
minimum: 0
maximum: 1
Taxform1040:
type: array
description: A list of U.S. Form 1040 (Individual Income Tax Return) found in the document.
items:
type: object
properties:
taxpayer_name:
type: object
description: The taxpayer name found in the document.
properties:
raw:
type: string
description: The taxpayer name as it appears in the document.
example: John Smith
normalized:
type: string
description: The normalized taxpayer name (same as raw in this case).
example: John Smith
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed taxpayer name.
minimum: 0
maximum: 1
taxpayer_address:
type: object
description: The taxpayer address found in the document.
properties:
raw:
type: string
description: The taxpayer address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized taxpayer address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed taxpayer address.
minimum: 0
maximum: 1
social_security_number:
type: object
description: The Social Security Number (SSN) of the taxpayer
properties:
raw:
type: string
description: The SSN as it appears in the document.
example: 123-45-6789
normalized:
type: string
description: The normalized SSN (same as raw in this case).
example: 123-45-6789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed SSN.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
total_income:
type: object
description: The total income reported in the tax document.
properties:
raw:
type: string
description: The total income as it appears in the document.
example: 45000.75
normalized:
type: integer
description: The normalized total income in cents.
example: 4500075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total income.
minimum: 0
maximum: 1
deductions:
type: object
description: The deductions claimed in the tax document.
properties:
raw:
type: string
description: The deductions as they appear in the document.
example: 7500.5
normalized:
type: integer
description: The normalized deductions in cents.
example: 750050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed deductions.
minimum: 0
maximum: 1
taxable_income:
type: object
description: The taxable income calculated based on total income and deductions.
properties:
raw:
type: string
description: The taxable income as it appears in the document.
example: 37500.25
normalized:
type: integer
description: The normalized taxable income in cents.
example: 3750025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed taxable income.
minimum: 0
maximum: 1
total_tax:
type: object
description: The total tax amount calculated.
properties:
raw:
type: string
description: The total tax amount as it appears in the document.
example: 6750.3
normalized:
type: integer
description: The normalized total tax amount in cents.
example: 675030
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total tax amount.
minimum: 0
maximum: 1
total_payments:
type: object
description: The total payments made towards taxes.
properties:
raw:
type: string
description: The total payments as they appear in the document.
example: 8000
normalized:
type: integer
description: The normalized total payments in cents.
example: 800000
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total payments.
minimum: 0
maximum: 1
tax_to_be_refunded:
type: object
description: The amount of tax to be refunded to the taxpayer.
properties:
raw:
type: string
description: The refund amount as it appears in the document.
example: 500.7
normalized:
type: integer
description: The normalized refund amount in cents.
example: 50070
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed refund amount.
minimum: 0
maximum: 1
tax_owed:
type: object
description: The amount of tax owed by the taxpayer.
properties:
raw:
type: string
description: The owed tax amount as it appears in the document.
example: 1000.5
normalized:
type: integer
description: The normalized owed tax amount in cents.
example: 100050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed owed tax amount.
minimum: 0
maximum: 1
DocumentCompact:
type: object
properties:
uuid:
type: string
format: uuid
description: Unique uuid identifier for the object.
example: 6e764ab5-4617-40d5-9076-0bd0e537b4d1
id:
type: string
description: Unique integer identifier for the object.
example: '42'
name:
type: string
example: john_smith_payslip_dec20.pdf
description: The filename of the document.
created_at:
type: string
format: date-time
description: 'Time at which the object was created. In the format: yyyy-MM-dd''T''HH:mm:ssZ'
example: '2019-12-12T15:35:08.460Z'
customer_id:
type: string
format: uuid
description: The UUID of the associated Customer object
example: 684502aa-268a-4c2a-b166-ac4bfa2caf44
customer_name:
type: string
description: The name of the associated Customer object
example: John Smith
state:
type: string
description: 'The current state of the document, it has the following options: PROCESSING - This document is still being processed. PROCESSED - This document has finished processing and results are available. ERROR_PROCESSING - An error occurred while processing this document. VIRUS_DETECTED - This document was found to contain a virus and will not be processed. CORRUPT_DATA_DETECTED - This document was found to contain corrupted data and could not be processed. PASSWORD_PROTECTED - This document is password protected. EXCEEDS_MAX_PAGE_COUNT - This document exceeds the maximum page count of 350.'
enum:
- PROCESSING
- PROCESSED
- ERROR_PROCESSING
- VIRUS_DETECTED
- CORRUPT_DATA_DETECTED
- PASSWORD_PROTECTED
- EXCEEDS_MAX_PAGE_COUNT
example: PROCESSED
total_pages:
type: integer
description: The number of pages in the document. This value will be null until the document is in the PROCESSED state.
example: 1
document_type:
type: string
description: The document type identified by Inscribe's classifier. This value will be null until the document is in the PROCESSED state.
example: BANK_STATEMENT
enum:
- 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
subtypes:
type: array
description: 'A list of the document subtypes identified by Inscribe''s classifier. Currently, subtypes are identified for "TAX_FORM", "BANK_STATEMENT", "UTILITY_BILL", "PAYSLIP", "BUSINESS_FILING", and "FINANCIAL_STATEMENT" document types.
Tax documents can have the subtypes: "CP_575", "LTR_147C", "SS4", "W2", "W3", "W9", "FORM_1040", "FORM_1040_SCHEDULE_C", "FORM_1065", "FORM_1099_MISC", "FORM_1099_NEC", "FORM_1120", "FORM_1120_S", "T1", "T183", "T2", "T2_CORP", "T4", "T451".
Financial statement documents can have the subtypes: "PROFIT_AND_LOSS".
Business filing documents can have the subtypes: "CERTIFICATE_OF_INCORPORATION", "CERTIFICATE_OF_FORMATION", "CERTIFICATE_OF_ORGANIZATION", "ARTICLES_OF_ORGANIZATION", "ARTICLES_OF_INCORPORATION", "PARTNERSHIP_AGREEMENT", "CERTIFICATE_OF_GOOD_STANDING", "OPERATING_AGREEMENT". French language business filings can also have the subtypes: "VAT_REGISTRATION", "COMMERCIAL_REGISTER_EXTRACT", "ARTISAN_REGISTER_EXTRACT", "SIREN_REGISTER_EXTRACT", "SIREN_NUMBER_CONFIRMATION", "ARTICLES_OF_ASSOCIATION", "CERTIFICATE_OF_REGISTRATION", "EXTRACT_FROM_THE_OFFICIAL_GAZETTE", "RECEIPT_OF_DECLARATION_OF_CREATION".
Utility bill documents can have the subtypes: "ENGIE", "ELECTRICITE_DE_FRANCE".
Payslip documents can have the subtypes: "AUTOMATIC_DATA_PROCESSING".
The full list of subtypes for bank statements can be found at https://docs.inscribe.ai/docs/documents-classified-by-bank-names.'
items:
type: string
example: CP_575
enum:
- PROFIT_AND_LOSS
- CP_575
- LTR_147C
- SS4
- W2
- W3
- W9
- FORM_1040
- FORM_1040_SCHEDULE_C
- FORM_1065
- FORM_1099_MISC
- FORM_1099_NEC
- FORM_1120
- FORM_1120_S
- T1
- T183
- T2
- T2_CORP
- T4
- T451
- EIN_ASSIGNMENT_NOTICE
- CERTIFICATE_OF_INCORPORATION
- CERTIFICATE_OF_FORMATION
- CERTIFICATE_OF_ORGANIZATION
- ARTICLES_OF_ORGANIZATION
- ARTICLES_OF_INCORPORATION
- PARTNERSHIP_AGREEMENT
- CERTIFICATE_OF_GOOD_STANDING
- OPERATING_AGREEMENT
- VAT_REGISTRATION
- COMMERCIAL_REGISTER_EXTRACT
- ARTISAN_REGISTER_EXTRACT
- SIREN_REGISTER_EXTRACT
- SIREN_NUMBER_CONFIRMATION
- ARTICLES_OF_ASSOCIATION
- CERTIFICATE_OF_REGISTRATION
- EXTRACT_FROM_THE_OFFICIAL_GAZETTE
- RECEIPT_OF_DECLARATION_OF_CREATION
- ENGIE
- ELECTRICITE_DE_FRANCE
- COMISION_FEDERAL_DE_ELECTRICIDAD
- AUTOMATIC_DATA_PROCESSING
- CHARLES_SCHWAB
- FIDELITY_INVESTMENTS
- JP_MORGAN
- MERRILL
- ABILENE_TEACHERS_FEDERAL_CREDIT_UNION
- ABNB_FEDERAL_CREDIT_UNION
- ABOUND_CREDIT_UNION
- ACADEMY_BANK
- ACHIEVA_CREDIT_UNION
- ACNB_BANK
- ADDITION_FINANCIAL
- ADELFI
- ADVANCIAL
- ADVANTIS_CREDIT_UNION
- ADVIA_CREDIT_UNION
- AFFCU
- AFFINITY_FEDERAL_CREDIT_UNION
- AFFINITY_PLUS_FEDERAL_CREDIT_UNION
- ALABAMA_CREDIT_UNION
- ALABAMA_ONE
- ALASKA_USA_FEDERAL_CREDIT_UNION
- ALERUS
- ALLEGACY_FEDERAL_CREDIT_UNION
- ALLEGIANCE_BANK_TX
- ALLIANT_CREDIT_UNION
- ALLIED_IRISH_BANK
- ALLSOUTH_FEDERAL_CREDIT_UNION
- ALLTRU_CREDIT_UNION
- ALLY_BANK
- ALL_IN_CREDIT_UNION
- ALOHA_PACIFIC_FEDERAL_CREDIT_UNION
- ALPENA_ALCONA_AREA_CREDIT_UNION
- ALPINE_BANK
- ALTAONE_FEDERAL_CREDIT_UNION
- ALTRA_FEDERAL_CREDIT_UNION
- ALTURA_CREDIT_UNION
- AMALGAMATED_BANK
- AMARILLO_NATIONAL_BANK
- AMEGY_BANK_OF_TEXAS
- AMERANT
- AMERICAN_1_CREDIT_UNION
- AMERICAN_AIRLINES_CREDIT_UNION
- AMERICAN_BANK_OF_MISSOURI
- AMERICAN_BUSINESS_BANK
- AMERICAN_EAGLE_FINANCIAL_CREDIT_UNION
- AMERICAN_EXPRESS
- AMERICAN_FIRST_CREDIT_UNION
- AMERICAN_HERITAGE_FEDERAL_CREDIT_UNION
- AMERICAN_NATIONAL_BANK_OF_TEXAS
- AMERICAN_SAVINGS_BANK
- AMERICA_FIRST_CREDIT_UNION
- AMERICA_FIRST_FEDERAL_CREDIT_UNION
- AMERICU_CREDIT_UNION
- AMERIS_BANK
- AMOCO_FEDERAL_CREDIT_UNION
- AMPLIFY_CREDIT_UNION
- ANB_BANK
- ANDREWS_FEDERAL_CREDIT_UNION
- APCO_EMPLOYEES_CREDIT_UNION
- APG_FEDERAL_CREDIT_UNION_APGFCU
- APPLE_BANK_FOR_SAVINGS
- APPLE_FEDERAL_CREDIT_UNION
- ARBOR_FINANCIAL_CREDIT_UNION
- ARIZONA_BANK_AND_TRUST
- ARIZONA_CENTRAL_CREDIT_UNION
- ARIZONA_FINANCIAL_CREDIT_UNION
- ARKANSAS_FEDERAL_CREDIT_UNION
- ARMED_FORCES_BANK
- ARMSTRONG_BANK
- ARROWHEAD_CREDIT_UNION
- ARVEST
- ASB_BANK
- ASCEND_FEDERAL_CREDIT_UNION
- ASCENTRA_CREDIT_UNION
- ASE_CREDIT_UNION_AL
- ASSOCIATED_BANK_NA
- ASSOCIATED_CREDIT_UNION
- ATB_FINANCIAL
- ATLANTA_POSTAL_CREDIT_UNION
- ATLANTIC_FEDERAL_CREDIT_UNION
- ATLANTIC_UNION_BANK
- ATOMIC_CREDIT_UNION
- AUSTIN_BANK_TEXAS_NATIONAL_ASSOCIATION
- AUSTIN_CAPITAL_BANK
- AUSTIN_TELCO_FEDERAL_CREDIT_UNION
- AVADIAN_CREDIT_UNION
- AVIDIA_BANK
- AVID_BANK
- AXOS_BANK
- AZURA_CREDIT_UNION
- A_PLUS_FEDERAL_CREDIT_UNION
- B1BANK
- BANCFIRST
- BANGOR_SAVINGS_BANK
- BANKFIVE
- BANKPLUS
- BANKUNITED
- BANK_ALFALAH
- BANK_FIRST
- BANK_FUND_STAFF_FEDERAL_CREDIT_UNION
- BANK_INDEPENDENT
- BANK_MIDWEST
- BANQUE_NATIONALE_DU_CANADA
- BANK_OF_AMERICA
- BANK_OF_CALIFORNIA
- BANK_OF_COLORADO
- BANK_OF_GEORGE
- BANK_OF_GUAM
- BANK_OF_HAWAII
- BANK_OF_HOPE_LOS_ANGELES_CA
- BANK_OF_OKLAHOMA
- BANK_OF_SCOTLAND
- BANK_OF_SOUTHERN_CALIFORNIA_NA
- BANK_OF_THE_SIERRA
- BANK_OF_THE_WEST
- BANK_OZK
- BANK_UNITED
- BANNER_BANK
- BARCLAYS
- BARKSDALE_FEDERAL_CREDIT_UNION
- BAR_HARBOR_BANK_AND_TRUST
- BAYFIRST_NATIONAL_BANK
- BAYPORT_CREDIT_UNION
- BAY_FEDERAL_CREDIT_UNION
- BCU
- BEACON
- BEACON_CREDIT_UNION_IN
- BECU
- BEEHIVE_FEDERAL_CREDIT_UNION
- BELCO_COMMUNITY_CREDIT_UNION
- BELLCO_CREDIT_UNION
- BELL_BANK
- BERKSHIRE_BANK
- BETHPAGE_FEDERAL_CREDIT_UNION
- BLACKHAWK_COMMUNITY_CREDIT_UNION
- BLACK_HILLS_FEDERAL_CREDIT_UNION
- BLUEVINE
- BLUE_FEDERAL_CREDIT_UNION
- BLUE_SKY_BANK
- BMO_CANADA
- BMO_HARRIS_BANK
- BNP_PARIBAS
- BOK_FINANCIAL
- BONNEVILLE_BANK
- BOURSO_BANK
- BRAZOS_VALLEY_SCHOOLS_CREDIT_UNION
- BREAD_FINANCIAL
- BREMER_BANK
- BREX
- BRIDGE_BANK
- BRIGHTSTAR_CREDIT_UNION
- BROADVIEW_FEDERAL_CREDIT_UNION
- BROADWAY_NATIONAL_BANK
- BURKE_AND_HERBERT_BANK
- BUSEY_BANK
- BYLINE_BANK
- CADENCE_BANK_MS
- CAISSE_D_EPARGNE
- CALIFORNIA_COAST_CREDIT_UNION
- CALIFORNIA_CREDIT_UNION
- CALPRIVATE_BANK
- CAMBRIDGE_SAVINGS_BANK
- CAMPUS_USA_CREDIT_UNION
- CANADIAN_IMPERIAL_BANK_OF_COMMERCE
- CANADIAN_WESTERN_BANK
- CANVAS_CREDIT_UNION
- CAPCOM_FEDERAL_CREDIT_UNION
- CAPE_COD_FIVE_CENTS_SAVINGS_BANK
- CAPITAL_BANK_NATIONAL_ASSOCIATION_MD
- CAPITAL_CITY_BANK
- CAPITAL_CREDIT_UNION_ND
- CAPITAL_CREDIT_UNION_WI
- CAPITAL_EDUCATORS_FEDERAL_CREDIT_UNION
- CAPITAL_ONE
- CAPITOL_FEDERAL_SAVINGS_BANK
- CARROLLTON_BANK
- CARTER_BANK_AND_TRUST
- CASH_APP
- CASHMERE_VALLEY_BANK
- CATHAY_BANK
- CBC_FEDERAL_CREDIT_UNION
- CB_AND_S_BANK
- CEFCU
- CENTENNIAL_BANK
- CENTIER_CREDIT_UNION
- CENTRAL_BANK
- CENTRAL_BANK_AND_TRUST_CO
- CENTRAL_BANK_OF_KANSAS_CITY
- CENTRAL_ONE_FEDERAL_CREDIT_UNION
- CENTRAL_PACIFIC_BANK
- CENTRA_CREDIT_UNION
- CENTREVILLE_BANK
- CENTRIS_FEDERAL_CREDIT_UNION
- CERTIFIED_FEDERAL_CREDIT_UNION
- CFCU_COMMUNITY_CREDIT_UNION
- CHAMBERS_BANK
- CHARLES_SCHWAB_BANK
- CHARLES_SCHWAB_TRUST_BANK
- CHARLES_SCHWAB_TRUST_BANK_NV
- CHARTER_OAK_FEDERAL_CREDIT_UNION
- CHARTWAY_FEDERAL_CREDIT_UNION
- CHASE_BANK
- CHEMUNG_CANAL_TRUST_COMPANY
- CHESAPEAKE_BANK
- CHEVRON_FEDERAL_CREDIT_UNION
- CHIME
- CHINO_COMMERCIAL_BANK
- CHRISTIAN_FINANCIAL_CREDIT_UNION
- CIBC_BANK_USA
- CINFED_FEDERAL_CREDIT_UNION
- CITADEL
- CITIBANK
- CITIZENS
- CITIZENS_AND_FARMERS_BANK
- CITIZENS_BANK_RI
- CITIZENS_FIRST_BANK_FL
- CITYWIDE_BANKS
- CITY_AND_COUNTY_CREDIT_UNION
- CITY_BANK_TX
- CITY_NATIONAL_BANK
- CITY_NATIONAL_BANK_CA
- CITY_NATIONAL_BANK_OF_FLORIDA
- CITY_NATIONAL_BANK_OF_WEST_VIRGINIA
- CITY_STATE_BANK
- CIVISTA_BANK
- CLARK_COUNTY_CREDIT_UNION
- CLEARVIEW_FEDERAL_CREDIT_UNION
- CLEARWATER_CREDIT_UNION_MT
- CNB_BANK
- COASTAL1_CREDIT_UNION
- COASTALSTATES_BANK
- COASTAL_CAROLINA_NATIONAL_BANK
- COASTAL_CREDIT_UNION_NC
- COASTHILLS_CREDIT_UNION
- COAST_CENTRAL_CREDIT_UNION
- COBALT_CREDIT_UNION
- COLLINS_COMMUNITY_CREDIT_UNION
- COLONY_BANK
- COLORADO_FEDERAL_SAVINGS_BANK
- COLUMBIA_BANK
- COLUMBIA_BANK_NJ
- COLUMBIA_CREDIT_UNION_WA
- COMERICA_BANK
- COMMERCE_BANK
- COMMONWEALTH_CENTRAL_CREDIT_UNION
- COMMONWEALTH_CREDIT_UNION_KY
- COMMUNICATION_FEDERAL_CREDIT_UNION
- COMMUNITYAMERICA_CREDIT_UNION
- COMMUNITYWIDE_FEDERAL_CREDIT_UNION
- COMMUNITY_1ST_CREDIT_UNION_IA
- COMMUNITY_BANK_NATIONAL_ASSOCIATION
- COMMUNITY_BANK_OF_MISSISSIPPI
- COMMUNITY_CHOICE_CREDIT_UNION_MI
- COMMUNITY_CHOICE_CU_IA
- COMMUNITY_CREDIT_UNION_FL
- COMMUNITY_FINANCIAL_CREDIT_UNION_MI
- COMMUNITY_FINANCIAL_SERVICES_BANK
- COMMUNITY_FIRST_CREDIT_UNION
- COMMUNITY_FIRST_CREDIT_UNION_FL
- COMMUNITY_FIRST_CREDIT_UNION_WI
- COMMUNITY_NATIONAL_BANK_AND_TRUST
- COMMUNITY_RESOURCE_CREDIT_UNION
- COMMUNITY_TRUST_BANK_INC
- CONGRESSIONAL_FEDERAL_CREDIT_UNION
- CONNECTICUT_STATE_EMPLOYEES_CREDIT_UNION
- CONNECTONE_BANK
- CONNEXUS_CREDIT_UNION
- CONNEX_CREDIT_UNION
- CONSUMERS_CREDIT_UNION
- CONSUMERS_CREDIT_UNION_IL
- COOSA_VALLEY_FEDERAL_CREDIT_UNION
- CORNING_CREDIT_UNION
- CORPORATE_AMERICA_FAMILY_CREDIT_UNION
- COUNTRY_BANK_MA
- COVANTAGE_CREDIT_UNION
- CPM_FEDERAL_CREDIT_UNION
- CRANE_CREDIT_UNION
- CREDIT_HUMAN
- CREDIT_UNION_1
- CREDIT_UNION_1_IL
- CREDIT_UNION_OF_AMERICA
- CREDIT_UNION_OF_COLORADO
- CREDIT_UNION_OF_DENVER
- CREDIT_UNION_OF_SOUTHERN_CALIFORNIA
- CREDIT_UNION_OF_TEXAS
- CREDIT_UNION_ONE_MI
- CREDIT_UNION_WEST
- CROSS_RIVER_BANK
- CSE_FEDERAL_CREDIT_UNION_OH
- CTBC_BANK
- CUSTOMERS_BANK
- CYPRUS_CREDIT_UNION
- C_THREE_BANK_NA
- DACOTAH_BANK
- DADE_COUNTY_FEDERAL_CREDIT_UNION
- DALLAS_CAPITAL_BANK
- DATCU_CREDIT_UNION
- DAY_AIR_CREDIT_UNION
- DELTA_COMMUNITY_CREDIT_UNION
- DEL_NORTE_CREDIT_UNION
- DEL_ONE_FEDERAL_CREDIT_UNION
- DESJARDINS
- DESERET_FIRST_CREDIT_UNION
- DESERT_FINANCIAL
- DFCU_FINANCIAL
- DIAMOND_CREDIT_UNION
- DIGITAL_FEDERAL_CREDIT_UNION
- DIME
- DIRECTIONS_CREDIT_UNION
- DISCOVER
- DOLLAR_BANK
- DORT_FINANCIAL_CREDIT_UNION
- DOVER_FEDERAL_CREDIT_UNION
- DOW_CREDIT_UNION
- DUPACO_COMMUNITY_CREDIT_UNION
- DUPONT_COMMUNITY_CREDIT_UNION
- DUTRAC_COMMUNITY_CREDIT_UNION
- D_L_EVANS_BANK
- EASTERN_BANK
- EASTMAN_CREDIT_UNION
- EAST_IDAHO_CREDIT_UNION
- EAST_TEXAS_PROFESSIONAL_CREDIT_UNION
- EAST_WEST_BANK
- EDFED_THE_EDUCATIONAL_FEDERAL_CREDIT_UNION
- EDUCATIONAL_EMPLOYEES_CREDIT_UNION_EECU
- EDUCATIONAL_SYSTEMS_FEDERAL_CREDIT_UNION
- EDUCATORS_CREDIT_UNION
- EECU
- EFCU_FINANCIAL
- EGLIN_FEDERAL_CREDIT_UNION
- ELEMENTS_FINANCIAL
- ELEVATIONS_CREDIT_UNION
- ELGA_CREDIT_UNION
- EL_DORADO_SAVINGS_BANK_FSB
- EMIGRANT_BANK
- EMPEOPLE_CREDIT_UNION
- EMPOWER_FEDERAL_CREDIT_UNION
- EMPRISE_BANK
- ENRICHMENT_FEDERAL_CREDIT_UNION
- ENTERPRISE_BANK_AND_TRUST
- ENT_CREDIT_UNION
- ENVISION_CU_FL
- EPHRATA_NATIONAL_BANK
- EQ_BANK
- EQUITY_BANK
- ERIE_FEDERAL_CREDIT_UNION
- ESL_FEDERAL_CREDIT_UNION
- EVERBANK_FL
- EVERGREEN_CREDIT_UNION
- EVERWISE_CREDIT_UNION
- EXCHANGE_BANK
- FAIRMONT_FEDERAL_CREDIT_UNION
- FAIRWINDS_CREDIT_UNION
- FAMILY_SAVINGS_CREDIT_UNION
- FAMILY_SECURITY_CREDIT_UNION
- FAMILY_TRUST_FEDERAL_CREDIT_UNION
- FARMERS_AND_MERCHANTS_BANK
- FARMERS_AND_MERCHANTS_BANK_CA
- FARMERS_AND_MERCHANTS_BANK_OF_CENTRAL_CALIFORNIA
- FARMERS_AND_MERCHANTS_STATE_BANK
- FARMERS_INSURANCE_FEDERAL_CREDIT_UNION
- FARMERS_STATE_BANK
- FCB
- FEDEX_EMPLOYEES_CREDIT_ASSOCIATION
- FIBRE_FEDERAL_CREDIT_UNION
- FIDELITY_INVESTMENTS
- FIELDPOINT_PRIVATE
- FIFTH_THIRD_BANK
- FINANCIAL_CENTER_FIRST_CREDIT_UNION
- FINANCIAL_PARTNERS_CREDIT_UNION
- FINANCIAL_PLUS_CREDIT_UNION
- FIREFIGHTERS_FIRST_CREDIT_UNION
- FIRSTBANK
- FIRSTBANK_FL
- FIRSTLIGHT_FEDERAL_CREDIT_UNION
- FIRSTMARK_CREDIT_UNION
- FIRST_ADVANTAGE_FEDERAL_CREDIT_UNION
- FIRST_AMERICAN_BANK_IL
- FIRST_BANK_AND_TRUST_BROOKINGS_SD
- FIRST_BANK_MO
- FIRST_BANK_NC
- FIRST_CAROLINA_BANK
- FIRST_CENTURY_BANK_NATIONAL_ASSOCIATION_GA
- FIRST_CITIZENS_BANK
- FIRST_CITIZENS_FEDERAL_CREDIT_UNION
- FIRST_CITY_CREDIT_UNION
- FIRST_COMMAND_BANK
- FIRST_COMMERCE_CREDIT_UNION
- FIRST_COMMONWEALTH_BANK
- FIRST_COMMONWEALTH_FEDERAL_CREDIT_UNION
- FIRST_COMMUNITY_BANK_VA
- FIRST_COMMUNITY_CREDIT_UNION
- FIRST_COMMUNITY_CREDIT_UNION_ND
- FIRST_COMMUNITY_CREDIT_UNION_TX
- FIRST_COMMUNITY_CU_OR
- FIRST_CREDIT_UNION
- FIRST_ENTERTAINMENT_CREDIT_UNION
- FIRST_FEDERAL_LAKEWOOD
- FIRST_FED_BANK
- FIRST_FINANCIAL_BANK
- FIRST_FINANCIAL_BANK_NATIONAL_ASSOCIATION
- FIRST_FINANCIAL_BANK_NATIONAL_ASSOCIATION_IN
- FIRST_FINANCIAL_BANK_OH
- FIRST_FINANCIAL_CREDIT_UNION_NM
- FIRST_FINANCIAL_OF_MARYLAND_FEDERAL_CREDIT_UNION
- FIRST_FLORIDA_CREDIT_UNION
- FIRST_HAWAIIAN_BANK
- FIRST_HERITAGE_FEDERAL_CREDIT_UNION
- FIRST_HORIZON
- FIRST_INTERSTATE_BANK
- FIRST_MERCHANTS_BANK_MUNCIE_IN
- FIRST_MIDAMERICA_CREDIT_UNION
- FIRST_MID_BANK_AND_TRUST
- FIRST_NATIONAL_BANK
- FIRST_NATIONAL_BANK_ALASKA
- FIRST_NATIONAL_BANK_ALBANY_BRECKENRIDGE
- FIRST_NATIONAL_BANK_OF_FORT_SMITH
- FIRST_NATIONAL_BANK_OF_OMAHA
- FIRST_NATIONAL_BANK_OF_PENNSYLVANIA
- FIRST_NATIONAL_BANK_TEXAS
- FIRST_PREMIER_BANK
- FIRST_REPUBLIC_BANK
- FIRST_SECURITY_BANK_AR
- FIRST_SERVICE_CU_TX
- FIRST_SOURCE_BANK
- FIRST_SOURCE_FEDERAL_CREDIT_UNION
- FIRST_SOUTH_FINANCIAL
- FIRST_STATE_BANK_OH
- FIRST_STATE_COMMUNITY_BANK
- FIRST_TECHNOLOGY_FEDERAL_CREDIT_UNION
- FIRST_UNITED
- FIRST_UNITED_CREDIT_UNION
- FIVEPOINT_CREDIT_UNION
- FIVE_STAR_BANK
- FIVE_STAR_CREDIT_UNION
- FLAGSTAR_BANK
- FLORENCE_BANK
- FLORIDACENTRAL_CREDIT_UNION
- FLORIDA_CREDIT_UNION
- FLUSHING_BANK
- FORTERA_CREDIT_UNION
- FORT_WORTH_COMMUNITY_CREDIT_UNION
- FORUM_CREDIT_UNION
- FOUNDERS_FEDERAL_CREDIT_UNION
- FOUR_FRONT_CREDIT_UNION
- FOX_COMMUNITIES_CREDIT_UNION
- FRANDSEN_BANK_AND_TRUST
- FRANKENMUTH_CREDIT_UNION
- FRANKLIN_MINT_FEDERAL_CREDIT_UNION
- FREEDOM_CREDIT_UNION_PA
- FREEDOM_FIRST
- FRONTWAVE_CREDIT_UNION
- FROST_BANK
- FULTON_BANK_NATIONAL_ASSOCIATION
- F_AND_A_FEDERAL_CREDIT_UNION
- F_AND_M_TRUST
- GATE_CITY_BANK
- GECU
- GENERAL_ELECTRIC_CREDIT_UNION
- GENERATIONS_FEDERAL_CREDIT_UNION
- GENISYS_CREDIT_UNION
- GEORGIAS_OWN_CREDIT_UNION
- GEORGIA_UNITED_CREDIT_UNION
- GERMAN_AMERICAN_JASPER_IN
- GESA_CREDIT_UNION
- GLACIER_BANK
- GLENS_FALLS_NATIONAL_BANK_AND_TRUST_COMPANY
- GLOBAL_CREDIT_UNION_AK
- GOLDENWEST_CREDIT_UNION
- GOLDEN_1_CREDIT_UNION
- GOLDEN_PLAINS_CREDIT_UNION
- GRANITE_STATE_CREDIT_UNION
- GREATER_IOWA_CREDIT_UNION
- GREATER_NEVADA_CREDIT_UNION
- GREATER_TEXAS_FEDERAL_CREDIT_UNION
- GREAT_LAKES_CREDIT_UNION
- GREAT_SOUTHERN_BANK
- GREENSTATE_CREDIT_UNION
- GREENWOOD_CREDIT_UNION
- GREEN_DOT_BANK
- GREYLOCK_FEDERAL_CREDIT_UNION
- GROW_FINANCIAL_FEDERAL_CREDIT_UNION
- GTE_FEDERAL_CREDIT_UNION
- GUADAUPE_BANK
- GUARANTY_BANK_AND_TRUST
- GUARDIAN_CREDIT_UNION_AL
- GULF_COAST_EDUCATORS_FEDERAL_CREDIT_UNION
- GULF_WINDS_FEDERAL_CREDIT_UNION
- HALIFAX
- HANCOCK_WHITNEY
- HANMI_BANK
- HANSCOM_FEDERAL_CREDIT_UNION
- HAPO_COMMUNITY_CREDIT_UNION
- HAPPY_STATE_BANK
- HARBORONE_BANK
- HARBORSTONE_CREDIT_UNION
- HARVARD_UNIVERSITY_EMPLOYEES_CREDIT_UNION
- HATCH_BANK
- HAWAIIUSA_FEDERAL_CREDIT_UNION
- HAWAII_STATE_FCU
- HEARTLAND_BANK_AND_TRUST_COMPANY
- HERITAGE_BANK_WA
- HERITAGE_FAMILY_FEDERAL_CREDIT_UNION
- HERITAGE_FEDERAL_CREDIT_UNION
- HFS_FEDERAL_CREDIT_UNION
- HILLS_BANK
- HIWAY_CREDIT_UNION
- HOMESTREET_BANK
- HOMETOWN_COMMUNITY_BANKS
- HOMETRUST_BANK
- HONDA_FEDERAL_CREDIT_UNION
- HONOR_CREDIT_UNION
- HORIZON_BANK_IN
- HORIZON_CREDIT_UNION
- HOUSTON_FEDERAL_CREDIT_UNION
- HSBC
- HSBC_UK
- HUDSON_VALLEY_FEDERAL_CREDIT_UNION
- HUGHES_FEDERAL_CREDIT_UNION
- HUNTINGTON_NATIONAL_BANK
- IBC_BANK
- IDAHO_CENTRAL_CREDIT_UNION
- IDEAL_CREDIT_UNION
- IH_MISSISSIPPI_VALLEY_CREDIT_UNION
- ILLINOIS_BANK_AND_TRUST
- INDEPENDENT_BANK
- INDEPENDENT_FINANCIAL
- INDIANA_MEMBERS_CREDIT_UNION
- INDIANA_UNIVERSITY_CREDIT_UNION
- INDUSTRIAL_CREDIT_UNION
- ING
- INSIGHT_CREDIT_UNION
- INTEGRITY_BANK_AND_TRUST
- INTERBANK_OK
- INTERNATIONAL_BANK_OF_COMMERCE
- INTERRA_CREDIT_UNION
- INTOUCH_CREDIT_UNION
- INTRUST_BANK
- IN_BANK
- ION_BANK
- IQ_CREDIT_UNION
- ISLAND_FEDERAL_CREDIT_UNION
- ITHINK_FINANCIAL
- JEANNE_DARC_CREDIT_UNION
- JEFFERSON_FINANCIAL_FEDERAL_CREDIT_UNION
- JOHNSON_BANK
- JOHNS_HOPKINS_FEDERAL_CREDIT_UNION
- JOVIA_FINANCIAL_CREDIT_UNION
- JUSTICE_FEDERAL_CREDIT_UNION
- KEARNY_BANK
- KEESLER_FEDERAL_CREDIT_UNION
- KELLOGG_COMMUNITY_CREDIT_UNION
- KEMBA_CREDIT_UNION
- KEMBA_FINANCIAL_CREDIT_UNION
- KEYBANK
- KINECTA_FEDERAL_UNION
- KIRTLAND_CREDIT_UNION
- KITSAP_CREDIT_UNION
- KNOXVILLE_TVA_EMPLOYEES_CREDIT_UNION
- KOHLER_CREDIT_UNION
- LAFAYETTE_FEDERAL_CREDIT_UNION
- LAFCU
- LAKELAND_BANK
- LAKE_CITY_BANK
- LAKE_MICHIGAN_CREDIT_UNION
- LAKE_TRUST_CREDIT_UNION
- LANDMARK_CREDIT_UNION_WI
- LANGLEY_FEDERAL_CREDIT_UNION
- LATINO_CREDIT_UNION
- LAUNCH_CREDIT_UNION
- LA_CAPITOL_FEDERAL_CREDIT_UNION
- LBS_FINANCIAL_CREDIT_UNION
- LCA_BANK_CORPORATION
- LEADERS_CREDIT_UNION
- LEAD_BANK
- LENDINGCLUB
- LGE_COMMUNITY_CREDIT_UNION
- LIBERTY_BANK
- LIBERTY_FEDERAL_CREDIT_UNION
- LINCOLN_SAVINGS_BANK
- LISTERHILL_CREDIT_UNION
- LIVE_OAK_BANK
- LLOYDS_BANK
- LOCAL_GOVERNMENT_FEDERAL_CREDIT_UNION
- LOGIX_SMARTER_BANKING
- LONE_STAR_NATIONAL_BANK
- LOS_ANGELES_FEDERAL_CREDIT_UNION
- LOS_ANGELES_POLICE_FEDERAL_CREDIT_UNION
- L_AND_N_FEDERAL_CREDIT_UNION
- M1_FINANCE
- MACATAWA_BANK
- MACON_BANK_AND_TRUST
- MAGNIFI_FINANCIAL
- MAINSTREET_BANK
- MAINSTREET_FEDERAL_CREDIT_UNION
- MAIN_STREET_BANK_MA
- MAPS_CREDIT_UNION
- MARCUS_BY_GOLDMAN_SACHS
- MARINE_CREDIT_UNION
- MARINE_FEDERAL_CREDIT_UNION
- MATANUSKA_VALLEY_FEDERAL_CREDIT_UNION
- MAX_CREDIT_UNION
- MAYO_EMPLOYEES_FEDERAL_CREDIT_UNION
- MAZUMA_CREDIT_UNION
- MCCOY_FEDERAL_CREDIT_UNION
- MECHANICS_BANK_CA
- MECU_CREDIT_UNION
- MEDALLION_BANK
- MEMBERS_1ST_FEDERAL_CREDIT_UNION
- MEMBERS_CHOICE_CREDIT_UNION
- MEMBERS_COOPERATIVE_CREDIT_UNION
- MEMBERS_CU_NC
- MEMBERS_FIRST_CREDIT_UNION_MI
- MEMBER_ONE_FEDERAL_CREDIT_UNION
- MEOW
- MERCANTILE_BANK_MI
- MERCED_SCHOOL_EMPLOYEES_FEDERAL_CREDIT_UNION
- MERCHANTS_BANK_MN
- MERCURY
- MERITRUST_CREDIT_UNION
- MERIWEST_CREDIT_UNION
- MERRICK_BANK
- MERRIMACK_VALLEY_CREDIT_UNION
- METRO_BANK
- METRO_CITY_BANK
- METRO_CREDIT_UNION
- METRO_CREDIT_UNION_NE
- MICHIGAN_EDUCATIONAL_CREDIT_UNION
- MICHIGAN_FIRST_CREDIT_UNION
- MICHIGAN_SCHOOLS_AND_GOVERNMENT_CREDIT_UNION
- MICHIGAN_STATE_UNIVERSITY_FEDERAL_CREDIT_UNION
- MIDDLESEX_SAVINGS_BANK
- MIDFIRST_BANK
- MIDFLORIDA_CREDIT_UNION
- MIDLAND_STATE_BANK
- MIDWESTONE_BANK
- MIDWEST_AMERICA_FEDERAL_CREDIT_UNION
- MID_HUDSON_VALLEY_FEDERAL_CREDIT_UNION
- MID_MINNESOTA_FEDERAL_CREDIT_UNION
- MID_OREGON_FEDERAL_CREDIT_UNION
- MID_PENN_BANK
- MISSION_FED_CREDIT_UNION
- MODERN_BANK
- MONZO
- MORGAN_STANLEY_TRUST
- MOUNTAIN_AMERICA_CREDIT_UNION
- MUNICIPAL_CREDIT_UNION
- MVB_BANK
- M_AND_T_BANK
- NASA_FEDERAL_CREDIT_UNION
- NATIONWIDE_BUILDING_SOCIETY
- NATWEST
- NAVIGANT_CREDIT_UNION
- NAVIGATOR_CREDIT_UNION
- NAVY_CREDIT_UNION
- NBH_BANK_NA
- NBKC_BANK
- NBT_BANK
- NECHES_FEDERAL_CREDIT_UNION
- NEIGHBORHOOD_CREDIT_UNION
- NEIGHBORS_CREDIT_UNION
- NEIGHBORS_FEDERAL_CREDIT_UNION
- NEWTON_FEDERAL_BANK
- NEW_ENGLAND_FEDERAL_CREDIT_UNION
- NEWREZ
- NICOLET_NATIONAL_BANK
- NIH_FEDERAL_CREDIT_UNION
- NOBLE_CREDIT_UNION
- NORTHCOUNTRY_FEDERAL_CREDIT_UNION
- NORTHEAST_CREDIT_UNION
- NORTHERN_CREDIT_UNION
- NORTHFIELD_BANK
- NORTHLAND_AREA_FEDERAL_CREDIT_UNION
- NORTHROP_GRUMMAN_FEDERAL_CREDIT_UNION
- NORTHWEST
- NORTHWEST_BANK_PA
- NORTHWEST_FEDERAL_CREDIT_UNION
- NORTH_SHORE_BANK_FSB
- NOTRE_DAME_FEDERAL_CREDIT_UNION
- NUMARK_CREDIT_UNION
- NUMERICA_CREDIT_UNION
- NUSENDA_CREDIT_UNION
- NUVISION_CREDIT_UNION
- OCEANFIRST_BANK
- OE_FEDERAL_CREDIT_UNION
- OLD_NATIONAL_BANK
- OLD_SECOND_BANK
- OMNI_COMMUNITY_CREDIT_UNION
- ONEAZ_CREDIT_UNION
- ONEUNITED_BANK
- ONE_NEVADA_CREDIT_UNION
- ONE_TWO_ONE_FINANCIAL_CREDIT_UNION
- ONPATH_FEDERAL_CREDIT_UNION
- ONPOINT_CREDIT_UNION
- OPTUM_BANK_INC
- ORANGE_COUNTYS_CREDIT_UNION
- OREGON_COMMUNITY_CREDIT_UNION
- OREGON_STATE_CREDIT_UNION
- ORIENTAL_BANK
- ORIGIN_BANK
- ORION_FEDERAL_CREDIT_UNION
- ORNL_FEDERAL_CREDIT_UNION
- P1FCU
- PACIFIC_PREMIER_BANK
- PACIFIC_SERVICE_CREDIT_UNION
- PACIFIC_WESTERN_BANK
- PALMETTO_CITIZENS_FEDERAL_CREDIT_UNION
- PARK_COMMUNITY_CREDIT_UNION
- PARTNERS_1ST_FEDERAL_CREDIT_UNION
- PARTNERS_FEDERAL_CREDIT_UNION
- PATELCO_CREDIT_UNION
- PATRIOT_FEDERAL_CREDIT_UNION
- PAYPAL
- PAYSERA
- PC_FINANCIAL
- PEACH_STATE_FEDERAL_CREDIT_UNION
- PELICAN_STATE_CREDIT_UNION
- PENFED_CREDIT_UNION
- PENNSYLVANIA_STATE_EMPLOYEES_CREDIT_UNION
- PENN_STATE_FEDERAL_CREDIT_UNION
- PEN_AIR_CREDIT_UNION
- PEOPLESBANK
- PEOPLES_BANK
- PEOPLES_BANK_MARIETTA_OH
- PEOPLES_SECURITY_BANK_AND_TRUST
- PEOPLES_UNITED_BANK
- PEOPLE_FIRST_FEDERAL_CREDIT_UNION
- PFCU
- PHILADELPHIA_FEDERAL_CREDIT_UNION
- PIMA_FEDERAL_CREDIT_UNION
- PINNACLE
- PINNACLE_BANK_GA
- PINNACLE_BANK_NE
- PINNACLE_BANK_TN
- PIONEER_BANK
- PIONEER_FEDERAL_CREDIT_UNION
- PLAINSCAPITAL_BANK
- PNC_BANK
- POINT_BREEZE_CREDIT_UNION
- POLICE_AND_FIRE_FEDERAL_CREDIT_UNION
- POLISH_AND_SLAVIC_FEDERAL_CREDIT_UNION
- POPULAR_BANK
- PREMIER_AMERICA_CREDIT_UNION
- PREMIER_BANK_DEFIANCE_OH
- PREMIER_BANK_ROCHESTER
- PREMIER_MEMBERS_CREDIT_UNION
- PRIMEWAY_FEDERAL_CREDIT_UNION
- PRINCIPAL_BANK
- PROFED_FEDERAL_CREDIT_UNION
- PROFESSIONAL_BANK
- PROGROWTH_BANK
- PROSPERITY_BANK_TX
- PROVIDENT_CREDIT_UNION_CA
- PUBLIC_SERVICE_CREDIT_UNION_MI
- PUBLIX_EMPLOYEES_FEDERAL_CREDIT_UNION
- PURDUE_FEDERAL_CREDIT_UNION
- QUALSTAR_CREDIT_UNION
- QUEENSBOROUGH_NATIONAL_BANK
- QUORUM_FEDERAL_CREDIT_UNION
- RADIANT_CREDIT_UNION
- RADIFI_CREDIT_UNION
- RAIFFEISEN_BANK
- RAIZ_FEDERAL_CREDIT_UNION
- RALLY_CREDIT_UNION
- RBFCU
- RCB_BANK
- REDSTONE_FEDERAL_CREDIT_UNION
- REDWOOD_CREDIT_UNION
- RED_CANOE_CREDIT_UNION
- RED_RIVER_BANK
- RED_RIVER_CREDIT_UNION
- REGIONS_BANK
- RELIANT_COMMUNITY_FEDERAL_CREDIT_UNION
- RENASANT_BANK
- REPUBLIC_BANK
- REPUBLIC_BANK_PHILADELPHIA_PA
- RESOURCE_ONE_CREDIT_UNION
- REV_FEDERAL_CREDIT_UNION
- RICHWOOD_BANK
- RIDGEWOOD_SAVINGS_BANK
- RIO_GRANDE_CREDIT_UNION
- RIVERMARK_COMMUNITY_CREDIT_UNION
- RIVERVALLEY_CREDIT_UNION
- ROBINS_FINANCIAL_CREDIT_UNION
- ROCKLAND_FEDERAL_CREDIT_UNION
- ROCKLAND_TRUST_COMPANY
- ROGUE_CREDIT_UNION
- ROYAL_BANK_OF_CANADA
- ROYAL_CREDIT_UNION
- SACO_AND_BIDDEFORD_SAVINGS_INSTITUTION
- SAFE_1_CREDIT_UNION
- SAFE_CREDIT_UNION
- SAFE_FEDERAL_CREDIT_UNION
- SALEM_FIVE
- SALLIE_MAE_BANK
- SANDIA_AREA_FEDERAL_CREDIT_UNION
- SANDIA_LABORATORY_FEDERAL_CREDIT_UNION
- SANDY_SPRING_BANK
- SANTANDER
- SANTA_CLARA_COUNTY_FEDERAL_CREDIT_UNION
- SAN_DIEGO_COUNTY_CREDIT_UNION
- SAN_FRANCISCO_FEDERAL_CREDIT_UNION
- SAN_FRANCISCO_FIRE_CREDIT_UNION
- SAN_MATEO_CREDIT_UNION
- SCE_FEDERAL_CREDIT_UNION
- SCHOOLSFIRST_FEDERAL_CREDIT_UNION
- SCOTIA_BANK
- SCOTT_CREDIT_UNION
- SCU_CREDIT_UNION
- SEACOAST_BANK
- SEATTLE_CREDIT_UNION
- SEA_COMM_FEDERAL_CREDIT_UNION
- SECU
- SECURITY_BANK_OF_KANSAS_CITY
- SECURITY_CREDIT_UNION
- SECURITY_SERVICE_FEDERAL_CREDIT_UNION
- SELCO
- SELF_HELP_CREDIT_UNION
- SELF_HELP_FEDERAL_CREDIT_UNION
- SERVICE_1ST_FEDERAL_CREDIT_UNION
- SERVICE_CREDIT_UNION
- SERVU_CREDIT_UNION
- SESLOC_FEDERAL_CREDIT_UNION
- SEVEN_SEVENTEEN_CREDIT_UNION
- SHARONVIEW_FEDERAL_CREDIT_UNION
- SHELL_FEDERAL_CREDIT_UNION
- SHORE_UNITED_BANK
- SIDNEY_FEDERAL_CREDIT_UNION
- SIERRA_CENTRAL_CREDIT_UNION
- SIGNATURE_BANK
- SIGNATURE_BANK_IL
- SIKORSKY_CREDIT_UNION
- SILICON_VALLEY_BANK
- SILVER_STATE_SCHOOLS_CREDIT_UNION
- SIMMONS_BANK
- SIMPLII_FINANCIAL
- SKYLA_CREDIT_UNION
- SKYONE_FEDERAL_CREDIT_UNION
- SLASH
- SMARTBANK
- SMART_FINANCIAL_CREDIT_UNION
- SOFI
- SOLARITY_CREDIT_UNION
- SOMERSET_TRUST_COMPANY
- SOUND_CREDIT_UNION
- SOUTHERN_BANCORP
- SOUTHERN_BANK
- SOUTHERN_BANK_AND_TRUST_COMPANY
- SOUTHERN_FIRST
- SOUTHLAND_CREDIT_UNION
- SOUTHSIDE_BANK
- SOUTHSTATE_BANK
- SOUTHTRUST_BANK
- SOUTHWEST_AIRLINES_FEDERAL_CREDIT_UNION
- SOUTH_CAROLINA_FEDERAL_CREDIT_UNION
- SPACE_COAST_CREDIT_UNION
- SPERO_FINANCIAL
- SPIRE_CREDIT_UNION
- SQUARE
- SRP_FEDERAL_CREDIT_UNION
- STANFORD_FEDERAL_CREDIT_UNION
- STARLING_BANK
- STAR_FINANCIAL_BANK
- STAR_ONE_CREDIT_UNION
- STATE_BANK
- STATE_CREDIT_UNION
- STATE_DEPARTMENT_FEDERAL_CREDIT_UNION
- STATE_EMPLOYEES_CREDIT_UNION
- STATE_EMPLOYEES_CREDIT_UNION_NC
- STATE_FARM_FEDERAL_CREDIT_UNION
- STCU
- STERLING_FEDERAL_BANK
- STOCKMAN_BANK_OF_MONTANA
- STOCK_YARDS_BANK_AND_TRUST_COMPANY
- ST_ANNES_CREDIT_UNION
- ST_LOUIS_COMMUNITY_CREDIT_UNION
- ST_MARYS_BANK
- SUFFOLK_FEDERAL_CREDIT_UNION
- SUMMIT_COMMUNITY_BANK_WV
- SUMMIT_CREDIT_UNION
- SUMMIT_CREDIT_UNION_WI
- SUNCOAST_CREDIT_UNION
- SUNFLOWER_BANK_NA
- SUNMARK_CREDIT_UNION
- SUNWEST_FEDERAL_CREDIT_UNION
- SUN_COMMUNITY_FEDERAL_CREDIT_UNION
- SUN_EAST_FEDERAL_CREDIT_UNION
- SUPERIOR_CHOICE_CREDIT_UNION
- SUPERIOR_CREDIT_UNION
- SUPERIOR_CREDIT_UNION_OH
- SUSSER_BANK
- SYNCHRONY_BANK
- SYNOVUS
- S_AND_T_BANK
- TBK_BANK
- TDECU
- T_MOBILE
- TD_BANK
- TD_CANADA_TRUST
- TANGERINE
- TEACHERS_CREDIT_UNION
- TEACHERS_FEDERAL_CREDIT_UNION
- TEAM_ONE_CREDIT_UNION
- TECHNOLOGY_CREDIT_UNION
- TELHIO_CREDIT_UNION
- TENNESSEE_VALLEY_FEDERAL_CREDIT_UNION
- TEXANS_CREDIT_UNION
- TEXAS_BANK_AND_TRUST
- TEXAS_BAY_CREDIT_UNION
- TEXAS_CAPITAL_BANK
- TEXAS_TRUST_CREDIT_UNION
- TEXELL_CREDIT_UNION
- THE_BANK_OF_MISSOURI
- THE_BANK_OF_NEW_YORK_MELLON
- THE_CAMDEN_NATIONAL_BANK_ME
- THE_CANANDAIGUA_NATIONAL_BANK_AND_TRUST_COMPANY
- THE_FARMERS_NATIONAL_BANK_OF_CANFIELD
- THE_FIDELITY_BANK
- THE_FIRST
- THE_FIRST_NATIONAL_BANK_AND_TRUST_CO
- THE_NORTHERN_TRUST_COMPANY
- THE_PARK_NATIONAL_BANK
- THE_PROVIDENT_BANK
- THE_SAVINGS_BANK
- THE_SUMMIT_FEDERAL_CREDIT_UNION
- THINK_BANK
- THIRD_FEDERAL_SAVINGS_AND_LOAN
- THREE_RIVERS_FEDERAL_CREDIT_UNION
- THRIVENT_FEDERAL_CREDIT_UNION
- TIMBERLAND_BANK
- TINKER_FEDERAL_CREDIT_UNION
- TLC_COMMUNITY_CREDIT_UNION
- TOGETHER_CREDIT_UNION_MO
- TOMPKINS_COMMUNITY_BANK
- TOPLINE_FINANCIAL_CREDIT_UNION
- TOWER_FEDERAL_CREDIT_UNION
- TOWNE_BANK
- TOWN_AND_COUNTRY_FEDERAL_CREDIT_UNION
- TRAILHEAD_CREDIT_UNION
- TRAVIS_CREDIT_UNION
- TRIANGLE_CU_NH
- TRI_CITY_NATIONAL_BANK
- TRI_COUNTIES_BANK
- TROPICAL_FINANCIAL_CREDIT_UNION
- TRUE_COMMUNITY_CREDIT_UNION
- TRUE_SKY_CREDIT_UNION
- TRUIST
- TRUITY_CREDIT_UNION
- TRULIANT_FEDERAL_CREDIT_UNION
- TRUMARK_FINANCIAL_CREDIT_UNION
- TRUSTCO_BANK
- TRUSTMARK_NATIONAL_BANK
- TRUSTONE_FINANCIAL_CREDIT_UNION
- TRUWEST_CREDIT_UNION
- TTCU_FEDERAL_CREDIT_UNION
- TUCSON_FEDERAL_CREDIT_UNION
- TWINSTAR_CREDIT_UNION
- TYNDALL_FEDERAL_CREDIT_UNION
- UFIRST_CREDIT_UNION
- UMB_BANK_NATIONAL_ASSOCIATION
- UMPQUA_BANK
- UNIFY_FINANCIAL_CREDIT_UNION
- UNION_BANK
- UNION_BANK_AND_TRUST_COMPANY_NE
- UNION_SAVINGS_BANK_CT
- UNITED_BANK
- UNITED_BANK_GA
- UNITED_COMMUNITY_BANK
- UNITED_COMMUNITY_BANK_19459
- UNITED_FEDERAL_CREDIT_UNION
- UNITED_HERITAGE_CREDIT_UNION
- UNITED_NATIONS_FEDERAL_CREDIT_UNION
- UNITED_STATES_SENATE_FEDERAL_CREDIT_UNION
- UNITUS_COMMUNITY_CREDIT_UNION
- UNIVERSITY_CREDIT_UNION_CA
- UNIVERSITY_FEDERAL_CREDIT_UNION
- UNIVERSITY_OF_ILLINOIS_COMMUNITY_CREDIT_UNION
- UNIVERSITY_OF_KENTUCKY_FEDERAL_CREDIT_UNION
- UNIVERSITY_OF_MICHIGAN_CREDIT_UNION
- UNIVERSITY_OF_WISCONSIN_CREDIT_UNION
- UNIVEST_BANK_AND_TRUST_CO
- UNIWYO_FEDERAL_CREDIT_UNION
- UPGRADE
- USAA
- USALLIANCE_FINANCIAL
- USC_CREDIT_UNION
- USF_FEDERAL_CREDIT_UNION
- US_BANK
- US_EAGLE_FEDERAL_CREDIT_UNION
- UTAH_COMMUNITY_CREDIT_UNION
- UVA_COMMUNITY_CREDIT_UNION
- VALLEY
- VALLEY_FIRST_CREDIT_UNION
- VALLEY_STRONG_CREDIT_UNION
- VANCITY
- VANTAGE_CREDIT_UNION
- VANTAGE_WEST_CREDIT_UNION
- VARO
- VELOCITY_CREDIT_UNION
- VENTURA_COUNTY_CREDIT_UNION
- VERABANK
- VERIDIAN_CREDIT_UNION
- VERITEX_COMMUNITY_BANK
- VERMONT_FEDERAL_CREDIT_UNION
- VERVE_A_CREDIT_UNION
- VIBE_CREDIT_UNION
- VIBRANT_CREDIT_UNION
- VILLAGE_BANK
- VIRGINIA_CREDIT_UNION
- VISIONS_FEDERAL_CREDIT_UNION
- VISTA_BANK
- VYSTAR_CREDIT_UNION
- WAFD_BANK
- WALPOLE_COOPERATIVE_BANK
- WASHINGTON_STATE_EMPLOYEES_CREDIT_UNION
- WASHINGTON_TRUST_BANK
- WASHINGTON_TRUST_COMPANY
- WATER_AND_POWER_COMMUNITY_CREDIT_UNION
- WAVE
- WCCU_CREDIT_UNION
- WEBBANK
- WEBSTER_BANK
- WEBSTER_FIRST_FEDERAL_CREDIT_UNION
- WECU
- WELLBY
- WELLS_FARGO
- WEOKIE_CREDIT_UNION
- WESBANCO_WV
- WESCOM_CREDIT_UNION
- WESTAMERICA_BANK
- WESTCONSIN_CREDIT_UNION
- WESTERN_ALLIANCE_BANK
- WESTERRA_CREDIT_UNION
- WESTFIELD_BANK
- WESTMARK_CREDIT_UNION
- WESTREET_CREDIT_UNION
- WEX_BANK
- WE_FLORIDA_FINANCIAL
- WHITAKER_BANK
- WILDFIRE_CREDIT_UNION
- WILSON_BANK_AND_TRUST
- WINGS_FINANCIAL_CREDIT_UNION
- WINTRUST_BANK
- WISCONSIN_BANK_AND_TRUST
- WISE
- WOOD_FOREST_NATIONAL_BANK
- WORKERS_CREDIT_UNION
- WRIGHTPATT_CREDIT_UNION
- WSFS_BANK
- YOURBANK
- Y_12_FEDERAL_CREDIT_UNION
- ZEAL_CREDIT_UNION
- ZIONS_BANK
file_type:
type: string
enum:
- IMAGE_PDF
- SCAN_OCR
- TRUE_PDF
- IMAGE
- MIXED_PAGE_PDF
- EMPTY_PDF
- FLATTENED_PDF
description: The file type identified by Inscribe. This value will be null until the document is in the PROCESSED state.
example: TRUE_PDF
language:
type: string
description: The document language. More information on the available options can be found at https://docs.inscribe.ai/docs/language-field
example: en
is_fraudulent:
type:
- boolean
- 'null'
deprecated: true
description: 'Deprecated: This field is deprecated. Please use the risk_level parameter in the risk_assessment object instead. This field returns true if Inscribe''s fraud detection algorithms have identified the document as being fraudulent, or false if sufficient evidence of fraud is not found in the document. This value is only available when the document is in the PROCESSED state.'
example: true
trust_score:
type:
- integer
- 'null'
description: 'The trust score of a document, between 0 and 100. More information can be found at https://help.inscribe.ai/en/articles/5557654-trust-score. Note: We recommend using the risk_level parameter in the risk_assessment object instead.'
example: 50
quality_score:
type:
- integer
- 'null'
description: The quality score of a document, between 0 and 100. More information can be found at https://help.inscribe.ai/en/articles/5567690-quality-score.
example: 50
review_status:
type: string
description: The current status of document level feedback. More information can be found at https://help.inscribe.ai/en/articles/8523290-document-level-feedback.
example: ACCEPTED
enum:
- ACCEPTED
- REJECTED
- REQUIRES_REVIEW
deprecated: true
review:
$ref: '#/components/schemas/Review'
urls:
type: object
properties:
web_app:
type: string
description: A URL to the location of this document on our web app.
example: https://app.inscribe.ai/#/customer/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b/document/1234
api:
type: string
description: A URL to the location of this document on our API.
example: https://api.inscribe.ai/api/v2/customers/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b/documents/1234
original_file:
type: string
description: A URL to the location of the original document uploaded to us.
example: https://production-us-west-2-assets.inscribeusercontent.com/files/users/123/documents/8a2d3b0c-27be-4513-91ab-52c6e0a19691_document.png
risk_assessment:
type: object
description: Risk assessment information for the document, including risk level, summary analysis, and detailed insights. This will only be available when the document has finished processing and the AI Fraud Analyst has subsequently finished its review.
properties:
risk_level:
type: string
description: The risk level assigned to the document.
enum:
- LOW
- MEDIUM
- HIGH
- NOT_APPLICABLE
summary:
type: string
description: A summary of the document analysis.
example: 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: array
description: List of fraud signals and verifications about the document.
items:
type: object
properties:
type:
type: string
description: The type of insight. More information on the available options can be found at https://docs.inscribe.ai/docs/document-insights
example: INVOICE_SELLER_EXISTENCE
result:
type: string
description: The result of the fraud signal or verification.
enum:
- PASS
- INCONCLUSIVE
- FAIL
example: FAIL
title:
type:
- string
- 'null'
description: A title describing the insight.
example: Existence of ABC Company Ltd.
rationale:
type:
- string
- 'null'
description: Detailed explanation supporting the insight result.
example: Unable to verify the existence of the seller 'ABC Company Ltd.' through business registries and online presence checks.
urls:
type:
- array
- 'null'
description: URLs with the sources that support the insight result.
items:
type: string
example:
- https://businessregistry.example.com/search?q=abc-company-ltd
Taxform1099NEC:
type: array
description: A list of U.S. Form 1099-NEC (Non-Employee Compensation) found in the document.
items:
type: object
properties:
payers_name:
type: object
description: The payer name found in the document.
properties:
raw:
type: string
description: The payer name as it appears in the document.
example: John Smith
normalized:
type: string
description: The normalized payer name (same as raw in this case).
example: John Smith
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed payer name.
minimum: 0
maximum: 1
payers_address:
type: object
description: The payer address found in the document.
properties:
raw:
type: string
description: The payer address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized payer address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed payer address.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
payers_tin:
type: object
description: The Taxpayer Identification Number (TIN) of the payer
properties:
raw:
type: string
description: The TIN of the payer as it appears in the document.
example: 12-3456789
normalized:
type: string
description: The normalized TIN of the payer (same as raw in this case).
example: 12-3456789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed TIN of the payer.
minimum: 0
maximum: 1
state_tax_withheld:
type: object
description: The state tax withheld by the payer
properties:
raw:
type: string
description: The state tax withheld as it appears in the document.
example: 250.5
normalized:
type: integer
description: The normalized state tax withheld in cents.
example: 25050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed state tax withheld.
minimum: 0
maximum: 1
state_income:
type: object
description: The state income reported in the document
properties:
raw:
type: string
description: The state income as it appears in the document.
example: 5000.75
normalized:
type: integer
description: The normalized state income in cents.
example: 500075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed state income.
minimum: 0
maximum: 1
recipients_tin:
type: object
description: The Taxpayer Identification Number (TIN) of the recipient
properties:
raw:
type: string
description: The TIN of the recipient as it appears in the document.
example: 98-7654321
normalized:
type: string
description: The normalized TIN of the recipient (same as raw in this case).
example: 98-7654321
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed TIN of the recipient.
minimum: 0
maximum: 1
recipients_name:
type: object
description: The name of the recipient
properties:
raw:
type: string
description: The name of the recipient as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized name of the recipient (same as raw in this case).
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed name of the recipient.
minimum: 0
maximum: 1
recipients_address:
type: object
description: The address of the recipient
properties:
raw:
type: string
description: The address of the recipient as it appears in the document.
example: 123 Main St, Anytown
normalized:
type: string
description: The normalized address of the recipient. Where possible, this will be in the format Address Line 1, Address Line 2, Postcode, City, State, Country
example: 123 Main St, Anytown, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed address of the recipient.
minimum: 0
maximum: 1
non_employee_compensation:
type: object
description: Non-employee compensation reported in the document
properties:
raw:
type: string
description: Non-employee compensation as it appears in the document.
example: 1500.25
normalized:
type: integer
description: The normalized non-employee compensation in cents.
example: 150025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed non-employee compensation.
minimum: 0
maximum: 1
federal_income_tax_withheld:
type: object
description: The federal income tax withheld by the payer
properties:
raw:
type: string
description: The federal income tax withheld as it appears in the document.
example: 200.5
normalized:
type: integer
description: The normalized federal income tax withheld in cents.
example: 20050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed federal income tax withheld.
minimum: 0
maximum: 1
account_number:
type: object
description: Account number associated with the payment.
properties:
raw:
type: string
description: The account number as it appears in the document.
example: 12345678
normalized:
type: string
description: The normalized account number (same as raw in this case).
example: 12345678
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed account number.
minimum: 0
maximum: 1
Taxform1120s:
type: array
description: A list of U.S. Form 1120-S (Income Tax Return for an S Corporation) found in the document.
items:
type: object
properties:
corporation_name:
type: object
description: The corporation name found in the document.
properties:
raw:
type: string
description: The corporation name as it appears in the document.
example: ACME Inc.
normalized:
type: string
description: The normalized corporation name (same as raw in this case).
example: ACME Inc.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed corporation name.
minimum: 0
maximum: 1
corporation_address:
type: object
description: The corporation address found in the document.
properties:
raw:
type: string
description: The corporation address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized corporation address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed corporation address.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the S Corporation
properties:
raw:
type: string
description: The EIN as it appears in the document.
example: 12-3456789
normalized:
type: string
description: The normalized EIN (same as raw in this case).
example: 12-3456789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed EIN.
minimum: 0
maximum: 1
total_assets:
type: object
description: The total assets of the S Corporation
properties:
raw:
type: string
description: The total assets as they appear in the document.
example: 1000000.5
normalized:
type: integer
description: The normalized total assets in cents.
example: 100000050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total assets.
minimum: 0
maximum: 1
total_income:
type: object
description: The total income reported on the Form 1120S document
properties:
raw:
type: string
description: The total income as it appears in the document.
example: 750000.75
normalized:
type: integer
description: The normalized total income in cents.
example: 75000075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total income.
minimum: 0
maximum: 1
deductions:
type: object
description: The deductions claimed on the Form 1120S document
properties:
raw:
type: string
description: The deductions as they appear in the document.
example: 200000.25
normalized:
type: integer
description: The normalized deductions in cents.
example: 20000025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed deductions.
minimum: 0
maximum: 1
ordinary_business_income:
type: object
description: The ordinary business income reported on the Form 1120S document
properties:
raw:
type: string
description: The ordinary business income as it appears in the document.
example: 5000.25
normalized:
type: integer
description: The normalized ordinary business income in cents.
example: 500025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed ordinary business income.
minimum: 0
maximum: 1
tax_owed:
type: object
description: The total tax amount owed by the S Corporation.
properties:
raw:
type: string
description: The tax amount owed as it appears in the document.
example: 1500.3
normalized:
type: integer
description: The normalized tax amount owed in cents.
example: 150030
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed tax amount owed.
minimum: 0
maximum: 1
DocumentUpdateRequest:
type: object
properties:
tags:
type: array
description: The tags you want to update on a document.
items:
$ref: '#/components/schemas/UploadTag'
review_status:
type: string
description: The new status of document level feedback. More information can be found at https://help.inscribe.ai/en/articles/8523290-document-level-feedback.
example: ACCEPTED
enum:
- ACCEPTED
- REJECTED
- REQUIRES_REVIEW
deprecated: true
review:
description: A manual review decision for the document. This field is ignored if `review_status` is also provided.
allOf:
- $ref: '#/components/schemas/Review'
verify_entity:
$ref: '#/components/schemas/VerificationRequestPluralizedFormsOnly'
ParsedAmount:
type: object
properties:
raw:
type: string
description: The amount as it appears on the document.
normalized:
type: integer
description: The normalized amount in cents.
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output.
UploadTag:
type: object
required:
- text
properties:
text:
type: string
description: A descriptive value chosen by you to group documents together across customers.
example: onboarding
Review:
type: object
description: Represents a manual review decision.
properties:
status:
type: string
description: The new status of the review decision.
example: REJECTED
enum:
- ACCEPTED
- REJECTED
- REQUIRES_REVIEW
reason:
type:
- string
- 'null'
description: The reason for rejection. This field is only supported when `status` is `REJECTED`. `null` when no reason has been set.
example: FRAUD
enum:
- FRAUD
- CREDIT_RISK
- OTHER
comment:
type:
- string
- 'null'
maxLength: 2000
description: A free-text comment providing additional context for the review decision.
example: Rejected due to suspected fraudulent activity
TaxformLTR147C:
type: array
description: A list of U.S. Letter 147C (EIN Verification Letter) found in the document.
items:
type: object
properties:
proprietor_name:
type: object
description: The proprietor name found in the document.
properties:
raw:
type: string
description: The proprietor name as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized proprietor name. In this case, the normalized value is the same as the raw value.
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the business
properties:
raw:
type: string
description: The employer identification number as it appears in the document.
example: 12-6554311
normalized:
type: string
description: The normalized employer identification number. In this case, the normalized value is the same as the raw value.
example: 12-6554311
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
TaxformW2:
type: array
description: A list of U.S. Form W-2, Wage and Tax statements found in the document.
items:
type: object
properties:
employer_name:
type: object
description: The name of the employer
properties:
raw:
type: string
description: The employer name as it appears in the document.
example: John Doe
normalized:
type: string
description: The normalized employer name. In this case, the normalized value is the same as the raw value.
example: John Doe
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
employer_address:
type: object
description: The address of the employer
properties:
raw:
type: string
description: The employer address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized employer address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the employer
properties:
raw:
type: string
description: The employer identification number as it appears in the document.
example: 12-6554311
normalized:
type: string
description: The normalized employer identification number. In this case, the normalized value is the same as the raw value.
example: 12-6554311
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
social_security_number:
type: object
description: The Social Security Number (SSN) of the employee
properties:
raw:
type: string
description: The social security number as it appears in the document.
example: 999-99-9999
normalized:
type: string
description: The normalized social security number. In this case, the normalized value is the same as the raw value.
example: 999-99-9999
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
wages_tips_comp:
type: object
description: The wages, tips and other employee compensation
properties:
raw:
type: string
description: The wages, tips and other compensation amount as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer giving the wages, tips and other compensation in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
fed_income_tax_withheld:
type: object
description: The federal income tax withheld from employee pay
properties:
raw:
type: string
description: The amount of federal income tax withheld from pay as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer giving the federal income tax withheld from pay in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
social_security_wages:
type: object
description: The employee wages subject to social security tax
properties:
raw:
type: string
description: The amount of wages subject to social security tax as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer of wages subject to social security tax in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
state_wages_tips:
type: object
description: The employee wages subject to state tax
properties:
raw:
type: string
description: The amount of wages and tips subject to state tax as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer of wages and tips subject to state tax in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
social_security_tax_withheld:
type: object
description: The social security tax withheld from employee pay
properties:
raw:
type: string
description: The amount of social security tax withheld from pay as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer giving the social security tax withheld from pay in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
medicare_wages_tips:
type: object
description: The employee wages subject to medicare tax
properties:
raw:
type: string
description: The amount of wages and tips subject to medicare tax as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer of wages and tips subject to medicare tax in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
medicare_tax_withheld:
type: object
description: The medicare tax withheld from employee pay
properties:
raw:
type: string
description: The amount of medicare tax withheld from pay as it appears in the document.
example: 123.45
normalized:
type: integer
description: A signed integer giving the medicare tax withheld from pay in cents.
example: 12345
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed output.
minimum: 0
maximum: 1
Error:
type: object
properties:
message:
type: string
example: error message
required:
- message
Address:
type: object
description: The structured address. Any or all of these fields can be empty
properties:
line_1:
type:
- string
- 'null'
description: First line of the address
example: 742 Evergreen Terrace
line_2:
type:
- string
- 'null'
description: Second line of the address
example: Springfield
city:
type:
- string
- 'null'
description: City of the address
example: Springfield
post_code:
type:
- string
- 'null'
description: Post code of the address
example: '62704'
state:
type:
- string
- 'null'
description: State field of the address
example: IL
country:
type:
- string
- 'null'
description: Country of the address
example: USA
Taxform1040ScheduleC:
type: array
description: A list of U.S. Form 1040 Schedule C (Profit or Loss from Business) found in the document.
items:
type: object
properties:
proprietor_name:
type: object
description: The proprietor name found in the document.
properties:
raw:
type: string
description: The proprietor name as it appears in the document.
example: John Smith
normalized:
type: string
description: The normalized proprietor name (same as raw in this case).
example: John Smith
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed proprietor name.
minimum: 0
maximum: 1
business_name:
type: object
description: The business name found in the document.
properties:
raw:
type: string
description: The business name as it appears in the document.
example: ACME Inc.
normalized:
type: string
description: The normalized business name (same as raw in this case).
example: ACME Inc.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed business name.
minimum: 0
maximum: 1
business_address:
type: object
description: The business address found in the document.
properties:
raw:
type: string
description: The business address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized business address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed business address.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the taxpayer's business
properties:
raw:
type: string
description: The EIN as it appears in the document.
example: 12-3456789
normalized:
type: string
description: The normalized EIN (same as raw in this case).
example: 12-3456789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed EIN.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
social_security_number:
type: object
description: The Social Security Number (SSN) of the taxpayer
properties:
raw:
type: string
description: The SSN as it appears in the document.
example: 123-45-6789
normalized:
type: string
description: The normalized SSN (same as raw in this case).
example: 123-45-6789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed SSN.
minimum: 0
maximum: 1
gross_profit:
type: object
description: The gross profit from the taxpayer's business
properties:
raw:
type: string
description: The gross profit as it appears in the document.
example: 25000.75
normalized:
type: integer
description: The normalized gross profit in cents.
example: 2500075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed gross profit.
minimum: 0
maximum: 1
gross_income:
type: object
description: The gross income from the taxpayer's business
properties:
raw:
type: string
description: The gross income as it appears in the document.
example: 35000.5
normalized:
type: integer
description: The normalized gross income in cents.
example: 3500050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed gross income.
minimum: 0
maximum: 1
total_expenses:
type: object
description: The total expenses incurred by the taxpayer's business
properties:
raw:
type: string
description: The total expenses as they appear in the document.
example: 10000.25
normalized:
type: integer
description: The normalized total expenses in cents.
example: 1000025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total expenses.
minimum: 0
maximum: 1
net_profit:
type: object
description: The net profit calculated from the gross profit and total expenses
properties:
raw:
type: string
description: The net profit as it appears in the document.
example: 25000.25
normalized:
type: integer
description: The normalized net profit in cents.
example: 2500025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed net profit.
minimum: 0
maximum: 1
cost_of_goods_sold:
type: object
description: The cost of goods sold found in the tax form.
properties:
raw:
type: string
description: The cost of goods sold as it appears in the document.
example: 25000.25
normalized:
type: integer
description: The normalized cost of goods sold in cents.
example: 2500025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed cost of goods sold.
minimum: 0
maximum: 1
total_other_expenses:
type: object
description: The total other expenses found in the tax form.
properties:
raw:
type: string
description: The total other expenses as it appears in the document.
example: 25000.25
normalized:
type: integer
description: The normalized total other expenses in cents.
example: 2500025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total other expenses.
minimum: 0
maximum: 1
BenefitsStatements:
type: array
description: 'An array of income amounts parsed from a benefits statement. Currently, only the first set of amounts present in a document is returned. If the document isn''t of type `BENEFITS_STATEMENT`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service.
'
items:
type: object
required:
- gross_amount
- net_amount
- payment_amount
properties:
gross_amount:
description: 'The parsed gross income amount, before deductions. An empty object is returned if not present.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $2,951.67
normalized: 295167
confidence: 0.9
net_amount:
description: 'The parsed net income amount, after deductions. An empty object is returned if not present.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $2,613.75
normalized: 261375
confidence: 0.9
payment_amount:
description: 'The parsed payment amount, returned when the document reports a single amount without deductions. An empty object is returned if not present.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $3,509
normalized: 350900
confidence: 0.9
Tag:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier for the tag.
example: ce1d4123-b482-4409-8177-cdf363bea111
value:
type: string
description: A descriptive string chosen by you to group documents together across customers.
example: onboarding
Taxform1120:
type: array
description: A list of U.S. Form 1120 (Corporation Income Tax Return) found in the document.
items:
type: object
properties:
corporation_name:
type: object
description: The corporation name found in the document.
properties:
raw:
type: string
description: The corporation name as it appears in the document.
example: ACME Inc.
normalized:
type: string
description: The normalized corporation name (same as raw in this case).
example: ACME Inc.
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed corporation name.
minimum: 0
maximum: 1
corporation_address:
type: object
description: The corporation address found in the document.
properties:
raw:
type: string
description: The corporation address as it appears in the document.
example: 1000 Walnut Kansas City MO 64106-3686
normalized:
type: string
description: The normalized corporation address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed corporation address.
minimum: 0
maximum: 1
year_issued:
type: object
description: The parsed year of issuance found in the document.
properties:
raw:
type: string
description: The parsed document year as it appears in the document.
example: 2024
normalized:
type: string
description: The normalized document year (same as raw in this case).
example: 2024
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed document year.
minimum: 0
maximum: 1
employer_identification_number:
type: object
description: The Employer Identification Number (EIN) of the corporation
properties:
raw:
type: string
description: The EIN as it appears in the document.
example: 12-3456789
normalized:
type: string
description: The normalized EIN (same as raw in this case).
example: 12-3456789
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed EIN.
minimum: 0
maximum: 1
total_assets:
type: object
description: The total assets of the corporation
properties:
raw:
type: string
description: The total assets as they appear in the document.
example: 10000000.5
normalized:
type: integer
description: The normalized total assets in cents.
example: 1000000050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total assets.
minimum: 0
maximum: 1
total_income:
type: object
description: The total income reported on the Form 1120 document
properties:
raw:
type: string
description: The total income as it appears in the document.
example: 750000.75
normalized:
type: integer
description: The normalized total income in cents.
example: 75000075
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total income.
minimum: 0
maximum: 1
deductions:
type: object
description: The deductions claimed on the Form 1120 document
properties:
raw:
type: string
description: The deductions as they appear in the document.
example: 200000.25
normalized:
type: integer
description: The normalized deductions in cents.
example: 20000025
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed deductions.
minimum: 0
maximum: 1
taxable_income:
type: object
description: The taxable income calculated based on total income and deductions
properties:
raw:
type: string
description: The taxable income as it appears in the document.
example: 550000.5
normalized:
type: integer
description: The normalized taxable income in cents.
example: 55000050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed taxable income.
minimum: 0
maximum: 1
tax_owed:
type: object
description: The total tax amount owed by the corporation
properties:
raw:
type: string
description: The tax amount owed as it appears in the document.
example: 150000.3
normalized:
type: integer
description: The normalized tax amount owed in cents.
example: 15000030
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed tax amount owed.
minimum: 0
maximum: 1
total_payments_and_credits:
type: object
description: The total payments and tax credits made by the corporation
properties:
raw:
type: string
description: The total payments and credits as they appear in the document.
example: 200000.5
normalized:
type: integer
description: The normalized total payments and credits in cents.
example: 20000050
confidence:
type: number
format: float
description: A value between 0 and 1 indicating the confidence in the parsed total payments and credits.
minimum: 0
maximum: 1
ListDocuments:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Document'
description: A map with a data property that contains an array of documents that have been uploaded. Each entry in the array is a separate document object.
metadata:
type: object
properties:
pagination:
type: object
properties:
limit:
type: integer
description: The limit on the number of documents that can be returned. per page.
example: 10
current_page:
type: integer
description: The current page number.
example: 1
number_of_pages:
type: integer
description: The total number of pages available with the current query parameters.
example: 1
total:
type: integer
description: The total number of documents available with the current query parameters.
example: 1
fraud_results:
type: object
properties:
fraudulent_count:
type: integer
description: The number of fraudulent documents in this customer.
example: 1
UtilityBills:
type: array
description: 'An array of utility bills found in the document. Currently, only the first utility bill present in a document is returned. If the document isn''t of type `UTILITY_BILL`, the key will not be present in the response. Advanced parsing must be enabled by Inscribe for your account before the results are available, otherwise the key will be omitted from the response. You can contact Inscribe via intercom to enquire about enabling the service.
'
items:
type: object
required:
- account_number
- amount_due
- period_start
- period_end
- service_provider_name
- service_provider_address
- service_provider_website_url
properties:
account_number:
type: object
description: 'The parsed customer account number from the utility bill. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The account number as it appears on the document
example: 1234-567890
normalized:
type: string
description: The normalized account number with punctuation and spaces removed.
example: '1234567890'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
amount_due:
description: 'The parsed amount due on the utility bill. An empty object is returned if a matching result has not been found.
'
allOf:
- $ref: '#/components/schemas/ParsedAmount'
example:
raw: $100.00
normalized: 10000
confidence: 0.99
period_start:
type: object
description: 'The parsed billing period start date. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The period start date as it appears on the document
example: 01/01/2024
normalized:
type: string
format: date
description: The normalized billing period start date in ISO format.
example: '2024-01-01'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
period_end:
type: object
description: 'The parsed billing period end date. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The period end date as it appears on the document
example: 01/31/2024
normalized:
type: string
format: date
description: The normalized billing period end date in ISO format.
example: '2024-01-31'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
service_provider_name:
type: object
description: 'The parsed utility service provider name. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The service provider name as it appears on the document
example: City Power & Light
normalized:
type: string
description: The normalized service provider name. In this case the returned normalized value is the same as raw.
example: City Power & Light
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
service_provider_address:
type: object
description: 'The parsed service provider address. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The service provider address as it appears on the document.
example: 1000 walnut kansas city
normalized:
type: string
description: The normalized form of the service provider address.
example: 1000 Walnut St, Kansas City, MO 64106, USA
structured:
$ref: '#/components/schemas/Address'
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
service_provider_website_url:
type: object
description: 'The parsed service provider website URL. An empty object is returned if a matching result has not been found.
'
properties:
raw:
type: string
description: The website URL as it appears on the document
example: www.citypowerandlight.com
normalized:
type: string
description: The normalized website URL. In this case the returned normalized value is the same as raw.
example: www.citypowerandlight.com
confidence:
type: number
format: float
minimum: 0
maximum: 1
description: A number between 0 and 1 indicating the confidence in the parsed output
example: 0.99
responses:
PermissionDenied:
description: You do not have permission to access this resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: Too many requests. The request has been rate limited. For more information, visit our [documentation on rate limiting](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited).
content:
text/plain:
example: Requests are limited to 200 requests over a 5 minute period. Please try again in 30 seconds
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
example: 30
NotFound:
description: The specified resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BadRequest:
description: You have provided incorrect data.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
x-default: Inscribe
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
x-explorer-enabled: false
x-samples-enabled: false
x-samples-languages:
- curl
- python
- node
x-provenance:
method: searched
source: https://docs.inscribe.ai/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.inscribe.ai/reference/addcustomer.md
- https://docs.inscribe.ai/reference/adddocumentrequest.md
- https://docs.inscribe.ai/reference/createsession.md
- https://docs.inscribe.ai/reference/deletecustomer.md
- https://docs.inscribe.ai/reference/deletedocument.md
- https://docs.inscribe.ai/reference/deletedocumentrequest.md
- https://docs.inscribe.ai/reference/deleteopenbankingdata.md
- https://docs.inscribe.ai/reference/deleteplaidassetreport.md
- https://docs.inscribe.ai/reference/getbankaccount.md
- https://docs.inscribe.ai/reference/getbankaccountcreditanalysis.md
- https://docs.inscribe.ai/reference/getbankaccountcreditanalysiscashflowinsights.md
- https://docs.inscribe.ai/reference/getbankaccountcreditanalysisexpenditureinsights.md
- https://docs.inscribe.ai/reference/getbankaccountcreditanalysisincomeinsights.md
- https://docs.inscribe.ai/reference/getbankaccountcreditanalysisloaninsights.md
- https://docs.inscribe.ai/reference/getbankaccountcreditanalysisriskinsights.md
- https://docs.inscribe.ai/reference/getbankaccounts.md
- https://docs.inscribe.ai/reference/getbankaccounttransactions.md
- https://docs.inscribe.ai/reference/getcollectsession.md
- https://docs.inscribe.ai/reference/getcollectsessions.md
- https://docs.inscribe.ai/reference/getcustomer.md
- https://docs.inscribe.ai/reference/getcustomercreditanalysis.md
- https://docs.inscribe.ai/reference/getcustomercreditanalysiscashflowinsights.md
- https://docs.inscribe.ai/reference/getcustomercreditanalysisexpenditureinsights.md
- https://docs.inscribe.ai/reference/getcustomercreditanalysisincomeinsights.md
- https://docs.inscribe.ai/reference/getcustomercreditanalysisloaninsights.md
- https://docs.inscribe.ai/reference/getcustomercreditanalysisriskinsights.md
- https://docs.inscribe.ai/reference/getcustomers.md
- https://docs.inscribe.ai/reference/getcustomertransactions.md
- https://docs.inscribe.ai/reference/getdocumentresults.md
- https://docs.inscribe.ai/reference/getdocuments.md
- https://docs.inscribe.ai/reference/getopenbankingdata.md
- https://docs.inscribe.ai/reference/getplaidassetreport.md
- https://docs.inscribe.ai/reference/gettransactioncategories.md
- https://docs.inscribe.ai/reference/reachability-check-2.md
- https://docs.inscribe.ai/reference/recategorizetransactions.md
- https://docs.inscribe.ai/reference/updatecollectsession.md
- https://docs.inscribe.ai/reference/updatecustomer.md
- https://docs.inscribe.ai/reference/updatedocument.md
- https://docs.inscribe.ai/reference/uploaddocuments.md
- https://docs.inscribe.ai/reference/uploadinscribeopenbankingdata.md
- https://docs.inscribe.ai/reference/uploadmxaggregatedopenbankingdata.md
- https://docs.inscribe.ai/reference/uploadplaidassetreport.md
- https://docs.inscribe.ai/reference/uploadplaidassetreportopenbankingdata.md
merge:
pages: 43
deduped: 485
conflicts_kept_first: 0