Ocrolus

https://docs.ocrolus.com/
Admin
Ocrolus is a document processing and analysis platform that uses AI and OCR to extract, classify,...
Tokens:1,211,707
Snippets:15,123
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Open a Book Example

Source: https://docs.ocrolus.com/docs/dashboard-urls-and-navigations

An example of a URL to open a specific Book in the Dashboard using its book_uuid.

```json
https://dashboard.ocrolus.com/books/3fba0d5d-375f-41b2-b536-d5f661e1f03e
```

--------------------------------

### Date Part Range Example

Source: https://docs.ocrolus.com/docs/bank-account

Shows the JSON structure for a date range, including start and end dates. This is used to define periods of activity or missing data.

```JSON Example
{
  "start": { "year": 2018, "day":  1, "month": 6 },
    "end": { "year": 2018, "day": 30, "month": 6 }
}
```

--------------------------------

### Upload Finicity Data with Aggregate Source

Source: https://docs.ocrolus.com/reference/upload-json

This example shows how to upload Finicity JSON files, specifying `FINICITY` as the `aggregate_source`. This includes uploading accounts, transactions, customers, and institutions data. The `pk` parameter is required to identify the target Book.

```shell
curl --request POST "https://api.ocrolus.com/v1/book/upload/json?aggregate_source=FINICITY"
  --header "Accept: application/json"
  --header "Authorization: Bearer <BEARER_TOKEN>"
  --form "pk=1234567"
  --form "accounts=@/path/to/accounts.json"
  --form "transactions=@/path/to/transactions.json"
  --form "customers=@/path/to/customers.json"
  --form "institutions=@/path/to/institutions.json"
```

--------------------------------

### Get Form Data - JSON Response Example

Source: https://docs.ocrolus.com/docs/getting-started-with-smb-lending

This is an example of a successful JSON response when retrieving form data. It includes book details and a list of forms with their respective raw fields and captured values.

```json
{
    "status": 200,
    "response": {
        "pk": {{book_pk}},
        "uuid": "{{book_uuid}}",
        "name": "{{book_name}}",
        "created": "2023-11-17T20:11:41Z",
        "created_ts": "2023-11-17T20:11:41Z",
        "verified_pages_count": 13,
        "book_status": "ACTIVE",
        "id": {{book_id}},
        "forms": [
            {
                "pk": {{form_pk}},
                "uuid": "{{form_uuid}}",
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "form_type": "W2",
                "raw_fields": {
                    "box9": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "year": {
                        "value": "2018",
                        "is_empty": false,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12aCode": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12bCode": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12cCode": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12dcode": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box14Other": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12aAmount": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12bAmount": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12cAmount": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "box12dAmount": {
                        "value": "",
                        "is_empty": true,
                        "alias_used": null,
                        "source_filename": "{{form_name}}.pdf",
                        "confidence": 0.0
                    },
                    "employeeName": {
                        "value": "DAVID P BECON",

```

--------------------------------

### Example API Call with JWT Token

Source: https://docs.ocrolus.com/reference/grant-authentication-token

Demonstrates how to use a previously obtained JWT token to make a request to the /v1/books endpoint.

```shell
curl \
  --url "https://api.ocrolus.com/v1/books" \
  --oauth2-bearer "eyJhbGciOiJ...2hUye_4CpIvQ"
```

--------------------------------

### Get Document Fraud Signals (Python)

Source: https://docs.ocrolus.com/reference/doc-fraud-signals

This Python example demonstrates how to make a GET request to the Document-Level Fraud Signals endpoint. Ensure you replace `uploaded_doc_uuid` with a valid document identifier and manage your API key for authentication.

