Skip to main content
POST
Run a match check

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

Body

application/json

The body for a match check, which screens a business without identifying it. Instead of a name and EIN you send a reference — your own merchant id, or a hash of it — that O.J. echoes back and never tries to resolve. Add the ledger months and, if you have them, the state and industry. O.J. learns who the business is only if you refer it with consent.

reference
string
required

Opaque partner-side id or hash. Echoed back; never resolved by O.J.

Maximum string length: 128
context
object
required

Everything you already know about the business, in whatever combination you have. The more you send, the more of the matching O.J. can do immediately, before any documents arrive. Figures you report are later checked against the borrower's bank data; if they disagree by more than a small tolerance, an O.J. reviewer looks at the file before it goes to lenders.

business
object

Optional, identity-free attributes that affect which lenders match.

contacts
object[]
requested_amount
integer

A dollar amount expressed in whole US cents, so $85,000.00 is 8500000. Cents avoid rounding errors that decimals cause in some languages.

product_hint
enum<string>

A kind of financing. When you pass one as product_hint, O.J. still checks every product it can place, but lists the hinted one first. revenue_based_financing is repaid as a share of sales; term_loan is a fixed amount repaid over a fixed period; business_line_of_credit can be drawn and repaid repeatedly; sba_7a is a government-guaranteed bank loan; invoice_factoring advances money against unpaid invoices; asset_based_lending is secured by inventory or equipment; hard_money_lending is secured by real estate.

Available options:
revenue_based_financing,
term_loan,
business_line_of_credit,
sba_7a,
invoice_factoring,
asset_based_lending,
hard_money_lending

Response

Lenders the business would match

reference
string
required
matches
object[]
required
checked_at
string<date-time>
required