Upload a document

curl --request POST \
  --url https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --form file='@example-file' \
  --form 'document_request_id=<string>' \
  --form 'period=<string>'

import requests

url = "https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "document_request_id": "<string>",
    "period": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('document_request_id', '<string>');
form.append('period', '<string>');

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};

options.body = form;

fetch('https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "doc_01K5X3R2D7",
  "referral_id": "<string>",
  "type": "bank_statement",
  "filename": "<string>",
  "status": "received",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "document",
  "document_request_id": "<string>",
  "period": "<string>",
  "source": "partner_api"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

Documents

Upload a document

Uploads a document you already hold, such as bank statements from your own ledger or a confidential information memorandum from a data room. If the document has to come from the borrower, you do not need this endpoint: the referral’s todos gives you a hosted upload page to show them instead.

Files can be up to 25 MB, in PDF, PNG, JPG or CSV. O.J. reads the document in the background, and matches update once the figures have been extracted.

POST

referrals

{referral_id}

documents

Upload a document

curl --request POST \
  --url https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --form file='@example-file' \
  --form 'document_request_id=<string>' \
  --form 'period=<string>'

import requests

url = "https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "document_request_id": "<string>",
    "period": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('document_request_id', '<string>');
form.append('period', '<string>');

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', Authorization: 'Bearer <token>'}
};

options.body = form;

fetch('https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.meet-oj.com/partner/v0/referrals/{referral_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_request_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"period\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "doc_01K5X3R2D7",
  "referral_id": "<string>",
  "type": "bank_statement",
  "filename": "<string>",
  "status": "received",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "document",
  "document_request_id": "<string>",
  "period": "<string>",
  "source": "partner_api"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

{
  "type": "https://api.meet-oj.com/problems/duplicate-external-id",
  "title": "Referral already exists",
  "status": 409,
  "code": "invalid_request",
  "request_id": "req_01K5X4A9M2",
  "detail": "A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2.",
  "instance": "/partner/v0/referrals",
  "param": "<string>"
}

Authorizations

Authorization

string

header

required

One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token.

Headers

Idempotency-Key

string

required

IETF Idempotency-Key semantics (draft-ietf-httpapi-idempotency-key-header). Send a fresh unique value (a UUID) with every new request. A retry with the same key and the same payload returns the original response with the header Idempotent-Replayed: true. The same key with a different payload is rejected with 422 and code idempotency_key_reused. Keys are kept for 24 hours.

Maximum string length: 255

Path Parameters

referral_id

string

required

Example:

"ref_01K5X3K7Q2"

Body

multipart/form-data

file

required

type

enum<string>

required

The kinds of documents O.J. can request or accept. cim is a confidential information memorandum, the summary document a business broker prepares for a sale. quality_of_earnings is an accountant's review of reported earnings, required by the SBA for acquisitions of $3M or more. funding_account_auth is the funding account verified through Plaid; voided_check is the fallback when the bank can't be verified.

Available options:

bank_statement,

processing_statement,

voided_check,

funding_account_auth,

tax_return,

profit_and_loss,

balance_sheet,

ar_aging,

ap_aging,

debt_schedule,

business_license,

government_id,

lease,

ownership_document,

cim,

purchase_agreement,

quality_of_earnings,

other

document_request_id

string

Optional. Ties the upload to an open request.

period

string

For statements — the month covered.

Pattern: ^[0-9]{4}-[0-9]{2}$

Response

Document received

A file attached to a referral. status starts at received, becomes processing while O.J. extracts the figures from it, and ends at extracted (or rejected if the file could not be read or was the wrong document). source records who supplied it.

string

required

Example:

"doc_01K5X3R2D7"

referral_id

string

required

type

enum<string>

required

Available options:

bank_statement,

processing_statement,

voided_check,

funding_account_auth,

tax_return,

profit_and_loss,

balance_sheet,

ar_aging,

ap_aging,

debt_schedule,

business_license,

government_id,

lease,

ownership_document,

cim,

purchase_agreement,

quality_of_earnings,

other

filename

string

required

status

enum<string>

required

Available options:

received,

processing,

extracted,

rejected

created_at

string<date-time>

required

object

string

Allowed value: "document"

document_request_id

string

period

string

source

enum<string>

Available options:

partner_api,

partner_upload,

borrower_upload,

bank_connection,

email