```python
import requests

url = "https://api.ocrolus.com/v2/detect/uploaded_doc/{uploaded_doc_uuid}/signals"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Create a Book with curl

Source: https://docs.ocrolus.com/docs/getting-started-with-smb-lending

Use this `curl` command to create a new Book for storing documents. Ensure you replace `{{token}}` with your actual authentication token and `{{book name}}` with your desired book name. The `book_class` parameter can be either `INSTANT` or `COMPLETE`.

```curl
curl --location 'https://api.ocrolus.com/v1/book/add' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{ 
   "name":"{{book name}}",
   "is_public": true
}'
```

--------------------------------

### Get Specific Bank Statement Transactions - JSON Response Example

Source: https://docs.ocrolus.com/docs/classify-first

This is an example of the JSON response you will receive when successfully fetching transaction data. It includes details for each transaction such as page index, bank account information, amount, date, and description.

```json
{
    "status": 200,
    "response": {
        "txns": [
            {
                "page_idx": 0,
                "bank_account_pk": {{bank_account_pk}},
                "amount": "300.00",
                "bbox": [
                    146,
                    2804,
                    2208,
                    2854
                ],
                "txn_date": "12/11/2020",
                "page_doc_pk": {{page_doc_pk}},
                "pk": {{transaction_pk}},
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "description": "BKOFAMERICA ATM 12/11 # 000003710 DEPOSIT 1608 AVE M BROOKLYN NY",
                "txn_pk_duplicate_of": null,
                "comment": "",
                "explanation": "",
                "has_probable_transfers": false,
                "tags": {},
                "period_pk": {{period_pk}}
            },
            {
                "page_idx": 0,
                "bank_account_pk": {{bank_account_pk}},
                "amount": "-1074.69",
                "bbox": [
                    146,
                    2971,
                    2208,
                    3017
                ],
                "txn_date": "12/11/2020",
                "page_doc_pk": {{page_doc_pk}},
                "pk": {{transaction_pk}},
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "description": "CHECKCARD 1211 TUNA MED FOOD BROOKLYN NY [...",
                "txn_pk_duplicate_of": null,
                "comment": "",
                "explanation": "",
                "has_probable_transfers": false,
                "tags": {},
                "period_pk": {{period_pk}}
            },
            {
                "page_idx": 0,
                "bank_account_pk": {{bank_account_pk}},
                "amount": "-336.00",
                "bbox": [
                    146,
                    2892,
                    2208,
                    2929
                ],
                "txn_date": "12/11/2020",
                "page_doc_pk": {{page_doc_pk}},
                "pk": {{transaction_pk}},
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "description": "PAYROLL DES: PAYROLL ID: 18171908 INDN: JILL S COFFEE CO [... ]",
                "txn_pk_duplicate_of": null,
                "comment": "",
                "explanation": "",
                "has_probable_transfers": false,
                "tags": {},
                "period_pk": {{period_pk}}
            },
            {
                "page_idx": 0,
                "bank_account_pk": {{bank_account_pk}},
                "amount": "-674.00",
                "bbox": [
                    146,
                    3308,
                    2204,
                    3346
                ],
                "txn_date": "12/13/2020",
                "page_doc_pk": {{page_doc_pk}},
                "pk": {{transaction_pk}},
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "description": "CHECKCARD 1213 LIBERTY PAPER SUPPLIES # 633 COURT ST [... ]",
                "txn_pk_duplicate_of": null,
                "comment": "",
                "explanation": "",
                "has_probable_transfers": false,
                "tags": {},
                "period_pk": {{period_pk}}
            },
            {
                "page_idx": 0,
                "bank_account_pk": {{bank_account_pk}},
                "amount": "-1076.88",
                "bbox": [
                    146,
                    3225,
                    2208,
                    3267
                ],
                "txn_date": "12/13/2020",
                "page_doc_pk": {{page_doc_pk}},
                "pk": {{transaction_pk}},
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "description": "PAYROLL DES: PAYROLL ID: 13694786 INDN: JILL S COFFEE CO [... ]",
                "txn_pk_duplicate_of": null,
                "comment": "",
                "explanation": "",
                "has_probable_transfers": false,
                "tags": {},
                "period_pk": {{period_pk}}
            },
            {
                "page_idx": 0,
                "bank_account_pk": {{bank_account_pk}},
                "amount": "500.00",
                "bbox": [
                    146,
                    3050,
                    2208,
                    3100
                ],
                "txn_date": "12/13/2020",
                "page_doc_pk": {{page_doc_pk}},
                "pk": {{transaction_pk}},
                "uploaded_doc_pk": {{uploaded_doc_pk}},
                "description": "",
                "txn_pk_duplicate_of": null,
                "comment": "",
                "explanation": "",
                "has_probable_transfers": false,
                "tags": {},
                "period_pk": {{period_pk}}
            }
        ]
    }
}
```

--------------------------------

### Retrieve Form Data (Python)

Source: https://docs.ocrolus.com/reference/form-field-data

Example of how to retrieve form data using Python. This snippet demonstrates a basic GET request to the API.

```python
import requests

url = "https://api.ocrolus.com/v1/form"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Create Book Request (Python)

Source: https://docs.ocrolus.com/reference/create-a-book

This Python example demonstrates how to create a Book using the requests library. It includes setting the necessary headers and sending the book details in the JSON payload. The 'name' parameter is required.

```python
import requests

url = "https://api.ocrolus.com/v1/book/add"

payload = {
    "name": "My New Book",
    "book_class": "COMPLETE",
    "book_type": "DEFAULT",
    "is_public": True,
    "xid": "some-external-id"
}
headers = {
    'accept': 'application/json',
    'content-type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

--------------------------------

### Upload using Go http

Source: https://docs.ocrolus.com/reference/multipartform-data-payloads

This Go code sample demonstrates how to use the standard `http` and `multipart` packages to upload a file.

```APIDOC
## POST /book/upload

