Book Queries
Book information
This API retrieves the details of a <glossary:Book>, including uploaded <glossary:Document>s, bank account information, and transaction periods.
get/v1/book/info
Request
- Base URLhttps://api.ocrolus.com
- URLhttps://api.ocrolus.com/v1/book/info
- AuthOAuth 2Client credentialsToken URL: https://auth.ocrolus.com/oauth/token
Query parameters
book_uuidstring uuid
The unique identifier of the <glossary:Book> whose information you want to retrieve. Mutually exclusive with book_pk.
pkstring
Unique primary key (pk) of the <glossary:Book> whose information you want to retrieve. Mutually exclusive with book_uuid.
Response
Success
Example response
{
"status": 200,
"response": {
"name": "Sample bank statement",
"created": "2023-03-03T04:36:31Z",
"created_ts": "2023-03-03T04:36:31Z",
"pk": 133771,
"owner_email": "email@address.com",
"is_public": true,
"book_uuid": "19aab921-25a5-4beb-a59e-ac72320061d6",
"id": 30219565,
"xid": "123ABC",
"book_type": "DEFAULT",
"is_shared_or_public_book": true,
"docs": [
{
"pk": 51542103,
"status": "REJECTED",
"name": "Ocrolus Sample PDF",
"pages": 4,
"md5": "716a9e2119b197fc8fed9e2ca3e56cae",
"image_group_pk": 10423247,
"mixed_uploaded_doc_pk": 10423257,
"document_class": "COMPLETE",
"rejection_reason": "INVALID DOCUMENT"
}
],
"mixed_docs": [
{
"pk": 51542103,
"status": "REJECTED",
"name": "Ocrolus Sample PDF",
"pages": 4,
"md5": "716a9e2119b197fc8fed9e2ca3e56cae",
"image_group_pk": 10423247,
"rejection_reason": "INVALID DOCUMENT",
"document_class": "COMPLETE"
}
],
"bank_accounts": {
"{bank_account_pk}": {
"pk": 12942296,
"id": 12942296,
"book_pk": 28741420,
"name": "488083738759 CHASE CHECKING",
"bank_name": "CHASE",
"activity_info": {
"active": [
{
"start": {
"year": 2022,
"month": 9,
"day": 10
},
"end": {
"year": 2022,
"month": 9,
"day": 10
}
}
],
"missing": [
{
"start": {
"year": 2022,
"month": 9,
"day": 10
},
"end": {
"year": 2022,
"month": 9,
"day": 10
}
}
]
},
"account_type": "CHECKING",
"account_holder": "JILL SMITH",
"holder_zip": "11215",
"holder_country": "US",
"holder_state": "NY",
"holder_city": "New York",
"holder_address_1": "74 Prospect Park",
"holder_address_2": "West Park Slope",
"account_category": "PERSONAL ACCOUNT",
"account_source": "STANDARD_STATEMENT",
"periods": [
{
"pk": 37445192,
"uuid": "c283613c-d20a-4aac-b8b3-5dfd608ba111",
"bank_account_pk": 12942296,
"begin_date": "09/10/2020",
"end_date": "09/10/2022",
"begin_balance": "2935.81",
"end_balance": "3956.07",
"primary_recon_error_reason": "File Tampering Detected",
"secondary_recon_error_reason": "Tampering on pages 1, 3, 4, and 5",
"absolute_recon_error": "0.0",
"uploaded_doc_pk": 50867399
}
],
"account_holders": [
"JILL'S COFFEE"
],
"wire_routing_number": "021000089",
"direct_dep_routing_number": "021000089"
}
},
"custom_filters": {
"{filter_pk}": {
"pk": 101,
"id": 101,
"created_ts": "2022-06-27T13:41:34Z",
"filter_name": "my_filter",
"org_info_pk": 4005,
"is_public": true
}
},
"status_tags": {
"{tag_pk}": {
"pk": 2386480,
"id": 2386480,
"created_ts": "2022-06-28T14:15:18Z",
"tag_name": "rev_exclude",
"color": "navy",
"is_status_tag": true,
"org_info_pk": 4005
}
},
"book_class": "COMPLETE"
},
"message": "OK"
}Changes
No recorded changes to this operation across all 1 revision of this API.