Ocrolus Capture API
The Capture API from Ocrolus — 7 operation(s) for capture.
OpenAPI Specification
openapi: 3.0.0
info:
title: Account Level Webhooks Book Commands Capture API
version: 1.0.0
servers:
- url: https://api.ocrolus.com
security:
- oauth: []
tags:
- name: Capture
paths:
/v1/book/forms:
get:
summary: Book form data
operationId: book-form-data
description: 'Retrieve data for all forms uploaded to a <<glossary:Book>>.
---
A detailed description of the response can be found on the [form data](https://docs.ocrolus.com/docs/form-data) data type definition.'
tags:
- Capture
parameters:
- name: book_uuid
in: query
description: The unique identifier of the <<glossary:Book>> that contains the form data. Mutually exclusive with `pk`.
example: 19aab921-25a5-4beb-a59e-ac72320061d6
schema:
type: string
- name: pk
in: query
description: The <<glossary:PK>> of the <<glossary:Book>> that contains the form data. Mutually exclusive with `book_uuid`.
example: '30219565'
schema:
type: string
x-readme:
samples-languages:
- curl
- python
explorer-enabled: false
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 200
response:
type: object
description: An object received from the server that potentially contains data.
properties:
pk:
type: integer
description: Unique primary key for the <<glossary:Book>>.
example: 133771
uuid:
type: string
description: Universally unique identifier (UUID) for the <<glossary:Book>>.
example: 988a30fe-d25e-40b4-9724-f4c06bacbab5
name:
type: string
description: Name of the <<glossary:Book>> from which information is retrieved.
example: Example Book
created:
type: string
description: A timestamp of when the <<glossary:Book>> was created.
example: '2023-03-29T18:45:04Z'
created_ts:
type: string
description: A timestamp of when the <<glossary:Book>> was created.
example: '2023-03-29T18:45:04Z'
verified_pages_count:
type: integer
description: The total number of pages that have completed verficiation in this <<glossary:Book>>x.
example: 6
book_status:
type: string
description: The verification status of the <<glossary:Book>>.
example: ACTIVE
id:
type: integer
description: Unique primary key for the <<glossary:Book>>.
example: 133771
forms:
type: array
description: An array of forms that have been uploaded to this <<glossary:Book>>.
items:
type: object
properties:
pk:
type: integer
description: Unique primary key for the form.
example: 12304
uuid:
type: string
description: Universally unique identifier (UUID) for the form.
example: e6d7d3c7-444c-4cf3-99c7-65bdabb309f9
uploaded_doc_pk:
type: integer
description: A unique integer of the <<glossary:Document>> that the form is associated with.
example: 1555125
form_type:
type: string
description: The Document type of the form.
example: ACCOUNT_SUMMARY
raw_fields:
type: object
description: An object containing data related to the data captured from the form. This may vary amongst different form types.
properties:
examplefield:field_name:
type: object
description: Information recorded from the uploaded Document.
properties:
value:
type: string
description: The recorded value found in the field.
example: '1379.82'
is_empty:
type: boolean
description: Describes if the field contains information.
example: false
alias_used:
type: string
description: Alias used for the field.
example: null
source_filename:
type: string
description: The source of the information recorded in the field.
example: simple_bank_statement.pdf
subfields:
type: object
description: An optional object that contains information in nested fields.
properties:
value:
type: string
description: The recorded value found in the field.
example: '1379.82'
is_empty:
type: boolean
description: Describes if the field contains information.
example: false
alias_used:
type: string
description: Alias used for the field.
example: null
source_filename:
type: string
description: The source of the information recorded in the field.
example: simple_bank_statement.pdf
confidence:
type: number
description: The confidence score associated with this field.
form_config_pk:
type: integer
description: Unique primary key for the form config.
example: 1013
tables:
type: array
description: An array of tables associated with the form.
example: []
attribute_data:
type: object
description: Additional data related to the form.
properties:
period_pk:
type: integer
description: Unique primary key for a transaction period.
example: 101948
book_is_complete:
type: boolean
description: Determines if all Documents in the <<glossary:Book>> have completed verification.
example: true
message:
type: string
description: A textual description that indicates details about this response's status.
example: OK
examples:
Success:
value:
status: 200
response:
pk: 33050664
uuid: 9940d6b3-808b-47f2-936c-e05a8b767f00
name: Example Book
created: '2023-05-03T16:09:46Z'
created_ts: '2023-05-03T16:09:46Z'
verified_pages_count: 1
book_status: ACTIVE
id: 33050664
forms:
- pk: 46420211
uuid: cd26e2a3-8744-474a-a759-f42c025674e2
uploaded_doc_pk: 54857464
form_type: DRIVERS_LICENSE
raw_fields:
drivers_license-General:dob:
value: 01/06/1958
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:zip:
value: 99999-1234
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:city:
value: YOUR CITY
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:state:
value: WA
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:suffix:
value: ''
is_empty: true
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:idNumber:
value: WDLABCD456DG
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:lastName:
value: SAMPLE
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:firstName:
value: ALEXANDER
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:issueDate:
value: 01/06/2015
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:middleName:
value: HAMILTON
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:countryName:
value: UNITED STATES
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:addressLine1:
value: 123 STREET ADDRESS
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:addressLine2:
value: ''
is_empty: true
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:issuingState:
value: WA
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
drivers_license-General:expirationDate:
value: 08/12/2020
is_empty: false
alias_used: null
source_filename: DRIVING-LICENSE.pdf
confidence: 1
form_config_pk: 216696
tables: []
attribute_data: null
book_is_complete: true
message: OK
'400':
description: Client Errors
content:
application/json:
examples:
Book not found:
value:
status: 400
code: 1401
response: null
message: Book not found
meta:
status: 400
msg: Book not found
code: 1401
Missing Required Parameters:
value:
status: 400
code: 1103
response: null
message: Required pk or book uuid
meta:
status: 400
msg: Required pk or book uuid
code: 1103
No Permission:
value:
status: 400
code: 2102
response: null
message: No permission to access this book
meta:
status: 400
msg: No permission to access this book
code: 2102
schema:
$ref: '#/paths/~1v1~1form/get/responses/400/content/application~1json/schema'
/v2/book/{book_uuid}/paystub:
get:
summary: Book pay stub data
operationId: book-paystub-data
description: 'Retrieve pay stub data for a given <<glossary:Book>>.
---
A detailed description of the response can be found on the [pay stub](https://docs.ocrolus.com/docs/pay-stub) data type definition.'
tags:
- Capture
parameters:
- name: book_uuid
in: path
required: true
description: The unique identifier of a <<glossary:Book>> that contains the pay stub data.
example: 95573c48-93da-472d-ac86-c7e9b58bd53d
schema:
type: string
x-readme:
samples-languages:
- curl
- python
explorer-enabled: false
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
status:
type: integer
description: A numerical code that indicates the status of the request.
example: 200
message:
type: string
description: A textual description that indicates details about this response's status.
example: OK
response:
type: object
description: An object received from the server that potentially contains data.
properties:
uuid:
type: string
example: ce3585b5-44a0-4273-8ca9-c885a353bd87
description: Universally unique identifier (UUID) for the pay stub.
book_uuid:
type: string
description: Universally unique identifier (UUID) for the <<glossary:Book>>.
example: 95573c48-93da-472d-ac86-c7e9b58bd53d
doc_uuid:
type: string
description: Universally unique identifier (UUID) for the <<glossary:Document>>.
example: 32765c32-1a15-477a-8a2d-fe8cbe89ac9c
status:
type: string
description: Verification status of the pay stub <<glossary:Document>>.
example: COMPLETED
doc_page_numbers:
type: array
description: An array of numbers that indicate the number of pages in each Document uploaded to the <<glossary:Book>>.
items:
type: integer
rejection_reason:
type: string
description: An optional attribute that briefly explains why a Document was rejected.
example: null
uploaded_image_bucket_uuid:
type: string
description: Universally unique identifier (UUID) for the image bucket.
example: null
net_pay:
type: object
description: The net pay recorded in the pay stub.
properties:
distribution_details:
type: array
description: Details related to the distribution of the net pay.
items:
type: object
properties:
description:
type: string
description: A description related to the net pay.
example: FEDERAL CREDIT UNION CHECKING 3328
bank_name:
type: string
description: The bank name recorded in the net pay.
example: FEDERAL CREDIT UNION
account_number:
type: string
description: The account number recorded in the net pay.
example: '3328'
bank_account_type:
type: string
description: The bank account type recorded in the net pay.
example: CHECKING
current_pay:
type: object
description: The current pay amount recorded in the net pay.
properties:
amount:
type: string
description: The the numerical value of the current pay.
example: '863.60'
currency:
type: string
description: The currency that the current pay was delivered in.
example: USD
totals:
type: object
description: Totals recorded in the pay stub.
properties:
description:
type: string
description: A description realted to the total.
example: NET PAY
canonical_description:
type: string
description: A canonical description realted to the total.
example: null
current_pay:
type: object
description: The current pay amount recorded in the net pay.
properties:
amount:
type: string
description: The the numerical value of the current pay.
example: '863.60'
currency:
type: string
description: The currency that the current pay was delivered in.
example: USD
ytd_pay:
type: object
description: The year to date pay amount recorded in the net pay.
properties:
amount:
type: string
description: The the numerical value of the year to date pay.
example: '8952.65'
currency:
type: string
description: The currency that the year to date pay was delivered in.
example: USD
earnings:
type: object
description: Earnings recorded in the pay stub.
properties:
subtotals:
type: array
description: Subtotals related to the earnings.
items:
type: object
properties:
description:
type: string
description: A description of a subtotal.
example: ANNUAL BONUS
canonical_description:
type: string
description: A canonical description of a subtotal.
example: BONUS
current_pay:
type: object
description: The current pay amount recorded in the subtotal.
properties:
amount:
type: string
description: The the numerical value of the current pay.
example: '863.60'
currency:
type: string
description: The currency that the current pay was delivered in.
ytd_pay:
type: object
description: The year to date pay amount recorded in the subtotal.
properties:
amount:
type: string
description: The the numerical value of the year to date pay.
example: '8952.65'
currency:
type: string
description: The currency that the year to date pay was delivered in.
example: USD
current_hours:
type: string
description: The current hours recorded related to the subtotal.
example: null
current_rate:
type: string
description: The current rate recorded related to the subtotal.
example: null
totals:
type: array
description: Totals related to the earnings.
items:
type: object
properties:
description:
type: string
example: GROSS PAY
canonical_description:
type: string
description: A canonical description of a total.
example: BONUS
current_pay:
type: object
description: The current pay amount recorded in the total.
properties:
amount:
type: string
description: The the numerical value of the current pay.
example: '863.60'
currency:
type: string
description: The currency that the current pay was delivered in.
ytd_pay:
type: object
description: The year to date pay amount recorded in the total.
properties:
amount:
type: string
description: The the numerical value of the year to date pay.
example: '8952.65'
currency:
type: string
description: The currency that the year to date pay was delivered in.
example: USD
current_hours:
type: string
description: The current hours recorded related to the total.
example: null
deductions:
type: object
description: Deductions recorded in the paystub.
properties:
subtotals:
type: array
description: Subtotals related to the deductions.
items:
type: object
properties:
description:
type: string
description: A description of a subtotal.
example: STATE TAX
canonical_description:
type: string
description: A canonical description of a subtotal.
example: STATE TAX
current_pay:
type: object
description: The current pay amount recorded in the total.
properties:
amount:
type: string
description: The the numerical value of the current pay.
example: '863.60'
currency:
type: string
description: The currency that the current pay was delivered in.
ytd_pay:
type: object
description: The year to date pay amount recorded in the subtotal.
properties:
amount:
type: string
description: The the numerical value of the year to date pay.
example: '8952.65'
currency:
type: string
description: The currency that the year to date pay was delivered in.
example: USD
totals:
type: array
description: Totals related to the deductions.
items:
type: object
properties:
description:
type: string
description: A description of a total.
example: STATE TAX
canonical_description:
type: string
description: A canonical description of a total.
example: STATE TAX
current_pay:
type: object
description: The current pay amount recorded in the total.
properties:
amount:
type: string
description: The the numerical value of the current pay.
example: '863.60'
currency:
type: string
description: The currency that the current pay was delivered in.
ytd_pay:
type: object
description: The year to date pay amount recorded in the total.
properties:
amount:
type: string
description: The the numerical value of the year to date pay.
example: '8952.65'
currency:
type: string
description: The currency that the year to date pay was delivered in.
example: USD
# --- truncated at 32 KB (192 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ocrolus/refs/heads/main/openapi/ocrolus-capture-api-openapi.yml