### Description
Uploads a book file using multipart form data.

### Method
POST

### Endpoint
https://api.ocrolus.com/v1/book/upload

### Parameters
#### Request Body
- **pk** (string) - Required - The primary key of the book.
- **upload** (file) - Required - The file to upload (e.g., a PDF).

### Request Example
```go
package main

import (
    "io"
    "log"
    "mime/multipart"
    "net/http"
    "os"
    "strconv"
)

func main() {
    req, err := newUploadRequest(123456, "path/to/bank-statement.pdf")
    if err != nil {
        log.Fatal(err)
    }
    req.SetBasicAuth("api-key", "api-secret")

    client := &http.Client{}

    res, err := client.Do(req)
    if err != nil {
        log.Fatal(err)
    }
    defer res.Body.Close()

    _, err = io.Copy(os.Stdout, res.Body)
    if err != nil {
        log.Fatal(err)
    }
}

func newUploadRequest(bookPK int64, filePath string) (*http.Request, error) {
    body, contentType, err := newUploadBody(bookPK, filePath)
    if err != nil {
        return nil, err
    }

    req, err := http.NewRequest(http.MethodPost, "https://api.ocrolus.com/v1/book/upload", body)
    if err != nil {
        return nil, err
    }
    req.Header.Set("Content-Type", contentType)

    return req, nil
}

func newUploadBody(bookPK int64, filePath string) (io.Reader, string, error) {
    bodyReader, bodyWriter := io.Pipe()
    uploadWriter := multipart.NewWriter(bodyWriter)

    file, err := os.Open(filePath)
    if err != nil {
        return nil, "", err
    }

    go func() {
        defer bodyWriter.Close()
        defer file.Close()

        err = uploadWriter.WriteField("pk", strconv.FormatInt(bookPK, 10))
        if err != nil {
            bodyWriter.CloseWithError(err)
            return
        }

        part, err := uploadWriter.CreateFormFile("upload", file.Name())
        if err != nil {
            bodyWriter.CloseWithError(err)
            return
        }

        _, err = io.Copy(part, file)
        if err != nil {
            bodyWriter.CloseWithError(err)
            return
        }

        err = uploadWriter.Close()
        if err != nil {
            bodyWriter.CloseWithError(err)
            return
        }
    }()

    return bodyReader, uploadWriter.FormDataContentType(), nil
}
```

### Response
#### Success Response (200)
- **string** - The response content from the server.
```

--------------------------------

### Get Loan Details from Book

Source: https://docs.ocrolus.com/reference/loan-from-book

This API retrieves the Encompass Loan GUID and related loan metadata using the Ocrolus Book UUID.

```APIDOC
## GET https://api.ocrolus.com/v2/los-connect/book/{book_uuid}/loans

### Description
Retrieves the Encompass Loan GUID and related loan metadata using the Ocrolus Book UUID. It enables seamless mapping between an Ocrolus Book and its corresponding Encompass Loan, supporting accurate LOS integration, tracking, and synchronization between Ocrolus and Encompass systems.

### Method
GET

### Endpoint
https://api.ocrolus.com/v2/los-connect/book/{book_uuid}/loans

### Parameters
#### Path Parameters
- **book_uuid** (uuid) - Required - The unique identifier of the Book from which you want to retrieve loan details. Mutually exclusive with `book_pk`.

### Responses
#### Success Response (200)
- **Success** - Details about the successful response.

#### Error Responses
- **400** - Client Errors
- **403** - Forbidden
- **404** - NOT FOUND
- **500** - INTERNAL SERVER ERROR
```

--------------------------------

### Retrieve All Books (Python)

Source: https://docs.ocrolus.com/reference/book-list

This Python script demonstrates how to make a GET request to the /v1/books endpoint using the requests library. Ensure you have the library installed and your OAuth2 token is correctly configured.

```python
import requests

url = "https://api.ocrolus.com/v1/books"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_OAUTH2_TOKEN" 
}

response = requests.get(url, headers=headers)

print(response.status_code)
print(response.json())
```

--------------------------------

### Create a Book with INSTANT_CLASSIFY_ISO_CAPTURE

Source: https://docs.ocrolus.com/docs/iso

Use this curl command to create a new Book with the 'INSTANT_CLASSIFY_ISO_CAPTURE' class, which is suitable for ISO applications. Ensure your authentication token is correctly set.

```curl
curl --location 'https://api.ocrolus.com/v1/book/add' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{ 
   "name":"{{book name}}",
   "is_public": true,
   "book_class": "INSTANT_CLASSIFY_ISO_CAPTURE"
}'
```
Tokens:
Raw